LiteFX::Rendering::IFrameBuffer::image¶
image overloads
Synopses¶
Declared in <litefx/rendering_api.hpp>
Resolves a render target name and returns the image mapped to it.
[[dllimport, dllexport]] virtual IImage const& image(StringView renderTargetName) const = 0;
Returns an image from the frame buffer.
[[dllimport, dllexport]] virtual IImage const& image(UInt32 index) const = 0;
Resolves a render target and returns the image mapped to it.
[[dllimport, dllexport]] virtual IImage const& image(RenderTarget const& renderTarget) const = 0;
Exceptions¶
| Name | Thrown on |
|---|---|
InvalidArgumentException | Thrown, if renderTargetName is not mapped to an image in the frame buffer. |
ArgumentOutOfRangeException | Thrown, 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¶
| Name | Description |
|---|---|
| renderTargetName | The render target name to resolve. |
| index | The index of the image. |
| renderTarget | The render target to resolve. |