Skip to content

LiteFX::Rendering::IFrameBuffer::mapRenderTarget

mapRenderTarget overloads

Synopses

Declared in <litefx/rendering_api.hpp>

Maps a render target to a frame buffer image using the render targets name to look up the image.

[[dllimport, dllexport]] void mapRenderTarget(RenderTarget const& renderTarget);

» more...

Maps a render target to a frame buffer image.

[[dllimport, dllexport]] virtual void mapRenderTarget(
    RenderTarget const& renderTarget,
    StringView imageName) = 0;

» more...

Maps a render target to a frame buffer image.

[[dllimport, dllexport]] virtual void mapRenderTarget(
    RenderTarget const& renderTarget,
    UInt32 index) = 0;

» more...

Exceptions

NameThrown on
InvalidArgumentExceptionThrown, if the frame buffer does not contain an image with the same name as the render target.
ArgumentOutOfRangeExceptionThrown, if index does not address an image in the frame buffer.

Parameters

NameDescription
renderTargetThe render target to map the image to.
imageNameThe name of the image the render target maps to.
indexThe index of the image to map to the render target.

See Also

unmapRenderTarget