DXGK_BRIGHTNESS_GET callback function (dispmprt.h)

The DxgkDdiGetBrightness function retrieves the currently active brightness level of an integrated display panel.

Syntax

DXGK_BRIGHTNESS_GET DxgkBrightnessGet;

NTSTATUS DxgkBrightnessGet(
  [in] PVOID Context,
  [in] PUCHAR Brightness
)
{...}

Parameters

[in] Context

A handle to a context block that is associated with a display adapter. The display miniport driver's DxgkDdiAddDevice function previously provided this handle to the Microsoft DirectX graphics kernel subsystem.

[in] Brightness

A pointer to a variable that receives the brightness level.

Return value

DxgkDdiGetBrightness returns STATUS_SUCCESS if it succeeds. Otherwise, it returns one of the error codes that are defined in Ntstatus.h.

Remarks

When the monitor driver initializes, it can call the display miniport driver's DxgkDdiGetBrightness function to retrieve the brightness level that will be currently active for the integrated display panel.

Because the monitor driver always gets the brightness level for the integrated display panel on boot or resume and all changes in brightness go through the monitor driver, the monitor driver should always have the current brightness level cached. Therefore, when clients query for the current brightness level, the level is queried from the monitor driver and not from the display miniport driver.

DxgkDdiGetBrightness should be made pageable.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header dispmprt.h (include Dispmprt.h)
IRQL PASSIVE_LEVEL

See also

DxgkDdiAddDevice