Struct representing a render window. More...

#include <render_window.h>

Public Types
using	graphics_surface_t = std::shared_ptr<gfx::frame_buffer>

Public Member Functions
	render_window (os::window &&win)
	Constructs a render window with the specified OS window.

	~render_window ()
	Destructor for the render window.

void	prepare_surface ()
	Prepares the rendering surface.

void	destroy_surface ()
	Destroys the rendering surface.

void	resize (uint32_t w, uint32_t h)
	Resizes the render window to the specified width and height.

auto	get_window () -> os::window &
	Gets the associated OS window.

auto	get_surface () -> graphics_surface_t &
	Gets the rendering surface.

auto	begin_present_pass () -> gfx::render_pass &
	Begins the present render pass.

auto	get_present_pass () -> gfx::render_pass &
	Gets the present render pass.

Detailed Description

Struct representing a render window.

Definition at line 18 of file render_window.h.

Member Typedef Documentation

◆ graphics_surface_t

using unravel::render_window::graphics_surface_t = std::shared_ptr<gfx::frame_buffer>

Definition at line 21 of file render_window.h.

Constructor & Destructor Documentation

◆ render_window()

unravel::render_window::render_window ( os::window && win )

Constructs a render window with the specified OS window.

Parameters

win	The OS window to associate with this render window.

Definition at line 6 of file render_window.cpp.

◆ ~render_window()

unravel::render_window::~render_window ( )

Destructor for the render window.

Definition at line 11 of file render_window.cpp.

Member Function Documentation

◆ begin_present_pass()

auto unravel::render_window::begin_present_pass ( ) -> gfx::render_pass&

Begins the present render pass.

Returns: Reference to the present render pass.

Definition at line 61 of file render_window.cpp.

◆ destroy_surface()

void unravel::render_window::destroy_surface ( )

Destroys the rendering surface.

Definition at line 16 of file render_window.cpp.

◆ get_present_pass()

auto unravel::render_window::get_present_pass ( ) -> gfx::render_pass&

Gets the present render pass.

Returns: Reference to the present render pass.

Definition at line 70 of file render_window.cpp.

◆ get_surface()

auto unravel::render_window::get_surface ( ) -> graphics_surface_t&

Gets the rendering surface.

Returns: Reference to the rendering surface.

Definition at line 56 of file render_window.cpp.

◆ get_window()

auto unravel::render_window::get_window ( ) -> os::window&

Gets the associated OS window.

Returns: Reference to the OS window.

Definition at line 52 of file render_window.cpp.

◆ prepare_surface()

void unravel::render_window::prepare_surface ( )

Prepares the rendering surface.

Definition at line 33 of file render_window.cpp.

◆ resize()

void unravel::render_window::resize	(	uint32_t	w,
		uint32_t	h )

Resizes the render window to the specified width and height.