#include <ssr_pass.h>

Classes
struct	fidelityfx_ssr_settings
	FidelityFX SSR settings. More...

struct	run_params

struct	ssr_settings
	Combined SSR settings. More...

Public Member Functions
auto	init (rtti::context &ctx) -> bool
	Must be called once (after bgfx::init() and after `asset_manager` is registered in context).

auto	run (gfx::render_view &rview, const run_params &params) -> gfx::frame_buffer::ptr
	Executes the SSR pass. Returns the actual output framebuffer.

auto	run_fidelityfx (gfx::render_view &rview, const run_params &params) -> gfx::frame_buffer::ptr
	Executes the FidelityFX SSR pass. Returns the actual output framebuffer.

auto	run_fidelityfx_three_pass (gfx::render_view &rview, const run_params &params) -> gfx::frame_buffer::ptr
	Executes the three-pass SSR pipeline (trace, temporal resolve, composite)

auto	run_ssr_trace (gfx::render_view &rview, const run_params &params) -> gfx::frame_buffer::ptr
	Executes the SSR trace pass only. Returns SSR current frame buffer.

auto	run_temporal_resolve (gfx::render_view &rview, const gfx::frame_buffer::ptr &ssr_curr, const gfx::frame_buffer::ptr &g_buffer, const camera *cam, const fidelityfx_ssr_settings &settings) -> gfx::frame_buffer::ptr
	Executes the temporal resolve pass. Returns updated SSR history buffer.

auto	run_composite (gfx::render_view &rview, const gfx::frame_buffer::ptr &ssr_history, const gfx::frame_buffer::ptr &ssr_curr, const gfx::frame_buffer::ptr &probe_buffer, const gfx::frame_buffer::ptr &g_buffer, const gfx::frame_buffer::ptr &output) -> gfx::frame_buffer::ptr
	Executes the composite pass. Returns final blended output.

auto	generate_blurred_color_buffer (gfx::render_view &rview, const gfx::texture::ptr &input_color, const gfx::frame_buffer::ptr &g_buffer, const fidelityfx_ssr_settings &settings) -> gfx::texture::ptr
	Generates blurred color buffer with mip chain for cone tracing.

Detailed Description

Definition at line 14 of file ssr_pass.h.

Member Function Documentation

◆ generate_blurred_color_buffer()

auto unravel::ssr_pass::generate_blurred_color_buffer	(	gfx::render_view &	rview,
		const gfx::texture::ptr &	input_color,
		const gfx::frame_buffer::ptr &	g_buffer,
		const fidelityfx_ssr_settings &	settings ) -> gfx::texture::ptr

Generates blurred color buffer with mip chain for cone tracing.

Definition at line 226 of file ssr_pass.cpp.

◆ init()

auto unravel::ssr_pass::init ( rtti::context & ctx ) -> bool

Must be called once (after bgfx::init() and after asset_manager is registered in context).

Definition at line 11 of file ssr_pass.cpp.

◆ run()

auto unravel::ssr_pass::run	(	gfx::render_view &	rview,
		const run_params &	params ) -> gfx::frame_buffer::ptr

Executes the SSR pass. Returns the actual output framebuffer.

Definition at line 207 of file ssr_pass.cpp.

◆ run_composite()

auto unravel::ssr_pass::run_composite	(	gfx::render_view &	rview,
		const gfx::frame_buffer::ptr &	ssr_history,
		const gfx::frame_buffer::ptr &	ssr_curr,
		const gfx::frame_buffer::ptr &	probe_buffer,
		const gfx::frame_buffer::ptr &	g_buffer,
		const gfx::frame_buffer::ptr &	output ) -> gfx::frame_buffer::ptr

Executes the composite pass. Returns final blended output.

Definition at line 505 of file ssr_pass.cpp.

◆ run_fidelityfx()

auto unravel::ssr_pass::run_fidelityfx	(	gfx::render_view &	rview,
		const run_params &	params ) -> gfx::frame_buffer::ptr

Executes the FidelityFX SSR pass. Returns the actual output framebuffer.

Definition at line 219 of file ssr_pass.cpp.

◆ run_fidelityfx_three_pass()

auto unravel::ssr_pass::run_fidelityfx_three_pass	(	gfx::render_view &	rview,
		const run_params &	params ) -> gfx::frame_buffer::ptr

Executes the three-pass SSR pipeline (trace, temporal resolve, composite)

Definition at line 305 of file ssr_pass.cpp.

◆ run_ssr_trace()

auto unravel::ssr_pass::run_ssr_trace	(	gfx::render_view &	rview,
		const run_params &	params ) -> gfx::frame_buffer::ptr

Executes the SSR trace pass only. Returns SSR current frame buffer.

Definition at line 329 of file ssr_pass.cpp.

◆ run_temporal_resolve()

auto unravel::ssr_pass::run_temporal_resolve	(	gfx::render_view &	rview,
		const gfx::frame_buffer::ptr &	ssr_curr,
		const gfx::frame_buffer::ptr &	g_buffer,
		const camera *	cam,
		const fidelityfx_ssr_settings &	settings ) -> gfx::frame_buffer::ptr

Executes the temporal resolve pass. Returns updated SSR history buffer.

Definition at line 425 of file ssr_pass.cpp.

The documentation for this class was generated from the following files:

C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/pipeline/passes/ssr_pass.h
C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/pipeline/passes/ssr_pass.cpp

Classes

Public Member Functions