Monitor SetMonitorColorTemperature Function 

  • Article
 
Monitor Configuration API
Previous Next

SetMonitorColorTemperature Function

Sets a monitor's color temperature.

Syntax

  BOOL SetMonitorColorTemperature(
  HANDLE
    hMonitor,

    MC_COLOR_TEMPERATURE
    ctCurrentColorTemperature

  );

Parameters

hMonitor

[in]  Handle to a physical monitor. To get the monitor handle, call GetPhysicalMonitorsFromHMONITOR or GetPhysicalMonitorsFromIDirect3DDevice9.

ctCurrentColorTemperature

[in]  Color temperature, specified as a member of the MC_COLOR_TEMPERATURE enumeration.

Return Value

If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError.

Remarks

If this function is supported, the GetMonitorCapabilities function returns the MC_CAPS_COLOR_TEMPERATURE flag. The GetMonitorCapabilities function also returns the range of color temperatures that the monitor supports. The ctCurrentColorTemperature parameter must correspond to one of these values.

Changing the color temperature changes the monitor's white point. It can also change the current drive and gain settings. To get the new drive and gain settings, call GetMonitorRedGreenOrBlueDrive and GetMonitorRedGreenOrBlueGain, respectively.

This function takes from 50 to 90 milliseconds to return.

Requirements

Client: Requires Windows Vista.

Header: Include HighLevelMonitorConfigurationAPI.h.

Library: Use dxva2.lib.

See Also

Previous Next