VDSetSaturation
The VDSetSaturation function sets the saturation value, which controls color intensity. For example, at high saturation levels, red appears to be red; at low saturation, red appears pink. Valid saturation values range from 0 to 65,535, where 0 is the minimum saturation value and 65,535 specifies maximum saturation.
pascal VideoDigitizerError VDSetSaturation
(VideoDigitizerComponent ci,
unsigned short *saturation);
ci
- Specifies the video digitizer component for the request. Applications obtain this reference from the Component Manager's
OpenComponent function.
saturation
- Contains a pointer to an integer that contains the new saturation value. The video digitizer component attempts to set the saturation value to the value specified by this parameter. The digitizer component returns the new value, so that the application can avoid using unsupported values in future requests.
RESULT CODES
| noErr | 0 | No error |
| digiUnimpErr | -2201 | Function not supported |
| qtParamErr | -2202 | Invalid parameter value |
SEE ALSO
Applications can get the current saturation value by calling the VDGetSaturation function (described in the next section). Applications can obtain the recommended saturation value by calling the VDGetVideoDefaults function (described on page 8-66).
