DXGKDDI_DESCRIBEALLOCATION callback function

The DxgkDdiDescribeAllocation function retrieves information about an existing allocation that is not otherwise available to the Microsoft DirectX graphics kernel subsystem.

Syntax

DXGKDDI_DESCRIBEALLOCATION DxgkddiDescribeallocation;

NTSTATUS DxgkddiDescribeallocation(
  IN_CONST_HANDLE hAdapter,
  INOUT_PDXGKARG_DESCRIBEALLOCATION pDescribeAllocation
)
{...}

Parameters

hAdapter

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

pDescribeAllocation

[in/out] A pointer to a DXGKARG_DESCRIBEALLOCATION structure that describes an existing allocation.

Return Value

DxgkDdiDescribeAllocation returns STATUS_SUCCESS if it succeeds; otherwise, it returns one of the error codes defined in Ntstatus.h.

Remarks

Because the DirectX graphics kernel subsystem does not necessarily maintain records of allocations, the graphics kernel subsystem calls DxgkDdiDescribeAllocation to request that the display miniport driver return information about existing allocations. Currently, the display miniport driver must be able to return this information for the following allocations:

  • Allocations that are also primaries (that is, allocations that the user-mode display driver created by setting the Primary bit-field flag in the Flags member of the D3DDDI_ALLOCATIONINFO structure in a call to the pfnAllocateCb function).
  • Allocations that might be the source of a presentation (that is, allocations that are represented by the hSource member of the DXGKARG_PRESENT structure in a call to the display miniport driver's DxgkDdiPresent function).
DxgkDdiDescribeAllocation should be made pageable.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h
IRQL PASSIVE_LEVEL

See Also

D3DDDI_ALLOCATIONINFO

DXGKARG_DESCRIBEALLOCATION

DxgkDdiAddDevice

DxgkDdiPresent

pfnAllocateCb