Magnum::Platform::EmscriptenApplication::Configuration class
#include <Magnum/Platform/EmscriptenApplication.h>

Configuration.

Public types

enum class Flag: UnsignedByte { Contextless = 1 << 0, AlwaysRequestAnimationFrame = 1 << 2 } new in Git master: Flag.
enum class WindowFlag: UnsignedByte { Contextless = UnsignedByte(Flag::Contextless) deprecated in Git master, Resizable = UnsignedByte(EmscriptenApplication::WindowFlag::Resizable) deprecated in Git master, AlwaysRequestAnimationFrame = UnsignedByte(Flag::AlwaysRequestAnimationFrame) deprecated in Git master } deprecated in Git master: Window flag.
using Flags = Containers::EnumSet<Flag> new in Git master: Flags.
using WindowFlags = Containers::EnumSet<WindowFlag> deprecated in Git master: Window flags.

Public functions

template<class T> auto setTitle(const T&) -> Configuration&: Set window title.
auto size() const -> Vector2i: Window size.
auto setSize(const Vector2i& size, const Vector2& dpiScaling = {}) -> Configuration&: Set canvas size.
auto dpiScaling() const -> Vector2: Custom DPI scaling.
auto flags() const -> Flags new in Git master: Flags.
auto setFlags(Flags flags) -> Configuration& new in Git master: Set flags.
auto addFlags(Flags flags) -> Configuration& new in Git master: Add flags.
auto clearFlags(Flags flags) -> Configuration& new in Git master: Clear flags.
auto windowFlags() const -> EmscriptenApplication::WindowFlags: Window flags.
auto setWindowFlags(EmscriptenApplication::WindowFlags flags) -> Configuration& new in Git master: Set window flags.
auto addWindowFlags(EmscriptenApplication::WindowFlags flags) -> Configuration& new in Git master: Add window flags.
auto clearWindowFlags(EmscriptenApplication::WindowFlags flags) -> Configuration& new in Git master: Clear window flags.
auto setWindowFlags(WindowFlags flags) -> Configuration& deprecated in Git master: Set window flags.
auto addWindowFlags(WindowFlags flags) -> Configuration& deprecated in Git master: Add window flags.
auto clearWindowFlags(WindowFlags flags) -> Configuration& deprecated in Git master: Clear window flags.

Enum documentation

enum class Magnum::Platform::EmscriptenApplication::Configuration::Flag: UnsignedByte new in Git master

Flag.

Enumerators
Contextless	Do not create any GPU context. Use together with EmscriptenApplication(const Arguments&, const Configuration&), create(const Configuration&) or tryCreate(const Configuration&) to prevent implicit creation of an WebGL context. Can't be used with EmscriptenApplication(const Arguments&, const Configuration&, const GLConfiguration&), create(const Configuration&, const GLConfiguration&) or tryCreate(const Configuration&, const GLConfiguration&).
AlwaysRequestAnimationFrame	Always request the next animation frame. Disables the idle-efficient main loop described in Main loop implementation and unconditionally schedules window.requestAnimationFrame(), matching the behavior of Sdl2Application. Useful for testing or for simpler internal state when your app is going to redraw all the time anyway. Note that this does not affect how drawEvent() is executed — it depends on redraw() being called independently of this flag being set.

Enumerators

Contextless

Do not create any GPU context. Use together with EmscriptenApplication(const Arguments&, const Configuration&), create(const Configuration&) or tryCreate(const Configuration&) to prevent implicit creation of an WebGL context. Can't be used with EmscriptenApplication(const Arguments&, const Configuration&, const GLConfiguration&), create(const Configuration&, const GLConfiguration&) or tryCreate(const Configuration&, const GLConfiguration&).

AlwaysRequestAnimationFrame

Always request the next animation frame. Disables the idle-efficient main loop described in Main loop implementation and unconditionally schedules window.requestAnimationFrame(), matching the behavior of Sdl2Application. Useful for testing or for simpler internal state when your app is going to redraw all the time anyway.

Note that this does not affect how drawEvent() is executed — it depends on redraw() being called independently of this flag being set.

enum class Magnum::Platform::EmscriptenApplication::Configuration::WindowFlag: UnsignedByte

Window flag.

Enumerators

Enumerators
Contextless	Do not create any GPU context. Use together with EmscriptenApplication(const Arguments&, const Configuration&), create(const Configuration&) or tryCreate(const Configuration&) to prevent implicit creation of an WebGL context. Can't be used with EmscriptenApplication(const Arguments&, const Configuration&, const GLConfiguration&), create(const Configuration&, const GLConfiguration&) or tryCreate(const Configuration&, const GLConfiguration&). Deprecated in git master Use Flag::Contextless with setFlags(), addFlags() or clearFlags() instead.
Resizable	Resizable canvas. This causes the framebuffer to be resized when the `<canvas>` size changes, either directly or as a consequence of browser window size change. Implement viewportEvent() to react to the resizing events. Deprecated in git master Use EmscriptenApplication::WindowFlag::Resizable instead.
AlwaysRequestAnimationFrame	Always request the next animation frame. Disables the idle-efficient main loop described in Main loop implementation and unconditionally schedules window.requestAnimationFrame(), matching the behavior of Sdl2Application. Useful for testing or for simpler internal state when your app is going to redraw all the time anyway. Note that this does not affect how drawEvent() is executed — it depends on redraw() being called independently of this flag being set. Deprecated in git master Use Flag::AlwaysRequestAnimationFrame with setFlags(), addFlags() or clearFlags() instead.

Contextless

Resizable

Resizable canvas. This causes the framebuffer to be resized when the <canvas> size changes, either directly or as a consequence of browser window size change.

Implement viewportEvent() to react to the resizing events.

AlwaysRequestAnimationFrame

Note that this does not affect how drawEvent() is executed — it depends on redraw() being called independently of this flag being set.

Typedef documentation

typedef Containers::EnumSet<Flag> Magnum::Platform::EmscriptenApplication::Configuration::Flags new in Git master

Flags.

typedef Containers::EnumSet<WindowFlag> Magnum::Platform::EmscriptenApplication::Configuration::WindowFlags

Window flags.

Function documentation

template<class T>
Configuration& Magnum::Platform::EmscriptenApplication::Configuration::setTitle(const T&)

Set window title.

Returns	Reference to self (for method chaining)

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::setSize(const Vector2i& size, const Vector2& dpiScaling = {})

Set canvas size.

Parameters
size	Desired canvas size
dpiScaling	Custom DPI scaling value

Default is a zero vector, meaning a value that matches the display or canvas size is autodetected. See DPI awareness for more information. When dpiScaling is not a zero vector, this function sets the DPI scaling directly. The resulting windowSize() is size*dpiScaling and dpiScaling() is dpiScaling.

Vector2 Magnum::Platform::EmscriptenApplication::Configuration::dpiScaling() const

Custom DPI scaling.

If zero, the devices pixel ratio has a priority over this value. The --magnum-dpi-scaling option (specified via URL GET parameters) has a priority over any application-set value.

Flags Magnum::Platform::EmscriptenApplication::Configuration::flags() const new in Git master

Flags.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::setFlags(Flags flags) new in Git master

Set flags.

Returns	Reference to self (for method chaining)

Default are none. To avoid clearing default flags by accident, prefer to use addFlags() and clearFlags() instead.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::addFlags(Flags flags) new in Git master

Add flags.

Returns	Reference to self (for method chaining)

Unlike setFlags(), ORs the flags with existing instead of replacing them. Useful for preserving the defaults.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::clearFlags(Flags flags) new in Git master

Clear flags.

Returns	Reference to self (for method chaining)

Unlike setFlags(), ANDs the inverse of flags with existing instead of replacing them. Useful for removing default flags.

EmscriptenApplication::WindowFlags Magnum::Platform::EmscriptenApplication::Configuration::windowFlags() const

Window flags.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::setWindowFlags(EmscriptenApplication::WindowFlags flags) new in Git master

Set window flags.

Returns	Reference to self (for method chaining)

Default are none. To avoid clearing default flags by accident, prefer to use addWindowFlags() and clearWindowFlags() instead.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::addWindowFlags(EmscriptenApplication::WindowFlags flags) new in Git master

Add window flags.

Returns	Reference to self (for method chaining)

Unlike setWindowFlags(), ORs the flags with existing instead of replacing them. Useful for preserving the defaults.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::clearWindowFlags(EmscriptenApplication::WindowFlags flags) new in Git master

Clear window flags.

Returns	Reference to self (for method chaining)

Unlike setWindowFlags(), ANDs the inverse of flags with existing instead of replacing them. Useful for removing default flags.

Configuration& Magnum::Platform::EmscriptenApplication::Configuration::setWindowFlags(WindowFlags flags)