Contents

CMSetProfileByAVID

Sets the profile for the specified monitor, optionally setting video card gamma.

Declaration

CMError CMSetProfileByAVID (
   CMDisplayIDType theID,
   CMProfileRef prof
);

Parameters

  • theAVID:

    A Display Manager ID value. You pass the ID value for the monitor for which to set the profile.

  • prof:

    A profile reference. Before calling CMSetProfileByAVID, set the reference to identify the profile for the monitor specified by theAVID.

Return Value

A CMError value. See Result Codes.

Overview

If you specify a profile that contains the optional profile tag for video card gamma, CMSetProfileByAVID extracts the tag and sets the video card based on the tag data. This is the only ColorSync function that sets video card gamma. The tag constant cmVideoCardGammaTag is described in Video Card Gamma Tags.

When a user sets a display profile using the Monitors & Sound control panel, the system profile is set to the same profile. When you call CMSetProfileByAVID to set a profile for a monitor, you may also wish to make that profile the system profile. If so, you must call CMSetSystemProfile explicitly—calling CMSetProfileByAVID alone has no affect on the system profile.

Note that if the Display Manager supports ColorSync, the CMSetProfileByAVID function calls on the Display Manager to set the profile for the specified display. This is the case if the version of the Display Manager is 2.2.5 or higher (if gestaltDisplayMgrAttr has the gestaltDisplayMgrColorSyncAware bit set).

See Also

Accessing Special Profiles