Module engine 

Engine is container for all subsystems (renderer, ui, sound, resource manager). It also creates a window and an OpenGL context.

Modules

error

All possible errors that can happen in the engine.

executor

Executor is a small wrapper that manages plugins and scripts for your game.

input

This module contains a set of “shortcuts” that allows getting the state of a mouse and a keyboard in a simplified manner (read - without using “verbose” event-based approach). It may be useful in simple scenarios where you just need to know if a button (on keyboard, mouse) was pressed and do something. You should always prefer the event-based approach when possible.

task

Asynchronous task handler. See TaskPoolHandler for more info and usage examples.

Structs

AsyncSceneLoader

A helper that is used to load scenes asynchronously.

Engine

See module docs.

EngineInitParams

Engine initialization parameters.

GraphicsContextParams

A set of parameters that could be used to initialize graphics context.

GraphicsServerConstructor

Graphics server constructor is used to initialize different graphics servers in unified manner. Default trait implementation currently creates OpenGL graphics server.

InitializedGraphicsContext

An initialized graphics context. It contains the main application window and the renderer instance.

PerformanceStatistics

Performance statistics.

ScriptMessageDispatcher

Performs dispatch of script messages.

ScriptProcessor

Script processor is used to run script methods in a strict order.

ScriptedScene

Scripted scene is a handle to scene with some additional data associated with it.

SerializationContext

Serialization context holds runtime type information that allows to create unknown types using their UUIDs and a respective constructors.

Enums

ApplicationLoopController

A controller for the application loop.

GraphicsContext

Graphics context of the engine, it could be in two main states:

Type Aliases

GraphicsServerConstructorCallback

Graphics server constructor callback responsible for actual server creation. Graphics server initialization usually tied together with window creation on some operating systems, that’s why the constructor accepts window builder and must return the window built with the builder as well as the server.

GraphicsServerConstructorResult

A result returned by a graphics server constructor.