Edit

Share via

GetMonitorRedGreenOrBlueDrive function (highlevelmonitorconfigurationapi.h)

  • Article

Warning

The physical monitor configuration functions work using the VESA Monitor Control Command Set (MCCS) standard over an I2C 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 drive value.

Syntax

_BOOL GetMonitorRedGreenOrBlueDrive(
  [in]  HANDLE        hMonitor,
  [in]  MC_DRIVE_TYPE dtDriveType,
  [out] LPDWORD       pdwMinimumDrive,
  [out] LPDWORD       pdwCurrentDrive,
  [out] LPDWORD       pdwMaximumDrive
);

Parameters

[in] hMonitor

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

[in] dtDriveType

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

[out] pdwMinimumDrive

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

[out] pdwCurrentDrive

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

[out] pdwMaximumDrive

Receives the maximum red, green, or blue drive 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

Drive settings are generally used to adjust the monitor's white point. Drive and black level are different names for the same monitor setting. If this function is supported, the GetMonitorCapabilities function returns the MC_CAPS_RED_GREEN_BLUE_DRIVE flag.

This function takes about 40 milliseconds to return.

The drive 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

See also

Monitor Configuration Functions