DXGK_BRIGHTNESS_GET_CAPS callback function (dispmprt.h)

Article
02/22/2024

Retrieves brightness control capabilities of an integrated display panel.

Syntax

DXGK_BRIGHTNESS_GET_CAPS DxgkBrightnessGetCaps;

NTSTATUS DxgkBrightnessGetCaps(
  [in] PVOID Context,
  [in] DXGK_BRIGHTNESS_CAPS *BrightnessCaps
)
{...}

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 DirectX graphics kernel subsystem.

[in] BrightnessCaps

A pointer to a DXGK_BRIGHTNESS_CAPS structure that represents the brightness control capabilities of the display panel.

Return value

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

Remarks

This function lets the display miniport driver independently indicate its support for adaptive brightness control and/or smooth brightness control.

If the hardware includes an ambient light sensor, it must support smooth brightness control. The display miniport driver, not an embedded controller, must control the smooth brightness functioning of the integrated display panel.

If the driver is started by a Plug and Play (PnP) event, it must transition smoothly from the initial brightness level set by firmware to the level set by the operating system. If additional devices are connected to the system, they must not affect the driver's ability to perform smooth brightness control on the integrated display panel.

The driver must continue to support smooth brightness control even if adaptive brightness control is initiated.

This function should be made pageable.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Desktop
Header	dispmprt.h (include Dispmprt.h)
IRQL	PASSIVE_LEVEL