LiteFX::Rendering::IFrameBuffer::mapRenderTarget¶
Maps a render target to a frame buffer image using the render targets name to look up the image.
Synopsis¶
Declared in <litefx/rendering_api.hpp>
[[dllimport, dllexport]] void mapRenderTarget(RenderTarget const& renderTarget);
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 same name as the render target. |
Parameters¶
| Name | Description |
|---|---|
| renderTarget | The render target to map the image to. |
See Also¶
unmapRenderTarget