Skip to main content

WindowConfig.ixx File

Window creation and initialization configuration. More...

Included Headers​

#include <string> #include <helios.math.types>

Namespaces Index​

namespacehelios
namespacewindow

Window management and configuration. More...

Classes Index​

structWindowConfig

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

Description​

Window creation and initialization configuration.

File Listing​

The file content with the documentation metadata removed is:

1/**
2 * @file WindowConfig.ixx
3 * @brief Window creation and initialization configuration.
4 */
5module;
6
7#include <string>
8
9export module helios.window.WindowConfig;
10
11import helios.math.types;
12
13export namespace helios::window {
14
15 /**
16 * @brief Configuration structure for creating and initializing a Window.
17 *
18 * Provides common parameters such as dimensions, aspect ratio, and title.
19 */
20 struct WindowConfig {
21
22 virtual ~WindowConfig() = default;
23
24 /**
25 * @brief Initial width of the Window.
26 */
27 int width{800};
28
29
30 /**
31 * @brief Initial height of the Window.
32 */
33 int height{800};
34
35 /**
36 * @brief Numerator of the aspect ratio.
37 *
38 * This value represents the numerator part of the aspect ratio
39 * used for the window. It is paired with `aspectRatioDenom` to
40 * define the aspect ratio as a fraction (numerator/denominator).
41 * A value of 0 indicates that no specific aspect ratio is set.
42 */
43 int aspectRatioNumer{0};
44
45 /**
46 * @brief Denominator of the aspect ratio.
47 *
48 * This value represents the denominator part of the aspect ratio
49 * used for the window. It is paired with `aspectRatioNumer` to
50 * define the aspect ratio as a fraction (numerator/denominator).
51 * A value of 0 indicates that no specific aspect ratio is set.
52 */
53 int aspectRatioDenom{0};
54
55
56 /**
57 * @brief Initial title displayed with the window, e.g. the title bar.
58 */
59 std::string title{"helios - Window"};
60
61 };
62
63}

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.