Hubris::Graphics::Vulkan::vkWindow Class Reference

Vulkan specific Windowing implementation. More...

#include <vkWindow.h>

Inheritance diagram for Hubris::Graphics::Vulkan::vkWindow:

Collaboration diagram for Hubris::Graphics::Vulkan::vkWindow:

Classes
struct	Details

Public Member Functions
virtual	~vkWindow () override
void	Init () override
	Intializes the rendering backend and creates the Window.
void	Update () noexcept override
	Poll events.
void	Close () noexcept override
	Closes the Window and frees resources.
Viewport	GetViewport () const noexcept override
	Gets the window dimension.
bool	IsValid () const noexcept override
bool	IsRunning () const noexcept override
void *	GetNative () const noexcept override
	Get the Native object.
void *	GetSurface () const noexcept
Swapchain *	GetSwapchain () const noexcept
Public Member Functions inherited from Hubris::Graphics::Window
virtual	~Window ()=default

Static Public Member Functions
static vkWindow *	Create (int Width, int Height, const std::string &title)

Friends
class	Engine

Detailed Description

Vulkan specific Windowing implementation.

Definition at line 11 of file vkWindow.h.

Constructor & Destructor Documentation

~vkWindow()

Hubris::Graphics::Vulkan::vkWindow::~vkWindow ( )

overridevirtual

Definition at line 178 of file vkWindow.cpp.

Here is the call graph for this function:

Member Function Documentation

Close()

void Hubris::Graphics::Vulkan::vkWindow::Close ( )

overridevirtualnoexcept

Closes the Window and frees resources.

Implements Hubris::Graphics::Window.

Definition at line 197 of file vkWindow.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Create()

Hubris::Graphics::Vulkan::vkWindow * Hubris::Graphics::Vulkan::vkWindow::Create ( int Width, int Height, const std::string & title )

staticnodiscard

Definition at line 75 of file vkWindow.cpp.

Here is the call graph for this function:

GetNative()

void * Hubris::Graphics::Vulkan::vkWindow::GetNative ( ) const

overridevirtualnoexcept

Get the Native object.

Returns

void* an platform dependent handle.

Implements Hubris::Graphics::Window.

Definition at line 219 of file vkWindow.cpp.

Here is the caller graph for this function:

GetSurface()

void * Hubris::Graphics::Vulkan::vkWindow::GetSurface ( ) const

noexcept

Definition at line 224 of file vkWindow.cpp.

Here is the caller graph for this function:

GetSwapchain()

Hubris::Graphics::Swapchain * Hubris::Graphics::Vulkan::vkWindow::GetSwapchain ( ) const

noexcept

Definition at line 229 of file vkWindow.cpp.

Here is the caller graph for this function:

GetViewport()

Hubris::Graphics::Viewport Hubris::Graphics::Vulkan::vkWindow::GetViewport ( ) const

overridevirtualnoexcept

Gets the window dimension.

Returns

The Dimensions wrapped in a Viewport Object.

Implements Hubris::Graphics::Window.

Definition at line 204 of file vkWindow.cpp.

Here is the caller graph for this function:

Init()

void Hubris::Graphics::Vulkan::vkWindow::Init ( )

overridevirtual

Intializes the rendering backend and creates the Window.

Exceptions

Can

throw.

Implements Hubris::Graphics::Window.

Definition at line 184 of file vkWindow.cpp.

IsRunning()

bool Hubris::Graphics::Vulkan::vkWindow::IsRunning ( ) const

inlineoverridevirtualnoexcept

Implements Hubris::Graphics::Window.

Definition at line 214 of file vkWindow.cpp.

Here is the caller graph for this function:

IsValid()

bool Hubris::Graphics::Vulkan::vkWindow::IsValid ( ) const

overridevirtualnoexcept

Returns

returns true if the Window is valid.

Implements Hubris::Graphics::Window.

Definition at line 209 of file vkWindow.cpp.

Here is the caller graph for this function:

Update()

void Hubris::Graphics::Vulkan::vkWindow::Update ( )

overridevirtualnoexcept

Poll events.

Implements Hubris::Graphics::Window.

Definition at line 190 of file vkWindow.cpp.

Friends And Related Symbol Documentation

Engine

friend class Engine

friend

Definition at line 13 of file vkWindow.h.

---

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

• include/Core/Graphics/Vulkan/vkWindow.h
• src/Core/Graphics/Vulkan/vkWindow.cpp