atlas::window Class Reference

Represent an entire window that lives throughout the entire duration of the application. More...

#include <window.hpp>

Inheritance diagram for atlas::window:

Public Member Functions
uint32_t	width () const
	Returns the width dimension of the window.
uint32_t	height () const
	Returns the height dimension of the window.
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
vk::vk_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

Detailed Description

Represent an entire window that lives throughout the entire duration of the application.

There should only be one window that is living throughout the applications lifetime

Member Function Documentation

acquired_next_frame()

uint32_t atlas::window::acquired_next_frame ( )

inline

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 )

inline

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

)

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.hpp