LiteFX::Rendering::IFrameBuffer::mapRenderTarget

Maps a render target to a frame buffer image.

Synopsis

Declared in <litefx/rendering_api.hpp>

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

Description

When calling IRenderPass::begin, passing a frame buffer, the render pass attempts to resolve all render target images. In order for this resolution to be successful, a mapping first needs to be established between the render target and the image. This method establishes this mapping.

Calling this method multiple times will overwrite the mapped index.

Exceptions

Name	Thrown on
InvalidArgumentException	Thrown, if the frame buffer does not contain an image with the name specified in imageName.

Parameters

Name	Description
renderTarget	The render target to map the image to.
imageName	The name of the image the render target maps to.

See Also

unmapRenderTarget