Skip to content

LiteFX::Rendering::IFrameBuffer::operator[]

Subscript operators

Synopses

Declared in <litefx/rendering_api.hpp>

Resolves a render target name and returns the image mapped to it.

[[dllimport, dllexport]] virtual IImage const& operator[](StringView renderTargetName) const = 0;

» more...

Returns an image from the frame buffer.

[[dllimport, dllexport]] virtual IImage const& operator[](UInt32 index) const = 0;

» more...

Resolves a render target and returns the image mapped to it.

[[dllimport, dllexport]] virtual IImage const& operator[](RenderTarget const& renderTarget) const = 0;

» more...

Exceptions

NameThrown on
InvalidArgumentExceptionThrown, if renderTargetName is not mapped to an image in the frame buffer.
ArgumentOutOfRangeExceptionThrown, if the index does not address an image in the frame buffer.

Return Value

  • The image mapped to the render target.
  • The image from the frame buffer with the index index.

Parameters

NameDescription
renderTargetNameThe render target name to resolve.
indexThe index of the image.
renderTargetThe render target to resolve.