Edit

Share via

GetMonitorBrightness 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 minimum, maximum, and current brightness settings.

Syntax

_BOOL GetMonitorBrightness(
  [in]  HANDLE  hMonitor,
  [out] LPDWORD pdwMinimumBrightness,
  [out] LPDWORD pdwCurrentBrightness,
  [out] LPDWORD pdwMaximumBrightness
);

Parameters

[in] hMonitor

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

[out] pdwMinimumBrightness

Receives the monitor's minimum brightness.

[out] pdwCurrentBrightness

Receives the monitor's current brightness.

[out] pdwMaximumBrightness

Receives the monitor's maximum brightness.

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_BRIGHTNESS flag.

This function takes about 40 milliseconds to return.

The brightness setting is a continuous monitor setting. 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