D3D12_DESCRIPTOR_HEAP_FLAGS enumeration (d3d12.h)

Specifies options for a heap.

Syntax

typedef enum D3D12_DESCRIPTOR_HEAP_FLAGS {
  D3D12_DESCRIPTOR_HEAP_FLAG_NONE = 0,
  D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE = 0x1
} ;

Constants

D3D12_DESCRIPTOR_HEAP_FLAG_NONE Value: 0 Indicates default usage of a heap.
D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE Value: 0x1 The flag D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE can optionally be set on a descriptor heap to indicate it is be bound on a command list for reference by shaders. Descriptor heaps created without this flag allow applications the option to stage descriptors in CPU memory before copying them to a shader visible descriptor heap, as a convenience. But it is also fine for applications to directly create descriptors into shader visible descriptor heaps with no requirement to stage anything on the CPU. Descriptor heaps bound via ID3D12GraphicsCommandList::SetDescriptorHeaps must have the D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE flag set, else the debug layer will produce an error. Descriptor heaps with the D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE flag can't be used as the source heaps in calls to ID3D12Device::CopyDescriptors or ID3D12Device::CopyDescriptorsSimple, because they could be resident in WRITE_COMBINE memory or GPU-local memory, which is very inefficient to read from. This flag only applies to CBV/SRV/UAV descriptor heaps, and sampler descriptor heaps. It does not apply to other descriptor heap types since shaders do not directly reference the other types. Attempting to create an RTV/DSV heap with D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE results in a debug layer error.

Remarks

This enum is used by the D3D12_DESCRIPTOR_HEAP_DESC structure.

Requirements

Requirement	Value
Header	d3d12.h

See also

Core Enumerations

Creating Descriptor Heaps

Descriptor Heaps