MUI Autodocs: Coloradjust.mui

Copyright © 1998, Stefan Stuntz




Coloradjust.mui Background

        Coloradjust class creates some gadgets that allow adjusting
        a single color. Depending on the operating system, different
        kinds of gadgets are be used. Kickstart 2.x users might only
        receive an RGB slider triple, Kickstart 3.x users could get
        an additional colorwheel if available. However, the outfit
        of this class is not important for you as a programmer.



Coloradjust.mui Attributes

    Attribute                           Ver ISG Type
    ----------------------------------- --- --- --------------------
    MUIA_Coloradjust_Blue               V4  ISG ULONG
    MUIA_Coloradjust_Green              V4  ISG ULONG
    MUIA_Coloradjust_ModeID             V4  ISG ULONG
    MUIA_Coloradjust_Red                V4  ISG ULONG
    MUIA_Coloradjust_RGB                V4  ISG ULONG *


MUIA_Coloradjust_Blue


    NAME
        MUIA_Coloradjust_Blue -- (V4 ) [ISG], ULONG

    FUNCTION
        Set or get the 32-bit blue component of the adjusted color.
        Values range from 0 (no blue) to $ffffffff (full blue).

    SEE ALSO
        MUIA_Coloradjust_Green, MUIA_Coloradjust_Red,
        MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID


MUIA_Coloradjust_Green


    NAME
        MUIA_Coloradjust_Green -- (V4 ) [ISG], ULONG

    FUNCTION
        Set or get the 32-bit green component of the adjusted color.
        Values range from 0 (no green) to $ffffffff (full green).

    SEE ALSO
        MUIA_Coloradjust_Red, MUIA_Coloradjust_Blue,
        MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID


MUIA_Coloradjust_ModeID


    NAME
        MUIA_Coloradjust_ModeID -- (V4 ) [ISG], ULONG

    FUNCTION
        This attribute tells the coloradjust object for which
        screen mode the color shall be adjusted. The object
        queries the display data base for some mode attributes
        (such as supported number of red/green/blue bits) and
        adjusts its display accordingly, giving the user an
        idea of what colors are supported.

        Omitting this attribute does not affect the functionality
        of a coloradjust object. The user will still be able to
        adjust a color. However, if you know the ModeID, you
        should supply it.

    SEE ALSO
        MUIA_Coloradjust_RGB

    EXAMPLE
        set(cadj,MUIA_Coloradjust_ModeID,GetVPModeID(viewport));


MUIA_Coloradjust_Red


    NAME
        MUIA_Coloradjust_Red -- (V4 ) [ISG], ULONG

    FUNCTION
        Set or get the 32-bit red component of the adjusted color.
        Values range from 0 (no red) to $ffffffff (full red).

    SEE ALSO
        MUIA_Coloradjust_Green, MUIA_Coloradjust_Blue,
        MUIA_Coloradjust_RGB, MUIA_Coloradjust_ModeID


MUIA_Coloradjust_RGB


    NAME
        MUIA_Coloradjust_RGB -- (V4 ) [ISG], ULONG *

    FUNCTION
        Set or get the red/green/blue values all at once.
        You pass in / receive a pointer to three longwords
        containing the 32-bit red, green and blue values.

    EXAMPLE

        ULONG rgb[3] = { 0xa000000,0xdeadbeaf,0x42424242 };
        set(cadj,MUIA_Coloradjust_RGB,rgb);

        ULONG *rgb;
        get(cadj,MUIA_Coloradjust_RGB,&rgb);
        printf("red=%08lx green=%08lx blue=%08lx\n",rgb[0],rgb[1],rgb[2]);

    SEE ALSO
        MUIA_Coloradjust_Green, MUIA_Coloradjust_Blue,
        MUIA_Coloradjust_Red, MUIA_Coloradjust_ModeID





© 1998, Stefan Stuntz [MUI Homepage] [Autodoc Index] [Feedback] Updated: 22-Feb-98