Magnum::Platform::XEglApplication class

#include <Magnum/Platform/XEglApplication.h>

Bootstrap application

The usage is very similar to Sdl2Application, for which fully contained base application along with CMake setup is available, see its documentation for more information.

General usage

This application library depends on X11 and EGL libraries and is built if MAGNUM_WITH_XEGLAPPLICATION is enabled when building Magnum. To use this library from CMake, put FindEGL.cmake into your modules/ directory, request the XEglApplication component of the Magnum package and link to the Magnum::XEglApplication target:

find_package(Magnum REQUIRED XEglApplication)

# ...
target_link_libraries(your-app PRIVATE Magnum::XEglApplication)

Additionally, if you're using Magnum as a CMake subproject, do the following before calling find_package() to ensure it's enabled, as the library is not built by default:

set(MAGNUM_WITH_XEGLAPPLICATION ON CACHE BOOL "" FORCE)
add_subdirectory(magnum EXCLUDE_FROM_ALL)

If no other application is requested, you can also use the generic Magnum::Application alias to simplify porting. Again, see Downloading and building and Usage with CMake for more information.

In C++ code you need to implement at least drawEvent() to be able to draw on the screen. The subclass can be then used directly in main() — see convenience macro MAGNUM_XEGLAPPLICATION_MAIN(). See Platform support for more information.

class MyApplication: public Platform::XEglApplication {
    // implement required methods...
};
MAGNUM_XEGLAPPLICATION_MAIN(MyApplication)

If no other application header is included, this class is also aliased to Platform::Application and the macro is aliased to MAGNUM_APPLICATION_MAIN() to simplify porting.

Base classes

class AbstractXApplication

Base for X11-based applications.

Constructors, destructors, conversion operators

XEglApplication(const Arguments& arguments, const Configuration& configuration = Configuration{}, const GLConfiguration& glConfiguration = GLConfiguration{}) explicit

Construct with an OpenGL context.

XEglApplication(const Arguments& arguments, NoCreateT) explicit

Construct without creating a window.

Function documentation