WindowComponent.md

WindowComponent

Component that lets Entities be used as operating system windows.

"Window Entities" are automatically created by graphics systems (such as the OpenGLSystem) if no user-created "window Entity" is available.

Specs

• Reflectible
• Serializable (POD)
• Processed by graphics systems (such as the OpenGLSystem)

Members

name

using string = putils::string<KENGINE_WINDOW_COMPONENT_NAME_MAX_LENGTH>;
string name;

Name of the window.

The maximum length of this field (stored as a putils::string) defaults to 64, and can be adjusted by defining the KENGINE_WINDOW_COMOPNENT_NAME_MAX_LENGTH macro.

size

putils::Point2ui size = { 1280, 720 };

fullscreen

bool fullscreen = false;

shutdownOnClose

bool shutdownOnClose = true;

Indicates whether the application should shut down when users close the window.

assignedSystem

string assignedSystem;

Name of the graphics system handling this window.