Export (0) Print
Expand All
Expand Minimize

GetMonitorRedGreenOrBlueGain function

Applies to: desktop apps only

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

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 retrieve the red, green, or blue gain value.

pdwMinimumGain [out]

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

pdwCurrentGain [out]

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

pdwMaximumGain [out]

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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

HighLevelMonitorConfigurationAPI.h

Library

Dxva2.lib

DLL

Dxva2.dll

See also

Monitor Configuration Functions
GetMonitorRedGreenOrBlueDrive

 

 

Send comments about this topic to Microsoft

Build date: 2/3/2012

Community Additions

ADD
Show:
© 2014 Microsoft