DXGKDDI_SETPALETTE callback function (d3dkmddi.h)

Article
02/22/2024

The DxgkDdiSetPalette function programs the color registers for palettized 8 bits-per-pixel (bpp) modes.

Syntax

DXGKDDI_SETPALETTE DxgkddiSetpalette;

NTSTATUS DxgkddiSetpalette(
  [in] IN_CONST_HANDLE hAdapter,
  [in] IN_CONST_PDXGKARG_SETPALETTE pSetPalette
)
{...}

Parameters

[in] hAdapter

A handle to a context block that is associated with a display adapter. The display miniport driver previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

[in] pSetPalette

A pointer to a DXGKARG_SETPALETTE structure that describes the palette to set for the display.

Return value

DxgkDdiSetPalette returns STATUS_SUCCESS, or an appropriate error result if the display palette is not successfully set.

Remarks

Implementation of the DxgkDdiSetPalette function in the Windows Vista display driver model replaces IOCTL_VIDEO_SET_COLOR_REGISTERS functionality in the Windows 2000 display driver model.

DxgkDdiSetPalette should be made pageable.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Target Platform	Desktop
Header	d3dkmddi.h
IRQL	PASSIVE_LEVEL