LiteFX::Rendering::IRenderPass

The interface for a render pass.

Synopsis

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] IRenderPass
    : public virtual IStateResource
    , public SharedObject

Base Classes

Name	Description
IStateResource	The interface for a state resource.
SharedObject	Base class for an object that can be shared.

Types

Name	Description
BeginEventArgs	Event arguments that are published to subscribers when a render pass is beginning.

Type Aliases

Name
_Esft_type

Member Functions

Name	Description
~IRenderPass [destructor] [virtual]	Destructor
activeFrameBuffer	Returns the current frame buffer from of the render pass.
begin	Begins the render pass.
commandBuffer	Returns a command buffer that can be currently used for recording multi-threaded commands in the render pass.
commandBuffers	Returns all command buffers, that can be currently used for recording multi-threaded commands in the render pass.
commandQueue	Returns the command queue, the render pass is executing on or nullptr, if the queue has already been released.
end [virtual]	Ends the render pass.
hasPresentTarget [virtual]	Returns true, if one of the render targets is used for presentation on a swap chain.
inputAttachment [virtual]	Returns the input attachment at a location.
inputAttachmentSamplerBinding [virtual]	Returns the binding point for input attachment samplers.
inputAttachments [virtual]	Returns the input attachment the render pass is consuming.
name [virtual]	Returns the name of the resource.
renderTarget [virtual]	Returns the render target mapped to the location provided by location.
renderTargets [virtual]	Returns the list of render targets, the render pass renders into.
secondaryCommandBuffers [virtual]	Returns the number of secondary command buffers the render pass stores for multi-threaded command recording.
shared_from_this	Returns a shared pointer to the current object instance.
viewMask [virtual]	Returns the mask that identifies the views that are enabled during rendering.
weak_from_this	Returns a weak pointer to the current object instance.

Data Members

Name	Description
beginning	Invoked, when the render pass is beginning.
ending	Invoked, when the render pass is ending.

Protected Types

Name	Description
Allocator	An allocator used to allocate the shared object.

Protected Member Functions

Name	Description
IRenderPass [constructor]	Constructors
operator=	Assignment operators

Protected Static Member Functions

Name	Description
create	Generic factory method used to create instances of the shared object.

Derived Classes

Name	Description
RenderPass	Represents a render pass.
RenderPass	Represents a render pass.