LiteFX::Rendering::IFrameBuffer::addImage¶
addImage overloads
Synopses¶
Declared in <litefx/rendering_api.hpp>
Adds an image to the frame buffer.
[[dllimport, dllexport]] void addImage(
Format format,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Adds an image for a render target to the frame buffer.
[[dllimport, dllexport]] void addImage(
RenderTarget const& renderTarget,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Adds an image to the frame buffer.
[[dllimport, dllexport]] virtual void addImage(
String const& name,
Format format,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage) = 0;
Adds an image for a render target to the frame buffer.
[[dllimport, dllexport]] virtual void addImage(
String const& name,
RenderTarget const& renderTarget,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage) = 0;
Adds an image to the frame buffer.
template<typename TSelf>
TSelf&& addImage(this
TSelf&& self,
Format format,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Adds an image for a render target to the frame buffer.
template<typename TSelf>
TSelf&& addImage(this
TSelf&& self,
RenderTarget const& renderTarget,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Adds an image to the frame buffer.
template<typename TSelf>
TSelf&& addImage(this
TSelf&& self,
StringView name,
Format format,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Adds an image for a render target to the frame buffer.
template<typename TSelf>
TSelf&& addImage(this
TSelf&& self,
StringView name,
RenderTarget const& renderTarget,
MultiSamplingLevel samples = MultiSamplingLevel::x1,
ResourceUsage usage = ResourceUsage::FrameBufferImage);
Exceptions¶
| Name | Thrown on |
|---|---|
InvalidArgumentException | Thrown, if another image with the same name as provided in name has already been added to the frame buffer. |
Parameters¶
| Name | Description |
|---|---|
| format | The format of the image. |
| samples | The number of samples of the image. |
| usage | The desired resource usage flags for the image. |
| renderTarget | The render target for which to add an image. |
| name | The name of the image. |