|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE SetColourModel |
|---|
| extern SE_Return_Code | |||
| SE_SetColourModel | |||
| ( | |||
| SE_Colour_Model | new_colour_model | 1 | |
| ); | |||
Sets the colour model that will be used to represent all <Colour Data> instances retrieved after this function is called. This function has no effect on <Colour Data> instances 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 transmittal contains HSV colours, then by default these colours will be returned to the user as <HSV Colour> instances. If the user calls the SE_SetColourModel() function and sets the colour model to SE_COLRMOD_RGB, then all colours returned after this call would be returned as <RGB Colour> instances.
The colour model used for returning <Colour Data> instances 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.
| SE_RETCOD_SUCCESS | and the colour model is set. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if new_colour_model is valid and the call was successful. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_INACTIONABLE_FAILURE | set if new_colour_model is invalid or the call fails for any other reason. |
1 the colour model to use from now on (or until another call is made to either this function or the SE_UseDefaultColourModel() function).
Prev: SE_ResolveTransmittalName.
Next: SE_SetFirstErrorMessage.
Up:Index.
|