LiteFX::Rendering::RayTracingPipelineBuilder

Describes the interface of a ray-tracing pipeline builder.

Synopsis

Declared in <litefx/rendering_builders.hpp>

template<typename TRayTracingPipeline>
requires meta::implements<TRayTracingPipeline, RayTracingPipeline<typename TRayTracingPipeline::pipeline_layout_type, typename TRayTracingPipeline::shader_program_type>>
class RayTracingPipelineBuilder
    : public Builder<TRayTracingPipeline>

Base Classes

Name	Description
Builder<TRayTracingPipeline>	Describes an generic builder type.

Type Aliases

Name
instance_type
parent_type
pipeline_layout_type
pointer_type
raytracing_pipeline_type
shader_program_type

Member Functions

Name	Description
operator=	Assignment operators
add	First, calls build, then use on the parent builder using the current object instance and finally returns the parent builder.
instance	Returns a pointer to the current instance of the object that is built by the builder.
layout	Uses the provided pipeline layout to initialize the ray-tracing pipeline. Can be invoked only once.
maxAttributeSize	Sets the maximum size for a ray attribute in the pipeline.
maxBounces	Sets the maximum number of ray bounces allowed in the pipeline.
maxPayloadSize	Sets the maximum size for a ray payload in the pipeline. Ignored Payload Access Qualifiers are used.
parent	Returns a reference of the parent builder.
use [deleted]	Called by child builders to pass a constructed object back to the parent builder.

Using Declarations

Name
Unnamed using

Protected Member Functions

Name	Description
build [virtual]	Can be overwritten to perform any pre-construction work before the builder returns the final object instance.
instance	Returns a pointer to the current instance of the object that is built by the builder.
state	Returns the current ray-tracing pipeline state.

Template Parameters

Name	Description
TRayTracingPipeline	The type of the ray-tracing pipeline. Must implement RayTracingPipeline.

Derived Classes

Name	Description
DirectX12RayTracingPipelineBuilder	Builds a DirectX 12 RayTracingPipeline.
VulkanRayTracingPipelineBuilder	Builds a Vulkan RayTracingPipeline.

See Also

RayTracingPipeline