AppBase /

Override to perform any application setup after the Renderer has been initialized.

Override to perform any once-per-loop computation.

Override to perform any rendering once-per-loop or in response to OS-prompted requests for refreshes.

Override to receive mouse-down events.

Override to receive mouse-up events.

Override to receive mouse-wheel events.

Override to receive mouse-move events.

Override to receive mouse-drag events.

Override to respond to the beginning of a multitouch sequence.

Override to respond to movement (drags) during a multitouch sequence.

Override to respond to the end of a multitouch sequence.

Override to receive key-down events.

Override to receive key-up events.

Override to receive window resize events.

Override to receive file-drop events.

Override to cleanup any resources before app destruction.

Requests that the application exit gracefully upon completion of the current event loop. Use std::terminate() instead to end application immediately.

Emitted at the start of each application update cycle.

Signal that emits before the app quit process begins. If any slots return false then the app quitting is canceled.

Emitted prior to the application shutting down.

Emitted when a new display is connected to the system.

Emits a signal indicating a new display has connected to the system.

Emitted when a display is removed from the system.

Emits a signal indicating a display has disconnected from the system.

Emitted when the resolution or some other property of a Display is changed.

Emits a signal when the resolution or some other property of a Display has changed.

Returns the Renderer of the active Window .

Returns the Display of the active Window .

Creates and returns a reference to a new Window , adhering to format .

Returns the the currently active Window . Throws ExcInvalidWindow if called with no active window.

Gets the foreground Window , which has keyboard and mouse focus.

Returns the number of Windows the app has open.

Gets a Window by index, in the range [0, getNumWindows() ). Throw ExcInvalidWindow if index is out of bounds.

Returns the current location of the mouse in screen coordinates measured in points. Can be called outside the normal event loop.

Hides the mouse cursor.

Shows the mouse cursor.

a value of true allows screensavers or the system's power management to hide the app. Default value is false on desktop, and true on mobile

is power management enabled, allowing screensavers and the system's power management to hide the application

Returns the width of the App's current window measured in points.

Returns the height of the App's current window measured in points.

Sets the size of the App's current window measured in points. Ignored in full-screen mode.

Sets the size of the App's window measured in points. Ignored in full-screen mode.

Returns the center of the App's window measured in points.

Equivalent to vec2( getWindowWidth() * 0.5, getWindowHeight() * 0.5 )

Returns the size of the App's current window measured in points.

Returns the aspect ratio of the App's current window.

Returns the bounding area of the App's current window measured in points.

Equivalent to Area ( 0, 0, getWindowWidth() , getWindowHeight() );


Returns the contentScale of the App's window, which is the multiplier that maps points to pixels.

Returns tcoordinates of the top-left corner of the current window measured in points.

Returns the X coordinate of the top-left corner of the current window measured in points.

Returns the Y coordinate of the top-left corner of the current window contents measured in points.

Sets the coordinates of the top-left corner of the current window measured in points.

Sets the coordinates of the top-left corner of the current window measured points.

Returns the maximum frame-rate the App will attempt to maintain.

Sets the maximum frame-rate the App will attempt to maintain.

Disables frameRate limiting.

Returns whether frameRate limiting is enabled.

Returns the average frame-rate attained by the App as measured in frames-per-second.

Returns the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps()

Sets the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps()

Returns whether the App is in full-screen mode or not.

Sets whether the active App is in full-screen mode based on fullScreen .

Returns the number of seconds which have elapsed since application launch.

Returns the number of animation frames which have elapsed since application launch.

Returns whether the app is registered to receive multiTouch events from the operating system, configurable via Settings at startup. Disabled by default on desktop platforms, enabled on mobile.

Returns whether Windows created on a high-density (Retina) display will have their resolution doubled, configurable via Settings at startup. Default is true on iOS and false on other platforms.

Returns a DataSourceRef to an application asset. Throws a AssetLoadExc on failure.

Returns a fs::path to an application asset. Returns an empty path on failure.

Adds an absolute path 'dirPath' to the list of directories which are searched for assets.

Returns the path to the application on disk.

Presents the user with an open-file dialog and returns the selected file path.

The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions .

the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Presents the user with an open-folder dialog.

the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Presents the user with a save-file dialog and returns the selected file path.

The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions .

the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Returns a reference to an output console, which is by default an alias to std::cout. Other platforms may override to use other necessary console mechanisms.

Returns a vector of the command line arguments passed to the app when intantiated.

Returns a reference to the App's Timeline .

Returns a reference to the App's boost::asio::io_service()

Executes a std::function on the App's primary thread ahead of the next update()

Returns the default Renderer which will be used when creating a new Window . Set by the app instantiation macro automatically.

a copy of the current window's contents as a Surface8u

a copy of the Area area (measured in pixels) from the current window's contents as a Surface8u

Restores the current rendering context to be the App's window or the screen in full-screen mode. Generally this is only necessary if the app has displayed a dialog box or some other external window.

Returns true if the calling thread is the Application's main thread (the thread running the main function), false otherwise.

Returns a pointer to the active App.