Inheritance diagram for atlas::window:

Public Member Functions
window_params	data () const

bool	available () const
	Checks if window is available to close.

float	aspect_ratio () const
	Returns the aspect ratio of the current window.

uint32_t	acquired_next_frame ()
	gives you the next presentable image to use and the index to retrieving that image

vulkan::swapchain	current_swapchain () const
	Returns the window's currently selected swapchain.

vk::command_buffer	active_command (uint32_t p_frame_index)
	retrieves the current command buffer using the current frame index to ensure we are processing commands to the right command buffer in our current frame

	operator GLFWwindow * () const
	operator overload for treating atlas::window as a GLFWwindow handle

	operator GLFWwindow * ()
	operator overload for treating atlas::window as a GLFWwindow handle

void	close ()
	Closing the window operation.

void	present (const uint32_t &p_current_frame_idx)
	does the presentation operation that is operated internally with the vulkan swapchain

Protected Member Functions
virtual window_params	get_params () const =0

virtual GLFWwindow *	native_window () const =0

virtual uint32_t	read_acquired_next_frame ()=0

virtual vulkan::swapchain	window_swapchain () const =0

virtual vk::command_buffer	current_active_command (uint32_t p_frame_idx)=0

virtual void	present_frame (const uint32_t &p_current_frame)=0

Member Function Documentation

◆ acquired_next_frame()

uint32_t atlas::window::acquired_next_frame ( )

inlineexport

gives you the next presentable image to use and the index to retrieving that image

Returns: uint32_t

◆ active_command()

vk::command_buffer atlas::window::active_command ( uint32_t p_frame_index )

inlineexport

retrieves the current command buffer using the current frame index to ensure we are processing commands to the right command buffer in our current frame

Returns: command buffer to actively record commands to

◆ present()

void atlas::window::present ( const uint32_t & p_current_frame_idx )

inlineexport

does the presentation operation that is operated internally with the vulkan swapchain

Parameters

p_current_frame_idx is current frame index to currently process an image in the current frame

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

TheAtlasEngine/atlas/core/window.cppm

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ acquired_next_frame()

◆ active_command()

◆ present()