Skip to content

LiteFX::Rendering::RenderPass::begin

begin overloads

Synopses

Declared in <litefx/rendering.hpp>

Begins the render pass.

[[dllimport, dllexport]] void begin(IFrameBuffer const& frameBuffer) const;

» more...

Begins the render pass.

virtual void begin(frame_buffer_type const& frameBuffer) const = 0;

» more...

Begins the render pass by recording into the external primary command buffer provided by commandBuffer.

[[dllimport, dllexport]] void begin(
    IFrameBuffer const& frameBuffer,
    ICommandBuffer const& commandBuffer) const;

» more...

Begins the render pass by recording into the external primary command buffer provided by commandBuffer.

virtual void begin(
    frame_buffer_type const& frameBuffer,
    command_buffer_type const& commandBuffer) const = 0;

» more...

Exceptions

NameThrown on
InvalidArgumentExceptionThrown, if commandBuffer is not a recording primary command buffer of the render pass queue.

Parameters

NameDescription
frameBufferThe frame buffer to obtain input attachments and render targets from.
commandBufferThe primary command buffer to record the render pass into.