Skip to content

Latest commit

 

History

History
160 lines (102 loc) · 6.75 KB

ns-d3dukmdt-_d3dddi_allocationinfo2.md

File metadata and controls

160 lines (102 loc) · 6.75 KB
Raw
UID title description ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.lib req.dll req.ddi-compliance req.unicode-ansi req.max-support req.typenames targetos ms.custom tech.root f1_keywords topic_type api_type api_location api_name dev_langs
NS:d3dukmdt._D3DDDI_ALLOCATIONINFO2
D3DDDI_ALLOCATIONINFO2 (d3dukmdt.h)
Learn more about the D3DDDI_ALLOCATIONINFO2 structure.
11/17/2023
D3DDDI_ALLOCATIONINFO2 structure
_D3DDDI_ALLOCATIONINFO2, D3DDDI_ALLOCATIONINFO2,
d3dukmdt.h
Windows 7
D3DDDI_ALLOCATIONINFO2
Windows
RS5
display
_D3DDDI_ALLOCATIONINFO2
d3dukmdt/_D3DDDI_ALLOCATIONINFO2
D3DDDI_ALLOCATIONINFO2
d3dukmdt/D3DDDI_ALLOCATIONINFO2
apiref
HeaderDef
d3dukmdt.h
_D3DDDI_ALLOCATIONINFO2
D3DDDI_ALLOCATIONINFO2
c++

D3DDDI_ALLOCATIONINFO2 structure

-description

The D3DDDI_ALLOCATIONINFO2 structure describes an allocation.

-struct-fields

-field hAllocation

[out] A D3DKMT_HANDLE handle that represents a kernel-mode handle to the allocation. This handle is associated with the kernel-mode resource handle (if non-NULL) that the Direct3D runtime's pfnAllocateCb function returns in the hKMResource member of the D3DDDICB_ALLOCATE structure. The user-mode display driver can use this kernel-mode allocation handle to reference the allocation in the command buffer.

-field D3DKMT_ALIGN64

Union with hSection and pSystemMem.

-field D3DKMT_ALIGN64.hSection

[in] A handle to valid section object. Use hSection when D3DKMT_CREATEALLOCATIONFLAGS::ExistingSection is set.

-field D3DKMT_ALIGN64.pSystemMem

[in] A pointer to pre-allocated system memory. Use pSystemMem when D3DKMT_CREATEALLOCATIONFLAGS::ExistingSection isn't set.

-field pPrivateDriverData

[in/out,opt] A pointer to buffer that contains optional private data that might be required by the display miniport driver to create the allocation. The display miniport driver can also return data in the buffer. When the contents of the buffer are passed to the display miniport driver, the contents must be in a format that the display miniport driver can process.

-field PrivateDriverDataSize

[in] Size in bytes of the private data.

-field VidPnSourceId

[in] The zero-based VidPN identification number of the video present source in a path of a video present network (VidPN) topology if the allocation is for the primary surface. The driver should set VidPnSourceId only for primary allocation types and not for any other type of allocation. If the driver sets VidPnSourceId for any other allocation type in a call to the pfnAllocateCb function, pfnAllocateCb returns D3DDDI_ID_NOTAPPLICABLE.

When the DirectX graphics kernel subsystem initiates the creation of the allocation for the shared primary surface, the display miniport driver can determine the identification number from the VidPnSourceId member of the D3DKMDDI_SHAREDPRIMARYSURFACEDATA structure that the pPrivateDriverData member of the DXGK_ALLOCATIONINFO structure points to.

-field Flags

[in] A union that contains either a structure or a 32-bit value that identifies the type of allocation.

-field Flags.Primary

[in] A UINT that specifies whether the allocation is part of the desktop. Such an allocation is implicitly accessible to the CPU. A primary allocation can be either pinned down at creation or not pinned down at creation.

Setting this member is equivalent to setting the first bit of the 32-bit Value member (0x00000001).

-field Flags.Stereo

[in] Supported beginning with Windows 8 (WDDM 1.2). A UINT that specifies whether the allocation is a stereo primary allocation. The Stereo member can be set only when the Primary member is set.

Setting this member is equivalent to setting the second bit of the 32-bit Value member (0x00000002).

-field Flags.OverridePriority

[in] Supported starting in Windows 10 version 1703 (WDDM 2.2). Override priority, as established by the user-mode graphics driver.

-field Flags.Reserved

[in] This member is reserved and should be set to zero.

-field Flags.Value

[in] A 32-bit value that identifies the type of allocation.

-field GpuVirtualAddress

[out] The GPU virtual address of the created allocation.

-field Priority

[in] The priority of the allocation.

-field Unused

Unused.

-field Reserved[5]

Reserved.

-field Reserved[6]

Reserved.

-remarks

When the user-mode display driver sets the Primary bit-field flag in the Flags member of D3DDDI_ALLOCATIONINFO, certain restrictions apply to the DXGK_ALLOCATIONINFO structure in the pAllocationInfo member of the DXGKARG_CREATEALLOCATION structure for the allocation in a call to the display miniport driver's DxgkDdiCreateAllocation function. These restrictions include the following:

  • The allocation is allocated according to preferences; otherwise, the allocation defaults to the supported write segment set, and all of the specified segments in the write segment set must be CPU-accessible.

  • The display miniport driver cannot set the following bit-field flags in the Flags member of DXGK_ALLOCATIONINFO:

  • PermanentSysMem

  • Cached

  • Protected

  • ExistingSysMem

  • ExistingKernelSysMem

The D3DDDI_ID_NOTAPPLICABLE constant is defined in D3dukmdt.h.

-see-also

CreateResource

D3DDDICB_ALLOCATE

D3DDDI_SURFACEINFO

D3DKMDDI_SHAREDPRIMARYSURFACEDATA

DXGKARG_CREATEALLOCATION

DXGK_ALLOCATIONINFO

DxgkDdiCreateAllocation

pfnAllocateCb