Detailed Description

Operating system window that serve as rendering surface.

Inheritance diagram for RenderingWindow:

Public Member Functions
	RenderingWindow (const RenderingWindowConfiguration &config={})

	~RenderingWindow () override

void	show () const

void	close () const

Rect	getRect () const

void	setTitle (const std::string &title) const

vireo::PlatformWindowHandle	getHandle () const

void	setMouseMode (MouseMode mode) const

void	setMouseCursor (MouseCursor cursor) const

void	resetMousePosition () const

bool	isMouseHidden () const

float2	getMousePosition () const

void	setMousePosition (const float2 &position) const

RenderTarget &	getRenderTarget ()

const RenderTarget &	getRenderTarget () const

void	setPause (const bool pause)

bool	isPaused () const

bool	isMinimized () const

Public Member Functions inherited from UniqueResource
	UniqueResource () = default

	UniqueResource (UniqueResource &) = delete

UniqueResource &	operator= (UniqueResource &) = delete

Public Member Functions inherited from UnmanagedResource
	UnmanagedResource ()

	UnmanagedResource (const Resource &other)

Public Member Functions inherited from Resource
bool	operator== (const Resource &other) const

	Resource () = default

	Resource (const unique_id id)

virtual	~Resource () = default

Additional Inherited Members
Public Attributes inherited from Resource
unique_id	id {INVALID_ID}

Constructor & Destructor Documentation

RenderingWindow ( const RenderingWindowConfiguration & config = {} )

~RenderingWindow ( )

override

void close ( ) const

vireo::PlatformWindowHandle getHandle ( ) const

inline

float2 getMousePosition ( ) const

Returns the mouse position

Rect getRect ( ) const

RenderTarget& getRenderTarget ( )

inline

const RenderTarget& getRenderTarget ( ) const

inline

bool isMinimized ( ) const

bool isMouseHidden ( ) const

bool isPaused ( ) const

inline

void resetMousePosition ( ) const

Sets the mouse position to the center of the window

void setMouseCursor ( MouseCursor cursor ) const

Sets the mouse cursor

Parameters

cursor MouseCursor enum selecting the cursor shape.

void setMouseMode ( MouseMode mode ) const

Sets the mouse visibility and capture mode

Parameters

mode	MouseMode (visible, hidden, captured, etc.).

void setMousePosition ( const float2 & position ) const

Returns the mouse position

Parameters

position Coordinates in pixels relative to the client area.

void setPause ( const bool pause )

inline

void setTitle ( const std::string & title ) const

void show ( ) const

Make a previously created window visible on screen.