PixelBullet::Window Class Reference

Public Types
enum class	WindowState { Normal , Minimized , Maximized }

Public Member Functions
	Window (const ApplicationSpecification &props)
void	OnUpdate () noexcept
	Polls for and processes events.
void	SetIcon (const VirtualPath &iconPath)
	Sets the window icon from an image file.
unsigned int	GetWidth () const noexcept
	Accessors for window size.
unsigned int	GetHeight () const noexcept
glm::ivec2	GetSize () const noexcept
void	SetEventCallback (const std::function< void(Event &)> &callback)
	Sets the callback that will be invoked when events occur.
void *	GetNativeWindow () const noexcept
	Returns the underlying native window pointer.
std::pair< const char **, uint32_t >	GetInstanceExtensions () const
	Retrieves the Vulkan instance extensions required by GLFW.
VkResult	CreateSurface (VkInstance instance, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface) const
	Creates a Vulkan surface for this window.
void	Minimize () noexcept
	Minimizes the window.
void	Maximize () noexcept
	Maximizes the window.
void	Restore () noexcept
	Restores the window from a minimized or maximized state.
bool	IsMinimized () const noexcept
	Returns whether the window is currently minimized.
bool	IsMaximized () const noexcept
	Returns whether the window is currently maximized.
WindowState	GetWindowState () const noexcept
	Returns the current window state.

Member Function Documentation

CreateSurface()

VkResult PixelBullet::Window::CreateSurface	(	VkInstance	instance,
		const VkAllocationCallbacks *	allocator,
		VkSurfaceKHR *	surface ) const

Creates a Vulkan surface for this window.

GetInstanceExtensions()

std::pair< const char **, uint32_t > PixelBullet::Window::GetInstanceExtensions

(

)

const

Retrieves the Vulkan instance extensions required by GLFW.

GetNativeWindow()

void * PixelBullet::Window::GetNativeWindow ( ) const

inlinenoexcept

Returns the underlying native window pointer.

GetWidth()

unsigned int PixelBullet::Window::GetWidth ( ) const

inlinenoexcept

Accessors for window size.

GetWindowState()

Window::WindowState PixelBullet::Window::GetWindowState ( ) const

noexcept

Returns the current window state.

IsMaximized()

bool PixelBullet::Window::IsMaximized ( ) const

noexcept

Returns whether the window is currently maximized.

IsMinimized()

bool PixelBullet::Window::IsMinimized ( ) const

noexcept

Returns whether the window is currently minimized.

Maximize()

void PixelBullet::Window::Maximize ( )

noexcept

Maximizes the window.

Minimize()

void PixelBullet::Window::Minimize ( )

noexcept

Minimizes the window.

OnUpdate()

void PixelBullet::Window::OnUpdate ( )

noexcept

Polls for and processes events.

Restore()

void PixelBullet::Window::Restore ( )

noexcept

Restores the window from a minimized or maximized state.

SetEventCallback()

void PixelBullet::Window::SetEventCallback ( const std::function< void(Event &)> & callback )

inline

Sets the callback that will be invoked when events occur.

SetIcon()

void PixelBullet::Window::SetIcon

(

const VirtualPath &

iconPath

)

Sets the window icon from an image file.

---

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

• engine/src/PixelBullet/Window/Window.hpp
• engine/src/PixelBullet/Window/Window.cpp