Implements a DirectX 12 graphics device. More...

#include <dx12.hpp>

Inherits LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >, and LiteFX::Resource< THandle >.

Classes
class	DirectX12DeviceImpl

Public Member Functions
	DirectX12Device (const DirectX12Backend &backend, const DirectX12GraphicsAdapter &adapter, UniquePtr< DirectX12Surface > &&surface)
	Creates a new device instance. More...

	DirectX12Device (const DirectX12Backend &backend, const DirectX12GraphicsAdapter &adapter, UniquePtr< DirectX12Surface > &&surface, const Format &format, const Size2d &frameBufferSize, const UInt32 &frameBuffers, const UInt32 &globalBufferHeapSize=524287, const UInt32 &globalSamplerHeapSize=2048)
	Creates a new device instance. More...

	DirectX12Device (const DirectX12Device &)=delete

	DirectX12Device (DirectX12Device &&)=delete

virtual	~DirectX12Device () noexcept

virtual const DirectX12Backend &	backend () const noexcept
	Returns the backend from which the device got created. More...

virtual const ID3D12DescriptorHeap *	globalBufferHeap () const noexcept
	Returns the global descriptor heap. More...

virtual const ID3D12DescriptorHeap *	globalSamplerHeap () const noexcept
	Returns the global sampler heap. More...

virtual void	allocateGlobalDescriptors (const DirectX12DescriptorSet &descriptorSet, UInt32 &bufferOffset, UInt32 &samplerOffset) const
	Allocates a range of descriptors in the global descriptor heaps for the provided descriptorSet . More...

virtual void	releaseGlobalDescriptors (const DirectX12DescriptorSet &descriptorSet) const noexcept
	Releases a range of descriptors from the global descriptor heaps. More...

virtual void	updateBufferDescriptors (const DirectX12DescriptorSet &descriptorSet, const UInt32 &firstDescriptor, const UInt32 &descriptors) const noexcept
	Updates a range of descriptors in the global buffer descriptor heap with the descriptors from descriptorSet . More...

virtual void	updateSamplerDescriptors (const DirectX12DescriptorSet &descriptorSet, const UInt32 &firstDescriptor, const UInt32 &descriptors) const noexcept
	Updates a sampler descriptors in the global buffer descriptor heap with a descriptor from descriptorSet . More...

virtual void	bindDescriptorSet (const DirectX12CommandBuffer &commandBuffer, const DirectX12DescriptorSet &descriptorSet, const DirectX12PipelineState &pipeline) const noexcept
	Binds the descriptors of the descriptor set to the global descriptor heaps. More...

virtual void	bindGlobalDescriptorHeaps (const DirectX12CommandBuffer &commandBuffer) const noexcept
	Binds the global descriptor heap. More...

virtual DirectX12ComputePipeline &	blitPipeline () const noexcept
	Returns the compute pipeline that can be invoked to blit an image resource. More...

virtual DeviceState &	state () const noexcept override
	Returns the device state that can be used to manage resources. More...

virtual const DirectX12SwapChain &	swapChain () const noexcept override
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual DirectX12SwapChain &	swapChain () noexcept override
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual const DirectX12Surface &	surface () const noexcept override
	Returns the surface, the device draws to. More...

virtual const DirectX12GraphicsAdapter &	adapter () const noexcept override
	Returns the graphics adapter, the device uses for drawing. More...

virtual const DirectX12GraphicsFactory &	factory () const noexcept override
	Returns the factory instance, used to create instances from the device. More...

virtual const DirectX12Queue &	graphicsQueue () const noexcept override
	Returns the instance of the queue, used to process draw calls. More...

virtual const DirectX12Queue &	transferQueue () const noexcept override
	Returns the instance of the queue used for device-device transfers (e.g. between render-passes). More...

virtual const DirectX12Queue &	bufferQueue () const noexcept override
	Returns the instance of the queue used for host-device transfers. More...

virtual const DirectX12Queue &	computeQueue () const noexcept override
	Returns the instance of the queue used for compute calls. More...

virtual UniquePtr< DirectX12Barrier >	makeBarrier () const noexcept override

virtual MultiSamplingLevel	maximumMultiSamplingLevel (const Format &format) const noexcept override

virtual void	wait () const override
	Waits until the device is idle. More...

Public Member Functions inherited from LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >
virtual	~GraphicsDevice () noexcept=default

virtual const surface_type &	surface () const noexcept=0
	Returns the surface, the device draws to. More...

virtual const adapter_type &	adapter () const noexcept=0
	Returns the graphics adapter, the device uses for drawing. More...

virtual const swap_chain_type &	swapChain () const noexcept=0
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual swap_chain_type &	swapChain () noexcept=0
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual const factory_type &	factory () const noexcept=0
	Returns the factory instance, used to create instances from the device. More...

virtual const command_queue_type &	graphicsQueue () const noexcept=0
	Returns the instance of the queue, used to process draw calls. More...

virtual const command_queue_type &	transferQueue () const noexcept=0
	Returns the instance of the queue used for device-device transfers (e.g. between render-passes). More...

virtual const command_queue_type &	bufferQueue () const noexcept=0
	Returns the instance of the queue used for host-device transfers. More...

virtual const command_queue_type &	computeQueue () const noexcept=0
	Returns the instance of the queue used for compute calls. More...

virtual UniquePtr< barrier_type >	makeBarrier () const noexcept=0

Public Member Functions inherited from LiteFX::Rendering::IGraphicsDevice
virtual	~IGraphicsDevice () noexcept=default

virtual DeviceState &	state () const noexcept=0
	Returns the device state that can be used to manage resources. More...

virtual const ISurface &	surface () const noexcept=0
	Returns the surface, the device draws to. More...

virtual const IGraphicsAdapter &	adapter () const noexcept=0
	Returns the graphics adapter, the device uses for drawing. More...

virtual const ISwapChain &	swapChain () const noexcept=0
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual ISwapChain &	swapChain () noexcept=0
	Returns the swap chain, that contains the back and front buffers used for presentation. More...

virtual const IGraphicsFactory &	factory () const noexcept=0
	Returns the factory instance, used to create instances from the device. More...

virtual const ICommandQueue &	graphicsQueue () const noexcept=0
	Returns the instance of the queue, used to process draw calls. More...

virtual const ICommandQueue &	transferQueue () const noexcept=0
	Returns the instance of the queue used for device-device transfers (e.g. between render-passes). More...

virtual const ICommandQueue &	bufferQueue () const noexcept=0
	Returns the instance of the queue used for host-device transfers. More...

virtual const ICommandQueue &	computeQueue () const noexcept=0
	Returns the instance of the queue used for compute calls. More...

UniquePtr< IBarrier >	makeBarrier () const noexcept
	Creates a memory barrier instance. More...

virtual MultiSamplingLevel	maximumMultiSamplingLevel (const Format &format) const noexcept=0
	Queries the device for the maximum supported number of multi-sampling levels. More...

virtual void	wait () const =0
	Waits until the device is idle. More...

Public Member Functions inherited from LiteFX::Resource< THandle >
	Resource (const Resource &)=delete

	Resource (Resource &&)=delete

virtual	~Resource () noexcept=default

const THandle &	handle () const noexcept override
	Returns the resource managed by the class. More...

Public Member Functions inherited from LiteFX::IResource< THandle >
virtual	~IResource () noexcept=default

virtual const THandle &	handle () const noexcept=0
	Returns the resource managed by the class. More...

Additional Inherited Members
Public Types inherited from LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >
using	surface_type = DirectX12Surface

using	adapter_type = DirectX12GraphicsAdapter

using	swap_chain_type = DirectX12SwapChain

using	command_queue_type = DirectX12Queue

using	command_buffer_type = command_queue_type::command_buffer_type

using	factory_type = DirectX12GraphicsFactory

using	barrier_type = DirectX12Barrier

using	descriptor_layout_type = factory_type::descriptor_layout_type

using	vertex_buffer_type = factory_type::vertex_buffer_type

using	index_buffer_type = factory_type::index_buffer_type

using	buffer_type = factory_type::buffer_type

using	image_type = factory_type::image_type

using	sampler_type = factory_type::sampler_type

using	render_pass_type = DirectX12RenderPass

using	frame_buffer_type = render_pass_type::frame_buffer_type

using	render_pipeline_type = render_pass_type::render_pipeline_type

using	compute_pipeline_type = DirectX12ComputePipeline

using	pipeline_layout_type = render_pipeline_type::pipeline_layout_type

using	shader_program_type = render_pipeline_type::shader_program_type

using	shader_program_type = render_pipeline_type::shader_program_type

using	input_assembler_type = render_pipeline_type::input_assembler_type

using	rasterizer_type = render_pipeline_type::rasterizer_type

Protected Member Functions inherited from LiteFX::Resource< THandle >
	Resource (const THandle handle) noexcept
	Initializes the managed resource. More...

THandle &	handle () noexcept override
	Returns the resource managed by the class. More...

virtual THandle &	handle () noexcept=0
	Returns the resource managed by the class. More...

Detailed Description

Implements a DirectX 12 graphics device.

Constructor & Destructor Documentation

◆ DirectX12Device() [1/4]

DirectX12Device::DirectX12Device	(	const DirectX12Backend &	backend,
		const DirectX12GraphicsAdapter &	adapter,
		UniquePtr< DirectX12Surface > &&	surface
	)

explicit

Creates a new device instance.

Parameters

backend	The backend from which the device got created.
adapter	The adapter the device uses for drawing.
surface	The surface, the device should draw to.

◆ DirectX12Device() [2/4]

DirectX12Device::DirectX12Device	(	const DirectX12Backend &	backend,
		const DirectX12GraphicsAdapter &	adapter,
		UniquePtr< DirectX12Surface > &&	surface,
		const Format &	format,
		const Size2d &	frameBufferSize,
		const UInt32 &	frameBuffers,
		const UInt32 &	globalBufferHeapSize = `524287`,
		const UInt32 &	globalSamplerHeapSize = `2048`
	)

explicit

Creates a new device instance.

Parameters

backend	The backend from which the device got created.
adapter	The adapter the device uses for drawing.
surface	The surface, the device should draw to.
format	The initial surface format, device uses for drawing.
frameBufferSize	The initial size of the frame buffers.
frameBuffers	The initial number of frame buffers.
globalBufferHeapSize	The size of the global heap for constant buffers, shader resources and images.
globalSamplerHeapSize	The size of the global heap for samplers.

◆ DirectX12Device() [3/4]

LiteFX::Rendering::Backends::DirectX12Device::DirectX12Device ( const DirectX12Device & )

delete

◆ DirectX12Device() [4/4]

LiteFX::Rendering::Backends::DirectX12Device::DirectX12Device ( DirectX12Device && )

delete

◆ ~DirectX12Device()

DirectX12Device::~DirectX12Device ( )

virtualdefaultnoexcept

Member Function Documentation

◆ adapter()

const DirectX12GraphicsAdapter & DirectX12Device::adapter ( ) const

overridevirtualnoexcept

Returns the graphics adapter, the device uses for drawing.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ allocateGlobalDescriptors()

void DirectX12Device::allocateGlobalDescriptors	(	const DirectX12DescriptorSet &	descriptorSet,
		UInt32 &	bufferOffset,
		UInt32 &	samplerOffset
	)		const

virtual

Allocates a range of descriptors in the global descriptor heaps for the provided descriptorSet .

Parameters

descriptorSet	The descriptor set containing the descriptors to update.
bufferOffset	The offset of the descriptor range in the buffer heap.
samplerOffset	The offset of the descriptor range in the sampler heap.

◆ backend()

const DirectX12Backend & DirectX12Device::backend ( ) const

virtualnoexcept

Returns the backend from which the device got created.

Returns: The backend from which the device got created.

◆ bindDescriptorSet()

void DirectX12Device::bindDescriptorSet	(	const DirectX12CommandBuffer &	commandBuffer,
		const DirectX12DescriptorSet &	descriptorSet,
		const DirectX12PipelineState &	pipeline
	)		const

virtualnoexcept

Binds the descriptors of the descriptor set to the global descriptor heaps.

Note that after binding the descriptor set, the descriptors must not be updated anymore, unless they are elements on unbounded descriptor arrays, in which case you have to ensure manually to not update them, as long as they may still be in use!

Parameters

commandBuffer	The command buffer to bind the descriptor set on.
descriptorSet	The descriptor set to bind.
pipeline	The pipeline to bind the descriptor set to.

◆ bindGlobalDescriptorHeaps()

void DirectX12Device::bindGlobalDescriptorHeaps ( const DirectX12CommandBuffer & commandBuffer ) const

virtualnoexcept

Binds the global descriptor heap.

Parameters

commandBuffer The command buffer to issue the bind command on.

◆ blitPipeline()

DirectX12ComputePipeline & DirectX12Device::blitPipeline ( ) const

virtualnoexcept

Returns the compute pipeline that can be invoked to blit an image resource.

Blitting is used by DirectX12Texture to generate mip maps.

Returns: The compute pipeline that can be invoked to blit an image resource.

See also: DirectX12Texture::generateMipMaps

◆ bufferQueue()

const DirectX12Queue & DirectX12Device::bufferQueue ( ) const

overridevirtualnoexcept

Returns the instance of the queue used for host-device transfers.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ computeQueue()

const DirectX12Queue & DirectX12Device::computeQueue ( ) const

overridevirtualnoexcept

Returns the instance of the queue used for compute calls.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ factory()

const DirectX12GraphicsFactory & DirectX12Device::factory ( ) const

overridevirtualnoexcept

Returns the factory instance, used to create instances from the device.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ globalBufferHeap()

const ID3D12DescriptorHeap * DirectX12Device::globalBufferHeap ( ) const

virtualnoexcept

Returns the global descriptor heap.

The DirectX 12 device uses a global heap of descriptors and samplers in a ring-buffer fashion. The heap itself is managed by the device.

Returns: A pointer to the global descriptor heap.

◆ globalSamplerHeap()

const ID3D12DescriptorHeap * DirectX12Device::globalSamplerHeap ( ) const

virtualnoexcept

Returns the global sampler heap.

Returns: A pointer to the global sampler heap.

See also: globalBufferHeap

◆ graphicsQueue()

const DirectX12Queue & DirectX12Device::graphicsQueue ( ) const

overridevirtualnoexcept

Returns the instance of the queue, used to process draw calls.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ makeBarrier()

UniquePtr< DirectX12Barrier > DirectX12Device::makeBarrier ( ) const

overridevirtualnoexcept

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ maximumMultiSamplingLevel()

MultiSamplingLevel DirectX12Device::maximumMultiSamplingLevel ( const Format & format ) const

overridevirtualnoexcept

Queries the device for the maximum supported number of multi-sampling levels.

Implements LiteFX::Rendering::IGraphicsDevice.

◆ releaseGlobalDescriptors()

void DirectX12Device::releaseGlobalDescriptors ( const DirectX12DescriptorSet & descriptorSet ) const

virtualnoexcept

Releases a range of descriptors from the global descriptor heaps.

This is done, if a descriptor set layout is destroyed, of a descriptor set, which contains an unbounded array is freed. It will cause the global descriptor heaps to fragment, which may result in inefficient future descriptor allocations and should be avoided. Consider caching descriptor sets with unbounded arrays instead. Also avoid relying on creating and releasing pipeline layouts during runtime. Instead, it may be more efficient to write shaders that support multiple pipeline variations, that can be kept alive for the lifetime of the whole application.

◆ state()

DeviceState & DirectX12Device::state ( ) const

overridevirtualnoexcept

Returns the device state that can be used to manage resources.

Implements LiteFX::Rendering::IGraphicsDevice.

◆ surface()

const DirectX12Surface & DirectX12Device::surface ( ) const

overridevirtualnoexcept

Returns the surface, the device draws to.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ swapChain() [1/2]

const DirectX12SwapChain & DirectX12Device::swapChain ( ) const

overridevirtualnoexcept

Returns the swap chain, that contains the back and front buffers used for presentation.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ swapChain() [2/2]

DirectX12SwapChain & DirectX12Device::swapChain ( )

overridevirtualnoexcept

Returns the swap chain, that contains the back and front buffers used for presentation.

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ transferQueue()

const DirectX12Queue & DirectX12Device::transferQueue ( ) const

overridevirtualnoexcept

Returns the instance of the queue used for device-device transfers (e.g. between render-passes).

Implements LiteFX::Rendering::GraphicsDevice< DirectX12GraphicsFactory, DirectX12Surface, DirectX12GraphicsAdapter, DirectX12SwapChain, DirectX12Queue, DirectX12RenderPass, DirectX12ComputePipeline, DirectX12Barrier >.

◆ updateBufferDescriptors()

void DirectX12Device::updateBufferDescriptors	(	const DirectX12DescriptorSet &	descriptorSet,
		const UInt32 &	firstDescriptor,
		const UInt32 &	descriptors
	)		const

virtualnoexcept

Updates a range of descriptors in the global buffer descriptor heap with the descriptors from descriptorSet .

Parameters

descriptorSet	The descriptor set to copy the descriptors from.
firstDescriptor	The index of the first descriptor to copy.
descriptors	The number of descriptors to copy.

◆ updateSamplerDescriptors()

void DirectX12Device::updateSamplerDescriptors	(	const DirectX12DescriptorSet &	descriptorSet,
		const UInt32 &	firstDescriptor,
		const UInt32 &	descriptors
	)		const

virtualnoexcept

Updates a sampler descriptors in the global buffer descriptor heap with a descriptor from descriptorSet .

Parameters

descriptorSet	The descriptor set to copy the descriptors from.
firstDescriptor	The index of the first descriptor to copy.
descriptors	The number of descriptors to copy.

◆ wait()

void DirectX12Device::wait ( ) const

overridevirtual

Waits until the device is idle.

Implements LiteFX::Rendering::IGraphicsDevice.

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirectX12Device() [1/4]

◆ DirectX12Device() [2/4]

◆ DirectX12Device() [3/4]

◆ DirectX12Device() [4/4]

◆ ~DirectX12Device()

Member Function Documentation

◆ adapter()

◆ allocateGlobalDescriptors()

◆ backend()

◆ bindDescriptorSet()

◆ bindGlobalDescriptorHeaps()

◆ blitPipeline()

◆ bufferQueue()

◆ computeQueue()

◆ factory()

◆ globalBufferHeap()

◆ globalSamplerHeap()

◆ graphicsQueue()

◆ makeBarrier()

◆ maximumMultiSamplingLevel()

◆ releaseGlobalDescriptors()

◆ state()

◆ surface()

◆ swapChain() [1/2]

◆ swapChain() [2/2]

◆ transferQueue()

◆ updateBufferDescriptors()

◆ updateSamplerDescriptors()

◆ wait()