Edit

DXGK_BRIGHTNESS_GET_POSSIBLE callback function (dispmprt.h)

  • Article

The DxgkDdiGetPossibleBrightness function retrieves the brightness levels that an integrated display panel supports.

Syntax

DXGK_BRIGHTNESS_GET_POSSIBLE DxgkBrightnessGetPossible;

NTSTATUS DxgkBrightnessGetPossible(
  [in]  PVOID Context,
  [in]  ULONG BufferSize,
  [out] PUCHAR LevelCount,
  [out] PUCHAR BrightnessLevels
)
{...}

Parameters

[in] Context

[in] 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] BufferSize

[in] The size, in bytes, of the buffer that is passed in the BrightnessLevels parameter.

[out] LevelCount

[out] A pointer to a variable that receives the number of brightness levels that the driver returns in the buffer that the BrightnessLevels parameter points to.

[out] BrightnessLevels

[in/out] A pointer to a buffer that receives the brightness levels that an integrated display panel supports.

Return value

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

Remarks

The display miniport driver should return brightness levels in the buffer that the BrightnessLevels parameter points to in the following order:

  • The first brightness level value is the brightness level that the BIOS uses when the computer runs on AC power.
  • The second brightness level value is the brightness level that the BIOS uses when the computer runs on DC power.
  • The remaining brightness level values are hardware-supported brightness levels.
To simplify your job of implementing a display miniport driver, the operating system provides the driver with the buffer that the BrightnessLevels parameter points to.

DxgkDdiGetPossibleBrightness 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