ngf::render_encoder Class Reference

Public Member Functions
	render_encoder (ngf_cmd_buffer cmd_buf, const ngf_render_pass_info &pass_info)
	render_encoder (ngf_cmd_buffer cmd_buf, ngf_render_target rt, float clear_color_r, float clear_color_g, float clear_color_b, float clear_color_a, float clear_depth, uint32_t clear_stencil)
	~render_encoder ()
	render_encoder (render_encoder &&other) noexcept
render_encoder &	operator= (render_encoder &&other) noexcept
	render_encoder (const render_encoder &)=delete
render_encoder &	operator= (const render_encoder &)=delete
	operator ngf_render_encoder ()

Detailed Description

Wraps a render encoder with unique ownership semantics.

Constructor & Destructor Documentation

render_encoder() [1/2]

ngf::render_encoder::render_encoder ( ngf_cmd_buffer cmd_buf, const ngf_render_pass_info & pass_info )

inlineexplicit

Creates a new render encoder for the given command buffer. Has the same semantics as ngf_cmd_begin_render_pass.

Parameters

cmd_buf	The command buffer to create a new render encoder for.
pass_info	Render pass description.

render_encoder() [2/2]

ngf::render_encoder::render_encoder ( ngf_cmd_buffer cmd_buf, ngf_render_target rt, float clear_color_r, float clear_color_g, float clear_color_b, float clear_color_a, float clear_depth, uint32_t clear_stencil )

inlineexplicit

Creates a new render encoder for the given command buffer. Has the same semantics as ngf_cmd_begin_render_pass_simple.

Parameters

cmd_buf	The command buffer to create a new render encoder for.
rt	The render target to render into.
clear_color_r	A floating point number between 0.0 and 1.0 specifying the red component of the clear color.
clear_color_g	A floating point number between 0.0 and 1.0 specifying the green component of the clear color.
clear_color_b	A floating point number between 0.0 and 1.0 specifying the blue component of the clear color.
clear_color_a	A floating point number between 0.0 and 1.0 specifying the alpha component of the clear color.
clear_depth	A floating point value to clear the depth attachment to (if the associated render target has one).
clear_stencil	An integer value to clear the stencil buffer to (if the assocuated render taget has one).

~render_encoder()

ngf::render_encoder::~render_encoder ( )

inline

Finishes the wrapped render pass.

Member Function Documentation

operator ngf_render_encoder()

ngf::render_encoder::operator ngf_render_encoder ( )

inline

Implicit conversion to ngf_render_encoder.