DXGKARG_DESCRIBEALLOCATION structure (d3dkmddi.h)

The DXGKARG_DESCRIBEALLOCATION structure describes an existing allocation.

Syntax

typedef struct _DXGKARG_DESCRIBEALLOCATION {
  [in]  HANDLE                       hAllocation;
  [out] UINT                         Width;
  [out] UINT                         Height;
  [out] D3DDDIFORMAT                 Format;
  [out] D3DDDI_MULTISAMPLINGMETHOD   MultisampleMethod;
  [out] D3DDDI_RATIONAL              RefreshRate;
  [out] UINT                         PrivateDriverFormatAttribute;
  [out] DXGK_DESCRIBEALLOCATIONFLAGS Flags;
  [out] D3DDDI_ROTATION              Rotation;
} DXGKARG_DESCRIBEALLOCATION;

Members

[in] hAllocation

A handle to an allocation that information is requested for. The driver previously returned this handle in the hAllocation member of the DXGK_ALLOCATIONINFO structure from a call to the driver's DxgkDdiCreateAllocation function.

[out] Width

The width of the allocation, in pixels. The driver returns the width value.

[out] Height

The height of the allocation, in pixels. The driver returns the height value.

[out] Format

A D3DDDIFORMAT-typed value that indicates the pixel format of the allocation. The driver returns the format value.

[out] MultisampleMethod

A D3DDDI_MULTISAMPLINGMETHOD structure that describes the multiple-sampling method that is used for the allocation. The driver returns the description.

[out] RefreshRate

A D3DDDI_RATIONAL structure that indicates the refresh rate that the primary surface was created with, if applicable.

[out] PrivateDriverFormatAttribute

A UINT value that specifies a private format attribute for the allocation. The driver specifies surface format attributes (for example, the pixel layout of a tiled surface) that it otherwise cannot expose to the operating system.

The operating system uses the information in PrivateDriverFormatAttribute to compare two surfaces. For example, an A8R8B8G8 800x600 surface and an X8R8B8G8 800x600 surface should have the same information in PrivateDriverFormatAttribute if they have the same format attributes, which includes pixel layout.

[out] Flags

This member is reserved.

Supported starting with Windows 8.

[out] Rotation

This member is reserved.

Supported starting with Windows 8.

Requirements

See also

D3DDDIFORMAT

D3DDDI_MULTISAMPLINGMETHOD

D3DDDI_RATIONAL

D3DDDI_ROTATION

DXGK_ALLOCATIONINFO

DXGK_DESCRIBEALLOCATIONFLAGS

DxgkDdiCreateAllocation

DxgkDdiDescribeAllocation