Class atlas::window

ClassList > atlas > window

Inherited by the following classes: atlas::vk::vk_window

Public Functions

Type	Name
uint32_t	acquired_next_frame () Returns the available presentable image to use, retrieve index that image is called.
vk::vk_command_buffer	active_command_buffer (uint32_t p_frame_idx)
float	aspect_ratio () const Returns the aspect ratio of the current window.
bool	available () const Checks if window is available to close.
void	close () Closing the window operation.
vk::vk_swapchain	current_swapchain () const Returns the window's currently selected swapchain.
uint32_t	height () const Returns the height dimension of the window.
	operator GLFWwindow * () const
	operator GLFWwindow * ()
void	present (const uint32_t & p_current_frame_idx)
uint32_t	width () const Returns the width dimension of the window.
virtual	~window () = default

Public Functions Documentation

function acquired_next_frame

Returns the available presentable image to use, retrieve index that image is called.

inline uint32_t atlas::window::acquired_next_frame () 

---

function active_command_buffer

inline vk::vk_command_buffer atlas::window::active_command_buffer (
    uint32_t p_frame_idx
) 

---

function aspect_ratio

Returns the aspect ratio of the current window.

float atlas::window::aspect_ratio () const

---

function available

Checks if window is available to close.

bool atlas::window::available () const

---

function close

Closing the window operation.

void atlas::window::close () 

---

function current_swapchain

Returns the window's currently selected swapchain.

inline vk::vk_swapchain atlas::window::current_swapchain () const

---

function height

Returns the height dimension of the window.

uint32_t atlas::window::height () const

---

function operator GLFWwindow * [1/2]

inline atlas::window::operator GLFWwindow * () const

---

function operator GLFWwindow * [2/2]

inline atlas::window::operator GLFWwindow * () 

---

function present

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

Parameters:

• p_current_frame_idx is the current frame index for the next available image

---

function width

Returns the width dimension of the window.

uint32_t atlas::window::width () const

---

function ~window

virtual atlas::window::~window () = default

---

---

The documentation for this class was generated from the following file TheAtlasEngine/atlas/core/window.hpp