In file mydocsrc/mvl_macv.h:

class mvl_clut

An auxiliary class used for manipulating the Color Lookup Table (CLUT) of the video display

Public

A: Constructors, destructors and status.
mvl_clut (IML_UBYTE DBits, IML_USINT CSize)
A simple constructor
mvl_clut (mvl_clut IML_REF Example)
A copy constructor
~mvl_clut ()
The destructor
IML_SINT success (void)
This function checks to see if the memory allocation for the CLUT was successful
B: Public information.
IML_USINT dac_size (void)
Number of bits in the D-to-A converter (that is, resolution of the R, G, & B guns).
IML_USINT max_dac (void)
Maximum Dac Value of 2**dacbits - 1, where '**' denotes exponentiation.
IML_USINT clut_size (void)
Number of entries in the CLUT.
C: Public manipulation and access functions.
mvl_ColorSpec& operator[] (IML_USINT I)
Provides direct access to a CLUT entry
short red (IML_USINT I)
Read the red gun value from a CLUT entry
short green (IML_USINT I)
Read the green gun value from a CLUT entry
short blue (IML_USINT I)
Read the blue gun value from a CLUT entry
void red (IML_USINT I, IML_USINT D)
Write the red gun value to a CLUT entry
void green (IML_USINT I, IML_USINT D)
Write the green gun value to a CLUT entry
void blue (IML_USINT I, IML_USINT D)
Write the blue gun value to a CLUT entry
void set_clut_entry (IML_SINT I, IML_SINT R, IML_SINT G, IML_SINT B)
Write the red, green and blue values to a CLUT entry all at once
void set_clut_entry (IML_SINT I, mvl_ColorSpec & Color)
Write the red, green and blue values to a CLUT entry all at once from an mvl_ColorSpec structure

Documentation

An auxiliary class used for manipulating the Color Lookup Table (CLUT) of the video display. Generally you will grab a copy of the current CLUT by asking the mvl_video_manager object for a copy. Then you can make some changes and load it back into the hardware.
A: Constructors, destructors and status.
There is only one constructor, and one destructor that knows how to.

mvl_clut(IML_UBYTE DBits, IML_USINT CSize)
A simple constructor. The input values are the width of the DAC in bits and the CLUT length (entry count).

mvl_clut(mvl_clut IML_REF Example)
A copy constructor. The input is just a clut for which you want a duplicate. This function creates a new internal table and copies the CLUT entry values from the exemplar.

~mvl_clut()
The destructor. The only required action is to clean up the table if it was allocated.

IML_SINT success(void)
This function checks to see if the memory allocation for the CLUT was successful. It returns TRUE for success, FALSE for failure.

B: Public information.
These values are publicly available but cannot be manipulated directly. They are made accessible for your convenience. These are identical to values contained in the mvl_video_manager class structure.

C: Public manipulation and access functions.
These functions allow the user to read and write DAC entry values. Note that actualy red, green and blue DAC entries are "left justified" in the MAC world (don't ask me why --- I think it's weird) so if you decide to set those values yourself, you are responsible for getting that right. Otherwise it is done for you if you use the access functions here.

mvl_ColorSpec& operator[](IML_USINT I)
Provides direct access to a CLUT entry. See the description of mvl_ColorSpec for details of the contents of an entry.

void set_clut_entry(IML_SINT I, IML_SINT R, IML_SINT G, IML_SINT B)
Write the red, green and blue values to a CLUT entry all at once. The call assumes that the R,G, & B values are NOT left justified.

void set_clut_entry(IML_SINT I, mvl_ColorSpec & Color)
Write the red, green and blue values to a CLUT entry all at once from an mvl_ColorSpec structure. The call assumes that the R,G, & B values are NOT left justified.


This class has no child classes.

alphabetic index hierarchy of classes


generated by doc++