Magnum::Platform::EmscriptenApplication::GLConfiguration class

WebGL context configuration.

The created context is always with a double-buffered OpenGL context.

Base classes

class Magnum::GL::Context::Configuration new in Git master
Configuration.

Public types

enum class Flag: UnsignedLong { PremultipliedAlpha = 1 << 0, PreserveDrawingBuffer = 1 << 1, PreferLowPowerToHighPerformance = 1 << 2, FailIfMajorPerformanceCaveat = 1 << 3, ExplicitSwapControl = 1 << 4, EnableExtensionsByDefault = 1 << 5, RenderViaOffscreenBackBuffer = 1 << 6, ProxyContextToMainThread = 1 << 7, QuietLog = UnsignedLong(GL::Context::Configuration::Flag::QuietLog) new in Git master, VerboseLog = UnsignedLong(GL::Context::Configuration::Flag::VerboseLog) new in Git master, GpuValidation = UnsignedLong(GL::Context::Configuration::Flag::GpuValidation) new in Git master, GpuValidationNoError = UnsignedLong(GL::Context::Configuration::Flag::GpuValidationNoError) new in Git master }
Context flag.
using Flags = Containers::EnumSet<Flag>
Context flags.

Public functions

auto flags() const -> Flags
Context flags.
auto setFlags(Flags flags) -> GLConfiguration&
Set context flags.
auto addFlags(Flags flags) -> GLConfiguration&
Add context flags.
auto clearFlags(Flags flags) -> GLConfiguration&
Clear context flags.
auto setVersion(GL::Version) -> GLConfiguration&
Set context version.
auto colorBufferSize() const -> Vector4i
Color buffer size.
auto setColorBufferSize(const Vector4i& size) -> GLConfiguration&
Set color buffer size.
auto depthBufferSize() const -> Int
Depth buffer size.
auto setDepthBufferSize(Int size) -> GLConfiguration&
Set depth buffer size.
auto stencilBufferSize() const -> Int
Stencil buffer size.
auto setStencilBufferSize(Int size) -> GLConfiguration&
Set stencil buffer size.
auto sampleCount() const -> Int
Sample count.
auto setSampleCount(Int count) -> GLConfiguration&
Set sample count.

Enum documentation

enum class Magnum::Platform::EmscriptenApplication::GLConfiguration::Flag: UnsignedLong

Context flag.

Includes also everything from GL::Context::Configuration::Flag except for Flag::Windowless, which is not meant to be enabled for windowed apps.

Enumerators
PremultipliedAlpha

Premultiplied alpha. If set, the alpha channel of the rendering context will be treated as representing premultiplied alpha values. If not set, the alpha channel represents non-premultiplied alpha.

PreserveDrawingBuffer

Preserve drawing buffer. If set, the contents of the drawing buffer are preserved between consecutive drawEvent() calls. If not, color, depth and stencil are cleared before entering drawEvent(). Not setting this gives better performance.

PreferLowPowerToHighPerformance

Prefer low power to high performance. If set, the WebGL power preference will be set to reduce power consumption.

FailIfMajorPerformanceCaveat

Fail if major performance caveat. If set, requests context creation to abort if the browser is only able to create a context that does not give good hardware-accelerated performance.

ExplicitSwapControl

Explicit swap control. For more details, see the Emscripten API reference.

EnableExtensionsByDefault

Enable WebGL extensions by default. Enabled by default. For more details, see WebGL-specific behavior and the Emscripten API reference.

RenderViaOffscreenBackBuffer

Render via offscreen back buffer. For more details, see the Emscripten API reference.

ProxyContextToMainThread

Proxy content to main thread. For more details, see the Emscripten API reference.

QuietLog new in Git master

Print only warnings and errors instead of the usual startup log listing used extensions and workarounds. Ignored if Flag::VerboseLog is set.

Corresponds to the --magnum-log quiet command-line option.

VerboseLog new in Git master

Print additional information on startup in addition to the usual startup log that lists used extensions and workarounds. Has a precedence over Flag::QuietLog.

Corresponds to the --magnum-log verbose command-line option.

GpuValidation new in Git master

Enable GPU validation, if available. Has a precedence over Flag::GpuValidationNoError.

Corresponds to the --magnum-gou-validation on command-line option.

GpuValidationNoError new in Git master

Enable a context without error reporting, if available. Ignored if Flag::GpuValidation is set.

Corresponds to the --magnum-gou-validation no-error command-line option.

Typedef documentation

typedef Containers::EnumSet<Flag> Magnum::Platform::EmscriptenApplication::GLConfiguration::Flags

Context flags.

Function documentation

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setFlags(Flags flags)

Set context flags.

Returns Reference to self (for method chaining)

Default is Flag::EnableExtensionsByDefault. To avoid clearing default flags by accident, prefer to use addFlags() and clearFlags() instead.

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::addFlags(Flags flags)

Add context flags.

Returns Reference to self (for method chaining)

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

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::clearFlags(Flags flags)

Clear context 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.

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setVersion(GL::Version)

Set context version.

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setColorBufferSize(const Vector4i& size)

Set color buffer size.

Default is {8, 8, 8, 8} (8-bit-per-channel RGBA).

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setDepthBufferSize(Int size)

Set depth buffer size.

Default is 24 bits.

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setStencilBufferSize(Int size)

Set stencil buffer size.

Default is 0 bits (i.e., no stencil buffer).

GLConfiguration& Magnum::Platform::EmscriptenApplication::GLConfiguration::setSampleCount(Int count)

Set sample count.

Returns Reference to self (for method chaining)

Default is 0, thus no multisampling. See also GL::Renderer::Feature::Multisampling. Note that WebGL does not allow setting the sample count, but merely enabling or disabling multisampling. Multisampling will be enabled if sample count is greater than 0.