Skip to content

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);

» more...

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);

» more...

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;

» more...

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;

» more...

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);

» more...

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);

» more...

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);

» more...

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);

» more...

Exceptions

NameThrown on
InvalidArgumentExceptionThrown, if another image with the same name as provided in name has already been added to the frame buffer.

Parameters

NameDescription
formatThe format of the image.
samplesThe number of samples of the image.
usageThe desired resource usage flags for the image.
renderTargetThe render target for which to add an image.
nameThe name of the image.