Platform abstraction of the windowed application with main purpose for graphics content rendering. Graphics rendering infrastructure itself is split into derived class defined in a separate library.
Defines alias type Platform::App pointing to one of platform-specific implementations of the AppBase abstract class:
- Platform::AppWin - Windows app implementation
- Platform::AppLin - Linux app implementation
- Platform::AppMac - MacOS app implementation
- Platform::AppIOS - iOS app implementation
Platform::App should be used as a base class for any windowed Methane application.
Base interface and platform-abstraction implementation of the application class with the following functionality:
- Initial application settings setup (see table below)
- Running application with a given command line arguments and parsing platform app settings from cmd arguments
- Live window resizing with frame re-render on resize iterations
- Switching window to full-screen mode
- Processing keyboard and mouse input via
Platform::Input::State - Adding platform application controller to input state processor
- Setting title in window header
- Showing user alert in message box dialog
- Displaying application controls and command line help
- Shared parallel task execution engine with thread pool Taskflow::Executor
The following settings are available in Platform::AppBase::Settings structure:
| Setting | Type | Default Value | Cmd-Line Option | Description |
|---|---|---|---|---|
| name | uint32_t | "" | Application name displayed in window header | |
| width | double | 0.8 | -w,--width | Main window width (if < 1.0 it is a ratio of desktop size; else size in pixels/dots) |
| height | double | 0.8 | -x,--height | Main window height (if < 1.0 it is a ratio of desktop size; else size in pixels/dots) |
| min_width | uint32_t | 640 | Minimum window width in pixels/dots limited for resizing | |
| min_height | uint32_t | 480 | Minimum window height in pixels/dots limited for resizing | |
| is_full_screen | bool | false | -f,--full-screen | Full-screen state of the main window |
Platform application controller implements the following actions:
| Action | Keyboard Shortcut |
|---|---|
| Show controls help | F1 |
| Show command-line help | F2 |
| Show parameters | F3 |
| Switch full-screen | LCtrl + F |
| Close application | LCtrl/LCmd + Q |