Struct rg3d::ContextBuilder [−][src]
pub struct ContextBuilder<'a, T> where
T: ContextCurrentState, {
pub gl_attr: GlAttributes<&'a Context<T>>,
pub pf_reqs: PixelFormatRequirements,
}
Expand description
An object that allows you to build Context
s, RawContext<T>
s and
WindowedContext<T>
s.
One notable limitation of the Wayland backend when it comes to shared
Context
s is that both contexts must use the same events loop.
Fields
gl_attr: GlAttributes<&'a Context<T>>
The attributes to use to create the context.
pf_reqs: PixelFormatRequirements
The pixel format requirements
Implementations
pub fn build_headless<TE>(
self,
el: &EventLoopWindowTarget<TE>,
size: PhysicalSize<u32>
) -> Result<Context<NotCurrent>, CreationError>
pub fn build_headless<TE>(
self,
el: &EventLoopWindowTarget<TE>,
size: PhysicalSize<u32>
) -> Result<Context<NotCurrent>, CreationError>
Builds the given GL context.
When on a unix operating system, prefer build_surfaceless
. If both
build_surfaceless
and build_headless
fail, try using a hidden
window, or build_osmesa
. Please note that if you choose to use a
hidden window, you must still handle the events it generates on the
events loop.
Errors can occur in two scenarios:
- If the window could not be created (via permission denied, incompatible system, out of memory, etc.). This should be very rare.
- If the OpenGL
Context
could not be created. This generally happens because the underlying platform doesn’t support a requested feature.
pub fn build_windowed<TE>(
self,
wb: WindowBuilder,
el: &EventLoopWindowTarget<TE>
) -> Result<ContextWrapper<NotCurrent, Window>, CreationError>
pub fn build_windowed<TE>(
self,
wb: WindowBuilder,
el: &EventLoopWindowTarget<TE>
) -> Result<ContextWrapper<NotCurrent, Window>, CreationError>
Builds the given window along with the associated GL context, returning
the pair as a WindowedContext<T>
.
Errors can occur in two scenarios:
- If the window could not be created (via permission denied, incompatible system, out of memory, etc.). This should be very rare.
- If the OpenGL
Context
could not be created. This generally happens because the underlying platform doesn’t support a requested feature.
Initializes a new ContextBuilder
with default values.
Sets how the backend should choose the OpenGL API and version.
Sets the desired OpenGL Context
profile.
Sets the debug flag for the OpenGL Context
.
The default value for this flag is cfg!(debug_assertions)
, which means
that it’s enabled when you run cargo build
and disabled when you run
cargo build --release
.
Sets the robustness of the OpenGL Context
. See the docs of
Robustness
.
Requests that the window has vsync enabled.
By default, vsync is not enabled.
Share the display lists with the given Context
.
Sets the multisampling level to request. A value of 0
indicates that
multisampling must not be enabled.
Panic
Will panic if samples
is not a power of two.
Sets the number of bits in the depth buffer.
Sets the number of bits in the stencil buffer.
Sets the number of bits in the color buffer.
Request the backend to be stereoscopic.
Sets whether sRGB should be enabled on the window.
The default value is true
.
Sets whether double buffering should be enabled.
The default value is None
.
Platform-specific
This option will be taken into account on the following platforms:
- MacOS
- Unix operating systems using GLX with X
- Windows using WGL
Sets whether hardware acceleration is required.
The default value is Some(true)
Platform-specific
This option will be taken into account on the following platforms:
- MacOS
- Unix operating systems using EGL with either X or Wayland
- Windows using EGL or WGL
- Android using EGL
Trait Implementations
pub fn build_osmesa(
self,
size: PhysicalSize<u32>
) -> Result<Context<NotCurrent>, CreationError> where
ContextBuilder<'a, T>: Sized,
pub fn build_osmesa(
self,
size: PhysicalSize<u32>
) -> Result<Context<NotCurrent>, CreationError> where
ContextBuilder<'a, T>: Sized,
Builds an OsMesa context. Read more
pub fn build_surfaceless<TE>(
self,
el: &EventLoopWindowTarget<TE>
) -> Result<Context<NotCurrent>, CreationError> where
ContextBuilder<'a, T>: Sized,
pub fn build_surfaceless<TE>(
self,
el: &EventLoopWindowTarget<TE>
) -> Result<Context<NotCurrent>, CreationError> where
ContextBuilder<'a, T>: Sized,
Builds an EGL-surfaceless context. Read more
pub unsafe fn build_raw_wayland_context(
self,
display_ptr: *const wl_display,
surface: *mut c_void,
width: u32,
height: u32
) -> Result<ContextWrapper<NotCurrent, ()>, CreationError> where
ContextBuilder<'a, T>: Sized,
pub unsafe fn build_raw_wayland_context(
self,
display_ptr: *const wl_display,
surface: *mut c_void,
width: u32,
height: u32
) -> Result<ContextWrapper<NotCurrent, ()>, CreationError> where
ContextBuilder<'a, T>: Sized,
Creates a raw context on the provided surface. Read more
pub unsafe fn build_raw_x11_context(
self,
xconn: Arc<XConnection>,
xwin: u64
) -> Result<ContextWrapper<NotCurrent, ()>, CreationError> where
ContextBuilder<'a, T>: Sized,
pub unsafe fn build_raw_x11_context(
self,
xconn: Arc<XConnection>,
xwin: u64
) -> Result<ContextWrapper<NotCurrent, ()>, CreationError> where
ContextBuilder<'a, T>: Sized,
Creates a raw context on the provided window. Read more
Auto Trait Implementations
impl<'a, T> !RefUnwindSafe for ContextBuilder<'a, T>
impl<'a, T> Send for ContextBuilder<'a, T> where
T: Sync,
impl<'a, T> Sync for ContextBuilder<'a, T> where
T: Sync,
impl<'a, T> Unpin for ContextBuilder<'a, T>
impl<'a, T> !UnwindSafe for ContextBuilder<'a, T>
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.