Skip to content

LiteFX

LiteFX::Rendering::Backends::DirectX12Device

`LiteFX::Rendering::Backends::DirectX12Device`¶

Implements a DirectX 12 graphics device.

Synopsis¶

Declared in <litefx/backends/dx12.hpp>

class [[dllimport, dllexport]] DirectX12Device final
    : public GraphicsDevice<DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12DescriptorRange, DirectX12RenderPipeline, DirectX12ComputePipeline, DirectX12RayTracingPipeline, DirectX12Barrier>
    , public ComResource<ID3D12Device10>

Base Classes¶

Name	Description
`GraphicsDevice<DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12DescriptorRange, DirectX12RenderPipeline, DirectX12ComputePipeline, DirectX12RayTracingPipeline, DirectX12Barrier>`	Represents the graphics device that a rendering back-end is doing work on.
`ComResource<ID3D12Device10>`	A resource that is hold by a `ComPtr`.

Type Aliases¶

Name
`adapter_type`
`barrier_builder_Type`
`barrier_type`
`bottom_level_acceleration_structure_type`
`buffer_type`
`command_buffer_type`
`command_queue_type`
`compute_pipeline_builder_type`
`compute_pipeline_type`
`descriptor_layout_type`
`descriptor_range_type`
`descriptor_set_type`
`factory_type`
`frame_buffer_type`
`handle_type`
`image_type`
`index_buffer_type`
`input_assembler_builder_type`
`input_assembler_type`
`pipeline_layout_builder_type`
`pipeline_layout_type`
`pipeline_type`
`rasterizer_builder_type`
`rasterizer_type`
`ray_tracing_pipeline_builder_type`
`ray_tracing_pipeline_type`
`render_pass_builder_type`
`render_pass_type`
`render_pipeline_builder_type`
`render_pipeline_type`
`sampler_type`
`shader_program_builder_type`
`shader_program_type`
`surface_type`
`swap_chain_type`
`top_level_acceleration_structure_type`
`vertex_buffer_type`

Member Functions¶

Name	Description
`~DirectX12Device` [destructor] [virtual]	Destructor
`adapter` [virtual]	Returns the graphics adapter, the device uses for drawing.
`allocateGlobalDescriptors` [virtual]	Allocates a descriptor range with a capacity of `descriptors` from the global descriptor heap indicated by `heapType.` This overload allocates a raw descriptor range from a global descriptor heap. It is intended for interop purposes, where external libraries need to bind resources, as well as bindless rendering using SM 6.6 dynamic resources (`ResourceDescriptorHeap`/`SamplerDescriptorHeap`).
`allocateGlobalDescriptors` [virtual]	Allocates a descriptor range with a capacity of `descriptors` from the global descriptor heap indicated by `heapType.` This overload allocates a raw descriptor range from a global descriptor heap. It is intended for interop purposes, where external libraries need to bind resources, as well as bindless rendering using SM 6.6 dynamic resources (`ResourceDescriptorHeap`/`SamplerDescriptorHeap`).
`allocateGlobalDescriptors` [virtual]	Allocates a range of descriptors in the global descriptor heap indicated by `heapType` for the provided `descriptorSet.`
`bindDescriptorSet`	Binds the descriptors of the descriptor set to the global descriptor heaps.
`bindGlobalDescriptorHeaps` [virtual]	Binds the global descriptor heap.
`bindGlobalDescriptorHeaps` [virtual]	Binds the global descriptor heap.
`buildBarrier` [virtual]	Returns a builder for a `Barrier`.
`buildComputePipeline` [virtual]	Returns a builder for a `ComputePipeline`.
`buildInputAssembler` [virtual]	Returns a builder for a `InputAssembler`.
`buildPipelineLayout` [virtual]	Returns a builder for a `PipelineLayout`.
`buildRasterizer` [virtual]	Returns a builder for a `Rasterizer`.
`buildRayTracingPipeline` [virtual]	Returns a builder for a `RayTracingPipeline`.
`buildRayTracingPipeline` [virtual]	Returns a builder for a `RayTracingPipeline`.
`buildRenderPass` [virtual]	Returns a builder for a `RenderPass`.
`buildRenderPass` [virtual]	Returns a builder for a `RenderPass`.
`buildRenderPipeline` [virtual]	Returns a builder for a `RenderPipeline`.
`buildRenderPipeline` [virtual]	Returns a builder for a `RenderPipeline`.
`buildShaderProgram` [virtual]	Returns a builder for a `ShaderProgram`.
`computeAccelerationStructureSizes` [virtual]	Computes the required amount of device memory for an `IBottomLevelAccelerationStructure`.
`computeAccelerationStructureSizes` [virtual]	Computes the required amount of device memory for an `ITopLevelAccelerationStructure`.
`computeAccelerationStructureSizes` [virtual]	Computes the required amount of device memory for an `IBottomLevelAccelerationStructure`.
`computeAccelerationStructureSizes` [virtual]	Computes the required amount of device memory for an `ITopLevelAccelerationStructure`.
`copyGlobalDescriptorHeap`	Copies `descriptors` descriptors from a CPU-only heap, starting at `source,` into the global `heapType` heap at `targetIndex.`
`createQueue` [virtual]	Attempts to create a new queue that supports the combination of queue types specified by the `type` parameter.
`createQueue` [virtual]	Attempts to create a new queue that supports the combination of queue types specified by the `type` parameter.
`defaultQueue` [virtual]	Returns the instance of the default `ICommandQueue` that supports the combination of queue types specified by the `type` parameter.
`descriptorHeaps` [virtual]	Returns the global descriptor heaps from which all descriptors in the device are allocated.
`factory` [virtual]	Returns the factory instance, used to create instances from the device.
`globalBufferHeap`	Returns the global descriptor heap.
`globalSamplerHeap`	Returns the global sampler heap.
`handle` [virtual]	Returns the resource managed by the class.
`indirectDrawSignatures`	Returns the command signatures for indirect dispatch and draw calls.
`makeBarrier` [virtual]	Creates a memory barrier instance.
`makeFrameBuffer`	Creates a new frame buffer instance.
`makeFrameBuffer` [virtual]	Creates a new frame buffer instance.
`makeFrameBuffer`	Creates a new frame buffer instance.
`makeFrameBuffer` [virtual]	Creates a new frame buffer instance.
`makeFrameBuffer` [virtual]	Creates a new frame buffer instance.
`maximumMultiSamplingLevel` [virtual]	Queries the device for the maximum supported number of multi-sampling levels.
`state` [virtual]	Returns the device state that can be used to manage resources.
`supportsStorageImageFormat` [virtual]	Returns `true`, if `format` can be used in writable images, i.e., as `RWTexture<T>`.
`supportsTexelBufferFormat` [virtual]	Returns `true`, if `format` can be used in texel buffers, i.e., as `Buffer<T>`, or as `RWBuffer<T>` if `writable` is set.
`surface` [virtual]	Returns the surface, the device draws to.
`swapChain` [virtual]	Returns the swap chain, that contains the back and front buffers used for presentation.
`swapChain` [virtual]	Returns the swap chain, that contains the back and front buffers used for presentation.
`ticksPerMillisecond` [virtual]	Returns the number of GPU ticks per milliseconds.
`updateGlobalDescriptors`	Updates a range of descriptors in the global buffer descriptor heap with the descriptors from `descriptorSet.`
`wait` [virtual]	Waits until all queues allocated from the device have finished the work issued prior to this point.

Static Member Functions¶

Name	Description
`create`	Initializes the device instance.
`create`	Initializes the device instance.

Protected Member Functions¶

Name	Description
`operator=`	Assignment operator
`operator=` [deleted]	Assignment operator
`operator=`	Assignment operator
`operator=`	Assignment operator
`handle` [virtual]	Returns the resource managed by the class.

Friends¶

Name	Description
`LiteFX::Rendering::Backends::DirectX12DescriptorRange`	Implements a DirectX12 `IDescriptorRange`.
`LiteFX::Rendering::Backends::DirectX12DescriptorSet`	Implements a DirectX 12 `DescriptorSet`.
`LiteFX::Rendering::Backends::DirectX12Backend`	Implements the DirectX 12 `RenderBackend`.
`LiteFX::SharedObject::Allocator`	An allocator used to allocate the shared object.
`LiteFX::Rendering::Backends::DirectX12Device::DirectX12DeviceImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.