LiteFX::Rendering::BarrierBuilder

Base class for a builder that builds a Barrier.

Synopsis

Declared in <litefx/rendering_builders.hpp>

template<typename TBarrier>
requires meta::implements<TBarrier, Barrier<typename TBarrier::buffer_type, typename TBarrier::image_type>>
class BarrierBuilder
    : public Builder<TBarrier>

Base Classes

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

Types

Name	Description
BufferBarrierBuilder	A builder that sets up a resource barrier for a specific buffer.
BufferBarrierBuilder	A builder that sets up a resource barrier for a specific buffer.
GlobalBarrierBuilder	A builder that sets up a global resource barrier.
GlobalBarrierBuilder	A builder that sets up a global resource barrier.
ImageBarrierBuilder	A builder that sets up a resource barrier for a specific image.
ImageBarrierBuilder	A builder that sets up a resource barrier for a specific image.
ImageLayoutBarrierBuilder	A builder that sets up the layout transition barrier for a set of sub-resources of a specific image.
ImageLayoutBarrierBuilder	A builder that sets up the layout transition barrier for a set of sub-resources of a specific image.
SecondStageBuilder	A builder that sets up the pipeline stages to wait for and to continue with on a barrier.
SecondStageBuilder	A builder that sets up the pipeline stages to wait for and to continue with on a barrier.

Type Aliases

Name
barrier_type
instance_type
parent_type
pointer_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.
blockAccessTo	blockAccessTo 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.
use [deleted]	Called by child builders to pass a constructed object back to the parent builder.
waitFor	Specifies the pipeline stages to wait for before executing the barrier.

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.
setupBufferBarrier [virtual]	Sets up the resource access states to wait for and to continue with for a specific buffer with the barrier to be built.
setupGlobalBarrier [virtual]	Sets up the resource access states to wait for and to continue with the barrier to be built.
setupImageBarrier [virtual]	Sets up the image layout transition and resource access states to wait for and continue with the barrier to be built.
setupStages [virtual]	Sets the pipeline stages for the built barrier to wait for and to continue with.

Template Parameters

Name	Description
TBarrier	The type of the barrier. Must implement Barrier.

Derived Classes

Name	Description
DirectX12BarrierBuilder	Builds a DirectX 12 Barrier.
VulkanBarrierBuilder	Builds a Vulkan Barrier.

See Also

Barrier

IBarrier