Export (0) Print
Expand All
Expand Minimize

SetMonitorColorTemperature function

Sets a monitor's color temperature.

Syntax


BOOL SetMonitorColorTemperature(
  _In_  HANDLE hMonitor,
  _In_  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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

HighLevelMonitorConfigurationAPI.h

Library

Dxva2.lib

DLL

Dxva2.dll

See also

Monitor Configuration Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft