Magnum::Platform::AbstractXApplication class

#include <Magnum/Platform/AbstractXApplication.h>

Derived classes

class GlxApplication

GLX application.

class XEglApplication

X/EGL application.

Public types

struct Arguments

Application arguments.

class Configuration

Configuration.

class GLConfiguration

OpenGL context configuration.

class InputEvent

Base for input events.

class KeyEvent

Key event.

class MouseEvent deprecated in Git master

Mouse event.

class MouseMoveEvent deprecated in Git master

Mouse move event.

class PointerEvent new in Git master

Pointer event.

class PointerMoveEvent new in Git master

Pointer move event.

class ScrollEvent new in Git master

Scroll event.

class ViewportEvent

Viewport event.

enum class Modifier: unsigned int { Shift = ShiftMask, Ctrl = ControlMask, Alt = Mod1Mask, AltGr = Mod5Mask, CapsLock = LockMask, NumLock = Mod2Mask } new in Git master

Keyboard modifier.

enum class Key: KeySym { LeftShift = XK_Shift_L new in Git master, RightShift = XK_Shift_R new in Git master, LeftCtrl = XK_Control_L new in Git master, RightCtrl = XK_Control_R new in Git master, LeftAlt = XK_Alt_L new in Git master, RightAlt = XK_Alt_R new in Git master, LeftSuper = XK_Super_L new in Git master, RightSuper = XK_Super_R new in Git master, Enter = XK_Return, Esc = XK_Escape, Up = XK_Up, Down = XK_Down, Left = XK_Left, Right = XK_Right, Home = XK_Home, End = XK_End, PageUp = XK_Page_Up, PageDown = XK_Page_Down, Backspace = XK_BackSpace new in Git master, Insert = XK_Insert new in Git master, Delete = XK_Delete new in Git master, F1 = XK_F1, F2 = XK_F2, F3 = XK_F3, F4 = XK_F4, F5 = XK_F5, F6 = XK_F6, F7 = XK_F7, F8 = XK_F8, F9 = XK_F9, F10 = XK_F10, F11 = XK_F11, F12 = XK_F12, Space = XK_space, Tab = XK_Tab new in Git master, Quote = XK_apostrophe new in Git master, Comma = XK_comma, Period = XK_period, Minus = XK_minus, Plus = XK_plus, Slash = XK_slash, Percent = XK_percent, Semicolon = XK_semicolon new in Git master, Equal = XK_equal, LeftBracket = XK_bracketleft new in Git master, RightBracket = XK_bracketright new in Git master, Backslash = XK_backslash new in Git master, Backquote = XK_grave new in Git master, Zero = XK_0, One = XK_1, Two = XK_2, Three = XK_3, Four = XK_4, Five = XK_5, Six = XK_6, Seven = XK_7, Eight = XK_8, Nine = XK_9, A = XK_a, B = XK_b, C = XK_c, D = XK_d, E = XK_e, F = XK_f, G = XK_g, H = XK_h, I = XK_i, J = XK_j, K = XK_k, L = XK_l, M = XK_m, N = XK_n, O = XK_o, P = XK_p, Q = XK_q, R = XK_r, S = XK_s, T = XK_t, U = XK_u, V = XK_v, W = XK_w, X = XK_x, Y = XK_y, Z = XK_z, CapsLock = XK_Caps_Lock new in Git master, ScrollLock = XK_Scroll_Lock new in Git master, NumLock = XK_Num_Lock new in Git master, PrintScreen = XK_Print new in Git master, NumZero = XK_KP_0 new in Git master, NumOne = XK_KP_1 new in Git master, NumTwo = XK_KP_2 new in Git master, NumThree = XK_KP_3 new in Git master, NumFour = XK_KP_4 new in Git master, NumFive = XK_KP_5 new in Git master, NumSix = XK_KP_6 new in Git master, NumSeven = XK_KP_7 new in Git master, NumEight = XK_KP_8 new in Git master, NumNine = XK_KP_9 new in Git master, NumDecimal = XK_KP_Decimal new in Git master, NumDivide = XK_KP_Divide new in Git master, NumMultiply = XK_KP_Multiply new in Git master, NumSubtract = XK_KP_Subtract new in Git master, NumAdd = XK_KP_Add new in Git master, NumEnter = XK_KP_Enter new in Git master, NumEqual = XK_KP_Equal new in Git master } new in Git master

Key.

enum class PointerEventSource: UnsignedByte { Mouse } new in Git master

Pointer event source.

enum class Pointer: UnsignedByte { MouseLeft = 1 << 0, MouseMiddle = 1 << 1, MouseRight = 1 << 2 } new in Git master

Pointer type.

using Modifiers = Containers::EnumSet<Modifier> new in Git master

Set of keyboard modifiers.

using Pointers = Containers::EnumSet<Pointer> new in Git master

Set of pointer types.

Constructors, destructors, conversion operators

AbstractXApplication(const AbstractXApplication&) deleted

Copying is not allowed.

AbstractXApplication(AbstractXApplication&&) deleted

Moving is not allowed.

Public functions

auto operator=(const AbstractXApplication&) -> AbstractXApplication& deleted

Copying is not allowed.

auto operator=(AbstractXApplication&&) -> AbstractXApplication& deleted

Moving is not allowed.

auto exec() -> int

Execute main loop.

auto mainLoopIteration() -> bool new in 2020.06

Run one iteration of application main loop.

void exit(int exitCode = 0)

Exit application.

Protected functions

void create(const Configuration& configuration, const GLConfiguration& glConfiguration)

Create a window with given configuration for OpenGL context.

void create(const Configuration& configuration)

Create a window with given configuration and OpenGL context.

void create()

Create a window with default configuration and OpenGL context.

auto tryCreate(const Configuration& configuration, const GLConfiguration& glConfiguration) -> bool

Try to create context with given configuration for OpenGL context.

auto tryCreate(const Configuration& configuration) -> bool

Try to create context with given configuration and OpenGL context.

Screen handling

auto windowSize() const -> Vector2i

Window size.

auto framebufferSize() const -> Vector2i

Framebuffer size.

void swapBuffers() protected

Swap buffers.

void redraw() protected

Redraw immediately.

void viewportEvent(ViewportEvent& event) private virtual

Viewport event.

void drawEvent() private pure virtual

Draw event.

Keyboard handling

void keyPressEvent(KeyEvent& event) private virtual

Key press event.

void keyReleaseEvent(KeyEvent& event) private virtual

Key release event.

Pointer handling

void pointerPressEvent(PointerEvent& event) private virtual new in Git master

Pointer press event.

void mousePressEvent(MouseEvent& event) deprecated in Git master private virtual

Mouse press event.

void pointerReleaseEvent(PointerEvent& event) private virtual new in Git master

Pointer release event.

void mouseReleaseEvent(MouseEvent& event) deprecated in Git master private virtual

Mouse release event.

void pointerMoveEvent(PointerMoveEvent& event) private virtual new in Git master

Pointer move event.

void mouseMoveEvent(MouseMoveEvent& event) deprecated in Git master private virtual

Mouse move event.

void scrollEvent(ScrollEvent& event) private virtual new in Git master

Mouse scroll event.

Enum documentation

Typedef documentation

Function documentation

MyApplication::MyApplication(const Arguments& arguments):
    Platform::Application{arguments, NoCreate}
{
    // …

    if(!everythingGoingAsExpected) {
        exit(1);
        return;
    }

    // …
}