Vesper::Window Class Reference

Abstract interface representing an application window. More...

#include <Window.h>

Inheritance diagram for Vesper::Window:

Public Types
using	EventCallbackFn = std::function<void(Event&)>

Public Member Functions
virtual	~Window ()
virtual void	OnUpdate ()=0
	Called every frame to update the window.
virtual uint32_t	GetWidth () const =0
	Retrieves the width of the window.
virtual uint32_t	GetHeight () const =0
	Retrieves the height of the window.
virtual void	SetEventCallback (const EventCallbackFn &callback)=0
	Sets the callback function for window events.
virtual void	SetVSync (bool enabled)=0
	Sets whether vertical synchronization (VSync) is enabled.
virtual bool	IsVSync () const =0
	Checks if vertical synchronization (VSync) is enabled.
virtual void *	GetNativeWindow () const =0
	Retrieves the native window handle.

Static Public Member Functions
static Scope< Window >	Create (const WindowProps &props=WindowProps())
	Creates a window instance with the specified properties.

Detailed Description

Abstract interface representing an application window.

Todo

Add Window mode functionality

Member Typedef Documentation

EventCallbackFn

using Vesper::Window::EventCallbackFn = std::function<void(Event&)>

Constructor & Destructor Documentation

~Window()

virtual Vesper::Window::~Window ( )

inlinevirtual

{}

Member Function Documentation

Create()

Scope< Window > Vesper::Window::Create ( const WindowProps & props = WindowProps() )

static

Creates a window instance with the specified properties.

Parameters

props

The properties to initialize the window with.

Returns

A scoped pointer to the created window instance.

    {
        return CreateScope<WindowsWindow>(props);
    }

GetHeight()

virtual uint32_t Vesper::Window::GetHeight ( ) const

pure virtual

Retrieves the height of the window.

Implemented in Vesper::WindowsWindow.

Referenced by Vesper::ImGuiLayer::End().

GetNativeWindow()

virtual void * Vesper::Window::GetNativeWindow ( ) const

pure virtual

Retrieves the native window handle.

Implemented in Vesper::WindowsWindow.

Referenced by Vesper::Input::GetMousePosition(), Vesper::Input::IsKeyPressed(), and Vesper::Input::IsMouseButtonPressed().

GetWidth()

virtual uint32_t Vesper::Window::GetWidth ( ) const

pure virtual

Retrieves the width of the window.

Implemented in Vesper::WindowsWindow.

Referenced by Vesper::ImGuiLayer::End().

IsVSync()

virtual bool Vesper::Window::IsVSync ( ) const

pure virtual

Checks if vertical synchronization (VSync) is enabled.

Implemented in Vesper::WindowsWindow.

OnUpdate()

virtual void Vesper::Window::OnUpdate ( )

pure virtual

Called every frame to update the window.

Implemented in Vesper::WindowsWindow.

SetEventCallback()

virtual void Vesper::Window::SetEventCallback ( const EventCallbackFn & callback )

pure virtual

Sets the callback function for window events.

Implemented in Vesper::WindowsWindow.

SetVSync()

virtual void Vesper::Window::SetVSync ( bool enabled )

pure virtual

Sets whether vertical synchronization (VSync) is enabled.

Implemented in Vesper::WindowsWindow.

---

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

• Vesper/src/Vesper/App/Window.h
• Vesper/src/Platform/Windows/WindowsWindow.cpp