###############################################################################
#                                                                             #
#  Copyright © 1989-1991 by Artificial Horizons®, Inc.  All rights reserved.  #
#                                                                             #
#      This material  constitutes  the trade  secrets  and confidential,      #
#      proprietary information of Bruce Factor and Curtis Priem,  and is      #
#      under license  to Artificial Horizons, Inc.   The material is not      #
#      to be disclosed,  reproduced,  copied,  or used in any manner not      #
#      permitted under license from Artificial Horizons, Inc.   For more      #
#      information email "ahi-interest@ahi.com".                              #
#                                                                             #
###############################################################################

PALETTE(3GC)          AVIATOR GRAPHICS INTERFACE CLASSES           PALETTE(3GC)



NAME
        FB_CLASS__PALETTE - color palette class

SYNOPSIS
        #include <agi.h>
        register Fbuffer fbp;

        fbstart(fbp, FB_CLASS__PALETTE)  {
        }  fbend(fbp);

DESCRIPTION
        The class FB_CLASS__PALETTE is used for operating on the color palette
        or color lookup table in the RAMDAC.

MEMBERS
        The following public members can be accessed by using routines
        fbput(3G) and fbget(3G).  These 32 bit numbers can be signed integer,
        signed 16.16 fixed point, or IEEE single precision floating point
        format.

        FB_MEMBER__INDEX__INTEGER
        FB_MEMBER__INDEX__FIXED
        FB_MEMBER__INDEX__FLOAT
                INDEX is the index into the color palette.  It must be a value
                from 0 to 255.  INDEX corresponds to the index value in the
                frame buffer for a given pixel.
        FB_MEMBER__RED__INTEGER
        FB_MEMBER__RED__FIXED
        FB_MEMBER__RED__FLOAT
                RED is the intensity of the red component for the current
                index in the color palette.  It must be a value from 0 (black)
                to 255 (red).
        FB_MEMBER__GREEN__INTEGER
        FB_MEMBER__GREEN__FIXED
        FB_MEMBER__GREEN__FLOAT
                GREEN is the intensity of the green component for the current
                index in the color palette.  It must be a value from 0 (black)
                to 255 (green).
        FB_MEMBER__BLUE__INTEGER
        FB_MEMBER__BLUE__FIXED
        FB_MEMBER__BLUE__FLOAT
                BLUE is the intensity of the blue component for the current
                index in the color palette.  It must be a value from 0 (black)
                to 255 (blue).

FUNCTIONS
        The following public functions can be called by using the fbcall(3G)
        routine:

        FB_FUNCTION__STORE
                STORE stores the current INDEX into the frame buffer's palette.
        FB_FUNCTION__STORE_INCREMENT
                STORE_INCREMENT stores the current color (RED, GREEN, BLUE)
                into the frame buffer's palette at the location pointed to by
                INDEX.  INDEX is then incremented.
        FB_FUNCTION__LOAD_INCREMENT
                LOAD_INCREMENT loads the color in the frame buffer's palette
                at the location pointed to by INDEX into the current color
                (RED, GREEN, BLUE).  INDEX is then incremented.

SEE ALSO
        fbcall(3G), fbend(3G), fbget(3G), fbput(3G), fbstart(3G)

PERFORMANCE
        INTEGER is the fastest format.



AGI Release 1.8         Last change: 25 December 1991