Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanDevice

`LiteFX::Rendering::Backends::VulkanDevice`¶

Implements a Vulkan graphics device.

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

class [[dllimport, dllexport]] VulkanDevice final
    : public GraphicsDevice<VulkanGraphicsFactory, VulkanSurface, VulkanGraphicsAdapter, VulkanSwapChain, VulkanQueue, VulkanRenderPass, VulkanDescriptorRange, VulkanRenderPipeline, VulkanComputePipeline, VulkanRayTracingPipeline, VulkanBarrier>
    , public Resource<VkDevice>

Base Classes¶

Name	Description
`GraphicsDevice<VulkanGraphicsFactory, VulkanSurface, VulkanGraphicsAdapter, VulkanSwapChain, VulkanQueue, VulkanRenderPass, VulkanDescriptorRange, VulkanRenderPipeline, VulkanComputePipeline, VulkanRayTracingPipeline, VulkanBarrier>`	Represents the graphics device that a rendering back-end is doing work on.
`Resource<VkDevice>`	Implements the `IResource` interface.

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
`~VulkanDevice` [destructor] [virtual]	Destructor
`adapter` [virtual]	Returns the graphics adapter, the device uses for drawing.
`allocateGlobalDescriptors`	`allocateGlobalDescriptors` overloads
`bindDescriptorSet`	Binds the descriptors of the descriptor set to the global descriptor heaps.
`bindGlobalDescriptorHeaps`	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`	Returns a builder for a `RayTracingPipeline`.
`buildRenderPass`	Returns a builder for a `RenderPass`.
`buildRenderPipeline`	Returns a builder for a `RenderPipeline`.
`buildShaderProgram` [virtual]	Returns a builder for a `ShaderProgram`.
`computeAccelerationStructureSizes`	`computeAccelerationStructureSizes` overloads
`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.
`descriptorSize`	Resolves the binary size for a descriptor of `type.`
`descriptorStride`	Returns the width required for a descriptor on `heapType.`
`enabledExtensions`	Returns the array that stores the extensions that were used to initialize the device.
`factory` [virtual]	Returns the factory instance, used to create instances from the device.
`handle` [virtual]	Returns the resource managed by the class.
`makeBarrier` [virtual]	Creates a memory barrier instance.
`makeFrameBuffer`	Creates a new frame buffer instance.
`maxPushDataSize`	Returns the maximum push data size supported by the device.
`maximumMultiSamplingLevel` [virtual]	Queries the device for the maximum supported number of multi-sampling levels.
`queueFamilyIndices`	Returns the indices of all queue families with support for `type.`
`setDebugName`	Sets the debug name for an object.
`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`	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.
`writeGlobalDescriptorHeap`	Writes host descriptor data into the global `heapType` heap, starting at `targetIndex.`

Static Member Functions¶

Name	Description
`create`	Initializes the device instance.

Static Data Members¶

Name	Description
`DEFAULT_RESOURCE_HEAP_SIZE`	The default size for the global resource descriptor heap. Matches the required maximum in D3D12.
`DEFAULT_SAMPLER_HEAP_SIZE`	The default size for the global sampler descriptor heap. Matches the required maximum in D3D12.

Protected Member Functions¶

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

Friends¶

Name	Description
`LiteFX::Rendering::Backends::VulkanSwapChain`	Implements a Vulkan swap chain.
`LiteFX::Rendering::Backends::VulkanQueue`	Implements a Vulkan command queue.
`LiteFX::Rendering::Backends::VulkanDescriptorRange`	Implements a Vulkan `IDescriptorRange`.
`LiteFX::Rendering::Backends::VulkanDescriptorSet`	Implements a Vulkan `DescriptorSet`.
`LiteFX::Rendering::Backends::VulkanBackend`	Defines a rendering backend that creates a Vulkan device.
`LiteFX::SharedObject::Allocator`	An allocator used to allocate the shared object.
`LiteFX::Rendering::Backends::VulkanDevice::VulkanDeviceImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.