DXGKCB_PINFRAMEBUFFERFORSAVE callback function (d3dkmddi.h)

Article
02/22/2024

A kernel-mode display miniport driver calls DXGKCB_PINFRAMEBUFFERFORSAVE to pin down the entire frame buffer at once.

Syntax

DXGKCB_PINFRAMEBUFFERFORSAVE DxgkcbPinframebufferforsave;

NTSTATUS DxgkcbPinframebufferforsave(
  [in]     IN_CONST_HANDLE hAdapter,
  [in/out] INOUT_PDXGKARGCB_PINFRAMEBUFFERFORSAVE pPinFrameBufferForSave
)
{...}

Parameters

[in] hAdapter

A handle to a display adapter. The driver provides this handle for the master/lead device in the linked display adapter (LDA) chain.

[in/out] pPinFrameBufferForSave

Pointer to a DXGKARGCB_PINFRAMEBUFFERFORSAVE structure that contains information about the frame buffer to save.

Return value

DXGKCB_PINFRAMEBUFFERFORSAVE returns STATUS_SUCCESS if the operation succeeds. Otherwise, it returns an appropriate NTSTATUS error code.

Remarks

DXGKCB_XXX functions are implemented by Dxgkrnl. To use this callback function, set the appropriate members of DXGKARGCB_PINFRAMEBUFFERFORSAVE and then call DxgkCbPinFrameBufferForSave via the DXGKRNL_INTERFACE.

See IOMMU-based GPU isolation for more information.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1803 (WDDM 2.4)
Header	d3dkmddi.h
IRQL	PASSIVE_LEVEL