Struct ContextAttributesBuilder

pub struct ContextAttributesBuilder { /* private fields */ }

The builder to help customizing context

Implementations

impl ContextAttributesBuilder

pub fn new() -> Self

Create new builder.

pub fn with_debug(self, debug: bool) -> Self

Sets the debug flag for the OpenGL context.

Debug contexts are usually slower, but give better error reporting. This option is ignored when using Robustness::NoError.

The default value for this flag is false.

pub fn with_sharing(self, context: &impl AsRawContext) -> Self

Share the display lists with the given context.

To get sharing working it’s recommended to use the same Config when creating contexts that are going to be shared.

Platform-specific

• Wayland: both contexts must use the same Wayland connection.

pub fn with_robustness(self, robustness: Robustness) -> Self

Sets the robustness of the OpenGL context. See the docs of Robustness.

The default is Robustness::NotRobust, because this is what typically expected when you create an OpenGL context. However for safety you should consider Robustness::RobustLoseContextOnReset.

pub fn with_release_behavior(self, release_behavior: ReleaseBehavior) -> Self

The behavior when changing the current context. See the docs of ReleaseBehavior.

The default is ReleaseBehavior::Flush.

pub fn with_profile(self, profile: GlProfile) -> Self

Set the desired OpenGL context profile. See the docs of GlProfile.

By default the profile is unspecified.

Api-specific

• macOS: not supported, the latest is picked automatically.

pub fn with_context_api(self, api: ContextApi) -> Self

Set the desired OpenGL context api. See the docs of ContextApi.

By default the supported api will be picked.

pub fn with_priority(self, priority: Priority) -> Self

Set the priority hint, which might not be honored if the API does not support it, if there are constraints on the number of high priority contexts available in the system, or system policy limits access to high priority contexts to appropriate system privilege level the context creation may fail.

By default no priority is specified, which corresponds to Priority::Medium.

Api specific

• WGL/GLX: not implemented.
• CGL: not supported.

pub fn build( self, raw_window_handle: Option<RawWindowHandle>, ) -> ContextAttributes

Build the context attributes.

The raw_window_handle isn’t required and here for WGL compatibility.

Api-specific

• WGL: you must pass a raw_window_handle if you plan to use this context with that window.

Trait Implementations

impl Clone for ContextAttributesBuilder

fn clone(&self) -> ContextAttributesBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContextAttributesBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ContextAttributesBuilder

fn default() -> ContextAttributesBuilder

Returns the “default value” for a type.