Function Name: Set Color Model

Definition

Sets the color model that will be used to represent all Color Data objects retrieved after this function is called. This function has no effect on Color Data objects that were returned to the user before this function was called. By default (if this function is not called), colors are returned to the user in the format in which the colors were defined in the transmittal from which the colors were extracted. So, if a SEDRIS transmittal contains HSV colors, then by default these colors will be returned to the user as HSV Color objects. If the user calls the SE_SetColorModel() function and sets the color model to SE_RGB_MODEL, then all colors returned after this call would be returned as RGB Color objects.

The color model used for returning Color Data objects can be changed as often as the user desires. After changing color models, if the user wants to return to the 'default' color model (for all transmittals, go back to using the color model that was used by the producer of each transmittal) then call the SE_UseDefaultColorModel() function.

Returns

SE_FAILURE - and the current color model is not changed, if an illegal value is passed into this function (a value that is not within the SE_COLOR_MODEL_ENUM enumeration).

Prototype

Parameters Notes

new_color_model

 the color model to use from now on (or until another
    call is made to either this function or the SE_UseDefaultColorModel()
    function).