Skip to content

LiteFX::Rendering::RenderTarget

Implements a render target.

Synopsis

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] RenderTarget
    : public IRenderTarget

Description

IRenderTarget

Base Classes

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

Types

NameDescription
BlendState Describes the blend state of the render target.

Member Functions

NameDescription
RenderTarget [constructor]Constructors
~RenderTarget [destructor] [virtual]Releases the render target instance.
operator= Assignment operators
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

NameDescription
operator= Assignment operators

Friends

NameDescription
LiteFX::Rendering::RenderTarget::RenderTargetImpl
LiteFX::PimplPtrA smart pointer that manages an implementation instance for a public interface class.