Edit

CD3DX12_CPU_DESCRIPTOR_HANDLE structure

  • Article

A helper structure to enable easy initialization of a D3D12_CPU_DESCRIPTOR_HANDLE structure.

Syntax

struct CD3DX12_CPU_DESCRIPTOR_HANDLE  : public D3D12_CPU_DESCRIPTOR_HANDLE{
                                  CD3DX12_CPU_DESCRIPTOR_HANDLE();
                                  explicit CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &o);
                                  CD3DX12_CPU_DESCRIPTOR_HANDLE(CD3DX12_DEFAULT);
                                  CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &other, INT offsetScaledByIncrementSize);
                                  CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &other, INT offsetInDescriptors, UINT descriptorIncrementSize);
  CD3DX12_CPU_DESCRIPTOR_HANDLE&  Offset(INT offsetInDescriptors, UINT descriptorIncrementSize);
  CD3DX12_CPU_DESCRIPTOR_HANDLE&  Offset(INT offsetScaledByIncrementSize);
  bool                            operator==( _In_ const D3D12_CPU_DESCRIPTOR_HANDLE& other) const;
  bool                            operator!=(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE& other) const;
  CD3DX12_CPU_DESCRIPTOR_HANDLE & operator=(const D3D12_CPU_DESCRIPTOR_HANDLE &other);
  void                            inline InitOffsetted(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetScaledByIncrementSize);
  void                            inline InitOffsetted(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetInDescriptors, UINT descriptorIncrementSize);
  void                            static inline InitOffsetted(_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle, _In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetScaledByIncrementSize);
  void                            static inline InitOffsetted(_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle, _In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetInDescriptors, UINT descriptorIncrementSize);
};

Members

CD3DX12_CPU_DESCRIPTOR_HANDLE()

Creates a new, uninitialized, instance of a CD3DX12_CPU_DESCRIPTOR_HANDLE.

explicit CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &o)

Creates a new instance of a CD3DX12_CPU_DESCRIPTOR_HANDLE, initialized with the contents of another D3D12_CPU_DESCRIPTOR_HANDLE structure.

CD3DX12_CPU_DESCRIPTOR_HANDLE(CD3DX12_DEFAULT)

Creates a new instance of a CD3DX12_CPU_DESCRIPTOR_HANDLE, initialized with default parameters (pointer set to zero).

CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &other, INT offsetScaledByIncrementSize)

Creates a new instance of a CD3DX12_CPU_DESCRIPTOR_HANDLE, initializing the following parameters:

D3D12_CPU_DESCRIPTOR_HANDLE &other

INT offsetScaledByIncrementSize: The number of increments by which to offset.

CD3DX12_CPU_DESCRIPTOR_HANDLE(const D3D12_CPU_DESCRIPTOR_HANDLE &other, INT offsetInDescriptors, UINT descriptorIncrementSize)

Creates a new instance of a CD3DX12_CPU_DESCRIPTOR_HANDLE, initializing the following parameters:

D3D12_CPU_DESCRIPTOR_HANDLE &other

INT offsetInDescriptors: The number of descriptors by which to increment.

UINT descriptorIncrementSize: The amount by which to increment for each descriptor, including padding.

Offset(INT offsetInDescriptors, UINT descriptorIncrementSize)

Sets the offset based on the specified number of descriptors and how much to increment for each descriptor. Uses the following parameters:

INT offsetInDescriptors: The number of descriptors by which to increment.

UINT descriptorIncrementSize: The amount by which to increment for each descriptor, including padding.

Offset(INT offsetScaledByIncrementSize)

Sets the offset based on the specified number of increments. Uses the following parameters:

INT offsetScaledByIncrementSize: The number of increments by which to offset.

operator==( _In_ const D3D12_CPU_DESCRIPTOR_HANDLE& other) const

Tests for equality between the current CD3DX12_CPU_DESCRIPTOR_HANDLE and the specified D3D12_CPU_DESCRIPTOR_HANDLE or CD3DX12_CPU_DESCRIPTOR_HANDLE.

operator!=(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE& other) const

Tests for inequality between the current CD3DX12_CPU_DESCRIPTOR_HANDLE and the specified D3D12_CPU_DESCRIPTOR_HANDLE or CD3DX12_CPU_DESCRIPTOR_HANDLE.

operator=(const D3D12_CPU_DESCRIPTOR_HANDLE &other)

Sets the current CD3DX12_CPU_DESCRIPTOR_HANDLE to the same values as the specified D3D12_CPU_DESCRIPTOR_HANDLE or CD3DX12_CPU_DESCRIPTOR_HANDLE.

inline InitOffsetted(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetScaledByIncrementSize)

Initializes a D3D12_CPU_DESCRIPTOR_HANDLE structure with the specified number of items. Uses the following parameters:

_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base: The base address from which to offset.

INT offsetScaledByIncrementSize: The number of increments by which to offset.

inline InitOffsetted(_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetInDescriptors, UINT descriptorIncrementSize)

Initializes a D3D12_CPU_DESCRIPTOR_HANDLE structure with an offset, using the specified number of descriptors of the given size. Uses the following parameters:

_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base: The base address from which to offset.

INT offsetInDescriptors: The number of descriptors by which to offset.

UINT descriptorIncrementSize: The amount by which to increment for each descriptor, including padding.

static inline InitOffsetted(_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle, _In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetScaledByIncrementSize)

Initializes a D3D12_CPU_DESCRIPTOR_HANDLE structure with an offset, using the specified number of descriptors of the given size. Uses the following parameters:

_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle: Outputs the resulting D3D12_CPU_DESCRIPTOR_HANDLE.

_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base: The base address from which to offset.

INT offsetScaledByIncrementSize: The number of increments by which to offset.

static inline InitOffsetted(_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle, _In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base, INT offsetInDescriptors, UINT descriptorIncrementSize)

Initializes a D3D12_CPU_DESCRIPTOR_HANDLE structure with an offset, using the specified number of descriptors of the given size. Uses the following parameters:

_Out_ D3D12_CPU_DESCRIPTOR_HANDLE &handle: Outputs the resulting D3D12_CPU_DESCRIPTOR_HANDLE.

_In_ const D3D12_CPU_DESCRIPTOR_HANDLE &base: The base address from which to offset.

INT offsetInDescriptors: The number of descriptors by which to offset.

UINT descriptorIncrementSize: The amount by which to increment for each descriptor, including padding.

Requirements

Requirement Value
Header
D3dx12.h

See also

Helper Structures for D3D12