Monitor SetMonitorRedGreenOrBlueGain Function 

  • Article
 
Monitor Configuration API
Previous Next

SetMonitorRedGreenOrBlueGain Function

Sets a monitor's red, green, or blue gain value.

Syntax

  BOOL SetMonitorRedGreenOrBlueGain(
  HANDLE
    hMonitor,

    MC_GAIN_TYPE
    gtGainType,

    DWORD
    dwNewGain

  );

Parameters

hMonitor

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

gtGainType

[in]  A member of the MC_GAIN_TYPE enumeration, specifying whether to set the red, green, or blue gain.

dwNewGain

[in]  Red, green, or blue gain value. To get the monitor's minimum and maximum gain values, call GetMonitorRedGreenOrBlueGain.

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

Gain settings are generally used to adjust the monitor's white point.

If this function is supported, the GetMonitorCapabilities function returns the MC_CAPS_RED_GREEN_BLUE_GAIN flag.

This function takes about 50 milliseconds to return.

Changing the gain settings can change the color temperature. To get the new color temperature, call GetMonitorColorTemperature.

The gain settings are continuous monitor settings. For more information, see Using the High-Level Monitor Configuration Functions.

Requirements

Client: Requires Windows Vista.

Header: Include HighLevelMonitorConfigurationAPI.h.

Library: Use dxva2.lib.

See Also

Previous Next