Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanRayTracingPipeline

`LiteFX::Rendering::Backends::VulkanRayTracingPipeline`¶

Implements a Vulkan RayTracingPipeline.

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

class [[dllimport, dllexport]] VulkanRayTracingPipeline final
    : public virtual VulkanPipelineState
    , public RayTracingPipeline<VulkanPipelineLayout, VulkanShaderProgram>

Base Classes¶

Name	Description
`VulkanPipelineState`	Defines the base class for Vulkan pipeline state objects.
`RayTracingPipeline<VulkanPipelineLayout, VulkanShaderProgram>`	Represents a ray-tracing `Pipeline`.

Type Aliases¶

Name
`base_type`
`buffer_type`
`builder_type`
`descriptor_layout_type`
`descriptor_set_layout_type`
`descriptor_set_type`
`handle_type`
`image_type`
`pipeline_layout_type`
`sampler_type`
`shader_program_type`

Member Functions¶

Name	Description
`VulkanRayTracingPipeline` [constructor]	Initializes a new Vulkan ray-tracing pipeline.
`~VulkanRayTracingPipeline` [destructor] [virtual]	Destructor
`operator=`	Assignment operators
`allocateShaderBindingTable` [virtual]	Allocates a buffer that contains the shader binding table containing the shader groups specified by the `groups` parameter.
`handle` [virtual]	Returns the resource managed by the class.
`layout` [virtual]	Returns the layout of the render pipeline.
`maxAttributeSize` [virtual]	Returns the maximum size of a single ray attribute.
`maxPayloadSize` [virtual]	Returns the maximum size of a single ray payload.
`maxRecursionDepth` [virtual]	Returns the maximum number of ray bounces.
`pipelineType` [virtual]	Returns the type of the pipeline.
`program` [virtual]	Returns the shader program used by the pipeline.
`shaderRecords` [virtual]	Returns the shader record collection of the ray tracing pipeline.
`use` [virtual]	Sets the current pipeline state on the `commandBuffer.`

Protected Member Functions¶

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

Protected Using Declarations¶

Name
`VulkanPipelineState`

Friends¶

Name	Description
`LiteFX::Rendering::Backends::VulkanRayTracingPipelineBuilder`	Builds a Vulkan `RayTracingPipeline`.
`LiteFX::Rendering::Backends::VulkanRayTracingPipeline::VulkanRayTracingPipelineImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.

See Also¶

VulkanRenderPipeline

VulkanRayTracingPipelineBuilder