Edit

D3DDDI_ALLOCATIONINFO2 structure (d3dukmdt.h)

  • Article

The D3DDDI_ALLOCATIONINFO2 structure describes an allocation.

Syntax

typedef struct _D3DDDI_ALLOCATIONINFO2 {
  D3DKMT_HANDLE                         hAllocation;
  union {
    HANDLE     hSection;
    const VOID *pSystemMem;
  } D3DKMT_ALIGN64;
  void                                  D3DKMT_PTR(
    VOID               *unnamedParam1,
    pPrivateDriverData unnamedParam2
  );
  UINT                                  PrivateDriverDataSize;
  D3DDDI_VIDEO_PRESENT_SOURCE_ID        VidPnSourceId;
  union {
    struct {
      UINT Primary : 1;
      UINT Stereo : 1;
      UINT OverridePriority : 1;
#if ...
      UINT Reserved : 29;
#elif
      UINT Reserved : 30;
#else
      UINT Reserved : 31;
#endif
    };
    UINT Value;
  } Flags;
  D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS GpuVirtualAddress;
  union {
    UINT                     Priority;
    D3DKMT_ALIGN64 ULONG_PTR Unused;
  };
#if ...
  D3DKMT_ALIGN64 ULONG_PTR              Reserved[5];
#else
  D3DKMT_ALIGN64 ULONG_PTR              Reserved[6];
#endif
} D3DDDI_ALLOCATIONINFO2;

Members

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.

D3DKMT_ALIGN64

Union with hSection and pSystemMem.

D3DKMT_ALIGN64.hSection

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

D3DKMT_ALIGN64.pSystemMem

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

void D3DKMT_PTR( VOID *unnamedParam1, pPrivateDriverData unnamedParam2)

PrivateDriverDataSize

[in] Size in bytes of the private data.

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.

Flags

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

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).

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).

Flags.OverridePriority

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

Flags.Reserved

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

Flags.Value

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

GpuVirtualAddress

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

Priority

[in] The priority of the allocation.

Unused

Unused.

Reserved[5]

Reserved[6]

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.

Requirements

Requirement Value
Minimum supported client Windows 7
Header d3dukmdt.h

See also

CreateResource

D3DDDICB_ALLOCATE

D3DDDI_SURFACEINFO

D3DKMDDI_SHAREDPRIMARYSURFACEDATA

DXGKARG_CREATEALLOCATION

DXGK_ALLOCATIONINFO

DxgkDdiCreateAllocation

pfnAllocateCb