Struct HeadlessRendererBuilder

pub struct HeadlessRendererBuilder<'a> {
    pub dimensions: (u32, u32),
    pub opengl: GlAttributes<&'a HeadlessContext>,
    /* private fields */
}

Object that allows you to build headless contexts.

Fields

dimensions: (u32, u32)

The dimensions to use.

opengl: GlAttributes<&'a HeadlessContext>

The OpenGL attributes to build the context with.

Implementations

impl<'a> HeadlessRendererBuilder<'a>

pub fn new(width: u32, height: u32) -> HeadlessRendererBuilder<'a>

Initializes a new HeadlessRendererBuilder with default values.

pub fn with_gl(self, request: GlRequest) -> HeadlessRendererBuilder<'a>

Sets how the backend should choose the OpenGL API and version.

pub fn with_gl_profile(self, profile: GlProfile) -> HeadlessRendererBuilder<'a>

Sets the desired OpenGL context profile.

pub fn with_gl_debug_flag(self, flag: bool) -> HeadlessRendererBuilder<'a>

Sets the debug flag for the OpenGL context.

The default value for this flag is cfg!(ndebug), which means that it’s enabled when you run cargo build and disabled when you run cargo build --release.

pub fn with_gl_robustness( self, robustness: Robustness, ) -> HeadlessRendererBuilder<'a>

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

pub fn build(self) -> Result<HeadlessContext, CreationError>

Builds the headless context.

Error should be very rare and only occur in case of permission denied, incompatible system, out of memory, etc.

pub fn build_strict(self) -> Result<HeadlessContext, CreationError>

Builds the headless context.

The context is build in a strict way. That means that if the backend couldn’t give you what you requested, an Err will be returned.

Trait Implementations

impl<'a> Clone for HeadlessRendererBuilder<'a>

fn clone(&self) -> HeadlessRendererBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.