Edit

DXGK_BRIGHTNESS_SET_STATE callback function (dispmprt.h)

  • Article

Enables smooth brightness control on an integrated display panel.

Syntax

DXGK_BRIGHTNESS_SET_STATE DxgkBrightnessSetState;

NTSTATUS DxgkBrightnessSetState(
  [in] PVOID Context,
  [in] DXGK_BRIGHTNESS_STATE *BrightnessState
)
{...}

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] BrightnessState

A pointer to a DXGK_BRIGHTNESS_STATE structure that indicates that the display miniport driver should enable the smooth brightness control for the integrated 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

For the operating system to be able to adjust screen brightness smoothly, starting with Windows 8 the display miniport driver must report 10 brightness levels, expressed from 0 to 100 percent. At a level of zero percent, the screen contents should be barely visible to the user. A level of 100 percent is the maximum brightness that the integrated display panel can produce. The driver and hardware can support finer brightness control for internal operations.

When the DxgkDdiSetBrightness function is called, the driver should select an appropriate slope to provide a smooth brightness transition based on panel characteristics, but any transition must complete in under 500 milliseconds.

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

See also

DxgkDdiAddDevice

DxgkDdiSetBrightness