Skip to content

LiteFX

LiteFX::Rendering::IRenderTarget

`LiteFX::Rendering::IRenderTarget`¶

Represents a render target, i.e. an abstract view of the output of an RenderPass.

Synopsis¶

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] IRenderTarget;

Description¶

A render target represents one output of a render pass, stored within an IImage. It is contained by a RenderPass, that maps it to an image resource on the FrameBuffer the render pass operates on. The IRenderTarget::identifier is used to associate an image within a frame buffer to a render target.

When using a IRenderPipeline during rendering, a similar lookup is performed to bind frame buffer images to input attachments.

Types¶

Name	Description
`BlendState`	Describes the blend state of the render target.

Member Functions¶

Name	Description
`~IRenderTarget` [destructor] [virtual]	Destructor
`blendState` [virtual]	Returns the render targets blend state.
`clearBuffer` [virtual]	Returns `true`, if the render target should be cleared, when the render pass is started. If the `format` is set to a depth format, this clears the depth buffer. Otherwise it clears the color buffer.
`clearStencil` [virtual]	Returns `true`, if the render target stencil should be cleared, when the render pass is started. If the `format` is does not contain a stencil channel, this has no effect.
`clearValues` [virtual]	Returns the value, the render target is cleared with, if `clearBuffer` either or `clearStencil` is specified.
`flags` [virtual]	Returns the flags that control the behavior of the render target.
`format` [virtual]	Returns the internal format of the render target.
`identifier` [virtual]	A unique identifier for the render target.
`isVolatile` [virtual]	Returns `true`, if the target should not be made persistent for access after the render pass has finished.
`location` [virtual]	Returns the location of the render target output attachment within the fragment shader.
`name` [virtual]	Returns the name of the render target.
`type` [virtual]	Returns the type of the render target.

Protected Member Functions¶

Name	Description
`IRenderTarget` [constructor]	Constructors
`operator=`	Assignment operators

Derived Classes¶

Name	Description
`RenderTarget`	Implements a render target.

See Also¶

RenderTarget

RenderPass

FrameBuffer

IImage