GetMonitorRedGreenOrBlueGain function (highlevelmonitorconfigurationapi.h)

Article
02/22/2024

Warning

The physical monitor configuration functions work using the VESA Monitor Control Command Set (MCCS) standard over an I²C interface. Many monitors don't fully implement that standard; so your use of these commands might result in undefined monitor behavior. We don't recommend using these functions for arbitrary monitors without physically validating that they work as intended.

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

Syntax

_BOOL GetMonitorRedGreenOrBlueGain(
  [in]  HANDLE       hMonitor,
  [in]  MC_GAIN_TYPE gtGainType,
  [out] LPDWORD      pdwMinimumGain,
  [out] LPDWORD      pdwCurrentGain,
  [out] LPDWORD      pdwMaximumGain
);

Parameters

[in] hMonitor

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

[in] gtGainType

A member of the MC_GAIN_TYPE enumeration, specifying whether to retrieve the red, green, or blue gain value.

[out] pdwMinimumGain

Receives the minimum red, green, or blue gain value.

[out] pdwCurrentGain

Receives the current red, green, or blue gain value.

[out] pdwMaximumGain

Receives the maximum red, green, or blue gain value.

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 40 milliseconds to return.

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

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	highlevelmonitorconfigurationapi.h
Library	Dxva2.lib
DLL	Dxva2.dll