Skip to main content

WindowConfig Struct

Configuration structure for creating and initializing a Window. More...

Declaration

struct helios::window::WindowConfig { ... }

Derived Structs

structGLFWWindowConfig

Configuration structure for a GLFWWindow. More...

Public Destructor Index

~WindowConfig ()=default

Public Member Attributes Index

intwidth {800}

Initial width of the Window. More...

intheight {800}

Initial height of the Window. More...

intaspectRatioNumer {0}

Numerator of the aspect ratio. More...

intaspectRatioDenom {0}

Denominator of the aspect ratio. More...

std::stringtitle {"helios - Window"}

Initial title displayed with the window, e.g. the title bar. More...

Description

Configuration structure for creating and initializing a Window.

Provides common parameters such as dimensions, aspect ratio, and title.

Definition at line 20 of file WindowConfig.ixx.

Public Destructor

~WindowConfig()

virtual helios::window::WindowConfig::~WindowConfig ()
virtual default

Definition at line 22 of file WindowConfig.ixx.

Public Member Attributes

aspectRatioDenom

int helios::window::WindowConfig::aspectRatioDenom {0}

Denominator of the aspect ratio.

This value represents the denominator part of the aspect ratio used for the window. It is paired with `aspectRatioNumer` to define the aspect ratio as a fraction (numerator/denominator). A value of 0 indicates that no specific aspect ratio is set.

Definition at line 53 of file WindowConfig.ixx.

aspectRatioNumer

int helios::window::WindowConfig::aspectRatioNumer {0}

Numerator of the aspect ratio.

This value represents the numerator part of the aspect ratio used for the window. It is paired with `aspectRatioDenom` to define the aspect ratio as a fraction (numerator/denominator). A value of 0 indicates that no specific aspect ratio is set.

Definition at line 43 of file WindowConfig.ixx.

height

int helios::window::WindowConfig::height {800}

Initial height of the Window.

Definition at line 33 of file WindowConfig.ixx.

33 int height{800};

title

std::string helios::window::WindowConfig::title {"helios - Window"}

Initial title displayed with the window, e.g. the title bar.

Definition at line 59 of file WindowConfig.ixx.

59 std::string title{"helios - Window"};

width

int helios::window::WindowConfig::width {800}

Initial width of the Window.

Definition at line 27 of file WindowConfig.ixx.

27 int width{800};

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.