SE SetColourModel

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE SetColourModel

extern SE_Status_Code
SE_SetColourModel
(
SE_Colour_Model	new_colour_model	(notes)
);

Definition

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

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

Returns

SE_STAT_CODE_SUCCESS and the current colour model of this API is changed to the colour model specified by new_colour_model, if new_colour_model is valid.

SE_STAT_CODE_FAILURE and the current colour model is not changed, if new_colour_model is invalid.

Parameters Notes

new_colour_model

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

SE_STAT_CODE_SUCCESS	and the current colour model of this API is changed to the colour model specified by new_colour_model, if new_colour_model is valid.
SE_STAT_CODE_FAILURE	and the current colour model is not changed, if new_colour_model is invalid.