VDGetSaturation
The VDGetSaturation function returns the current saturation value, which controls color intensity. For example, at high saturation levels red appears to be red, while 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 VDGetSaturation
(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 is to receive the current saturation value. The video digitizer component places the saturation value into the field referred to by this parameter.
DESCRIPTION
The VDGetSaturation function returns the current saturation value.
RESULT CODES
| noErr | 0 | No error |
| digiUnimpErr | -2201 | Function not supported |
SEE ALSO
Your application can set the saturation value by calling the VDSetSaturation function (described in the previous section). To obtain the recommended saturation value, your application can call the VDGetVideoDefaults function (described on page 8-66).
