LiteFX::Rendering::GraphicsDevice::makeFrameBuffer

Creates a new frame buffer instance.

Synopses

Declared in <litefx/rendering.hpp>

Creates a new frame buffer instance.

[[nodiscard]] SharedPtr<frame_buffer_type> makeFrameBuffer(Size2d const& renderArea) const;

» more...

Creates a new frame buffer instance.

[[nodiscard]] virtual SharedPtr<frame_buffer_type> makeFrameBuffer(
    StringView name,
    Size2d const& renderArea) const = 0;

» more...

Creates a new frame buffer instance.

[[nodiscard]] SharedPtr<frame_buffer_type> makeFrameBuffer(
    Size2d const& renderArea,
    frame_buffer_type::allocation_callback_type allocationCallback) const;

» more...

Creates a new frame buffer instance.

[[nodiscard]] virtual SharedPtr<frame_buffer_type> makeFrameBuffer(
    StringView name,
    Size2d const& renderArea,
    frame_buffer_type::allocation_callback_type allocationCallback) const = 0;

» more...

Return Value

The instance of the frame buffer.

Note

The return value should not be discarded.

Parameters

Name	Description
renderArea	The initial render area of the frame buffer.
name	The name of the frame buffer.
allocationCallback	A callback that gets invoked, when the frame buffer allocates a new image.