nc::window::NcWindow Class Reference

Window module interface. More...

#include <Window.h>

Inheritance diagram for nc::window::NcWindow:

Public Member Functions
void	OnBeforeSceneLoad (const Scene &) override
	Called on registered modules prior to loading a new scene. More...
auto	GetDimensions () const noexcept -> const Vector2 &
	Get the dimensions of the entire window.
auto	GetScreenExtent () const noexcept -> const Vector2 &
	Get the dimensions of the renderable window region.
auto	GetContentScale () const noexcept -> const Vector2 &
	Get the ratio between the current DPI and the platform's default DPI.
auto	GetWindowHandle () const noexcept -> GLFWwindow *
	Get the GLFW window handle.
auto	OnResize () noexcept -> Signal< const Vector2 &, bool > &
	Get the Signal for window resize events.
auto	OnViewportResize () noexcept -> Signal< const Viewport & > &
	Get the Signal for viewport resize events.
virtual void	SetWindow (WindowInfo windowInfo)=0
	Set the window for the module.
virtual void	SetViewport (const Viewport &viewport)=0
	Set the dimensions and position of the renderable window. Values must be between [0.0f and 1.0f]. More...
virtual void	ProcessSystemMessages ()=0
	Process window and input events. More...
Public Member Functions inherited from nc::Module
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...
auto	Id () const noexcept
	Get the module's unique id.
virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.
virtual void	OnBeforeSceneLoad (const Scene &)
	Called on registered modules prior to loading a new scene. More...
virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.
virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.
virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Protected Attributes
Vector2	m_dimensions
Vector2	m_screenExtent
Viewport	m_viewport
Vector2	m_contentScale
GLFWwindow *	m_window
Signal< const Vector2 &, bool >	m_onResize
Signal< const Viewport & >	m_onViewportResize

Detailed Description

Window module interface.

Member Function Documentation

OnBeforeSceneLoad()

void nc::window::NcWindow::OnBeforeSceneLoad ( const Scene &  )

inlineoverridevirtual

Called on registered modules prior to loading a new scene.

Reimplemented from nc::Module.

ProcessSystemMessages()

virtual void nc::window::NcWindow::ProcessSystemMessages ( )

pure virtual

Process window and input events.

Note

This is called by NcEngine each frame.

SetViewport()

virtual void nc::window::NcWindow::SetViewport ( const Viewport &  viewport )

pure virtual

Set the dimensions and position of the renderable window. Values must be between [0.0f and 1.0f].

Remarks

Excludes ImGui, which is always rendered to the full screen.

---

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

• include/ncengine/window/Window.h