Window Class Reference

Platform specific OS window for rendering. More...

#include <Window.hpp>

Inheritance diagram for Window:

Collaboration diagram for Window:

Public Member Functions
BRK_API	~Window () override=default
virtual BRK_API Point2i	GetPosition () const =0
virtual BRK_API Size2i	GetSize () const =0
virtual BRK_API Size2i	GetFramebufferSize () const =0
virtual BRK_API Vec2f	GetPixelRatio () const =0
virtual BRK_API float	GetAspectRatio () const
virtual BRK_API bool	IsInFocus () const =0
virtual BRK_API bool	IsClosed () const =0
virtual BRK_API String	GetTitle () const =0
virtual BRK_API StringName	GetName () const =0
Public Member Functions inherited from RefCnt
virtual	~RefCnt ()
bool	IsUnique () const
std::int32_t	GetRefs () const
std::int32_t	AddRef () const
std::int32_t	RelRef () const

Additional Inherited Members
Protected Member Functions inherited from RefCnt
virtual void	Destroy () const

Detailed Description

Platform specific OS window for rendering.

Constructor & Destructor Documentation

~Window()

BRK_API Window::~Window ( )

overridedefault

Member Function Documentation

GetAspectRatio()

virtual BRK_API float Window::GetAspectRatio ( ) const

inlinevirtual

Returns

Aspect ratio width / height

GetFramebufferSize()

virtual BRK_API Size2i Window::GetFramebufferSize ( ) const

pure virtual

Returns

Window framebuffer size

Implemented in GlfwWindow.

GetName()

virtual BRK_API StringName Window::GetName ( ) const

pure virtual

Returns

Window unique name for look-up

Implemented in GlfwWindow.

GetPixelRatio()

virtual BRK_API Vec2f Window::GetPixelRatio ( ) const

pure virtual

Returns

Ratio of pixels per window size units

Implemented in GlfwWindow.

GetPosition()

virtual BRK_API Point2i Window::GetPosition ( ) const

pure virtual

Returns

Current window position

Implemented in GlfwWindow.

GetSize()

virtual BRK_API Size2i Window::GetSize ( ) const

pure virtual

Returns

Window size

Implemented in GlfwWindow.

GetTitle()

virtual BRK_API String Window::GetTitle ( ) const

pure virtual

Returns

Window title

Implemented in GlfwWindow.

IsClosed()

virtual BRK_API bool Window::IsClosed ( ) const

pure virtual

Returns

True if window is closed

Implemented in GlfwWindow.

IsInFocus()

virtual BRK_API bool Window::IsInFocus ( ) const

pure virtual

Returns

True if window receives focus

Implemented in GlfwWindow.

---

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

• code/runtime/platform/Window.hpp