Skip to content

LiteFX

LiteFX::Rendering::RenderPassBuilder

`LiteFX::Rendering::RenderPassBuilder`¶

Describes the interface of a render pass builder.

Synopsis¶

Declared in <litefx/rendering_builders.hpp>

template<typename TRenderPass>
requires meta::implements<TRenderPass, RenderPass<typename TRenderPass::command_queue_type, typename TRenderPass::frame_buffer_type>>
class RenderPassBuilder
    : public Builder<TRenderPass, std::nullptr_t, SharedPtr<TRenderPass>>

Base Classes¶

Name	Description
`Builder<TRenderPass, std::nullptr_t, SharedPtr<TRenderPass>>`	Describes an generic builder type.

Type Aliases¶

Name
`command_queue_type`
`instance_type`
`parent_type`
`pointer_type`
`render_pass_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.
`commandBuffers`	Sets the number of command buffers allocated by the render pass.
`executeOn`	Sets the command queue, the render pass will execute on.
`inputAttachment`	Adds an input attachment to the render pass.
`inputAttachmentSamplerBinding`	`inputAttachmentSamplerBinding` overloads
`instance`	Returns a pointer to the current instance of the object that is built by the builder.
`parent`	Returns a reference of the parent builder.
`renderTarget`	`renderTarget` overloads
`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.
`makeInputAttachment` [virtual]	Creates a new input attachment mapping between a render target of a specified render pass and an input location of the render pass that is currently built.
`state`	Returns the current render pass state.

Template Parameters¶

Name	Description
TDerived	The type of the implementation of the builder.
TRenderPass	The type of the render pass. Must implement `RenderPass`.

Derived Classes¶

Name	Description
`DirectX12RenderPassBuilder`	Implements the DirectX 12 `RenderPassBuilder`.
`VulkanRenderPassBuilder`	Implements the Vulkan `RenderPassBuilder`.

See Also¶

RenderPass