Struct ConfigTemplateBuilder

pub struct ConfigTemplateBuilder { /* private fields */ }

Builder for the ConfigTemplate.

Implementations

impl ConfigTemplateBuilder

pub fn new() -> Self

Create a new configuration template builder.

pub fn with_alpha_size(self, alpha_size: u8) -> Self

Number of alpha bits in the color buffer.

By default 8 is requested.

pub fn with_float_pixels(self, float_pixels: bool) -> Self

Whether the floating pixel formats should be used.

By default false is requested.

pub fn with_stencil_size(self, stencil_size: u8) -> Self

Number of bits in the stencil buffer.

By default 0 is requested.

pub fn with_depth_size(self, depth_size: u8) -> Self

Number of bits in the depth buffer.

By default 0 is requested.

pub fn with_multisampling(self, num_samples: u8) -> Self

Whether multisampling configurations should be picked. The num_samples must be a power of two.

By default multisampling is not specified.

pub fn with_surface_type(self, config_surface_types: ConfigSurfaceTypes) -> Self

The types of the surfaces that must be supported by the configuration.

By default only the WINDOW bit is set.

pub fn with_buffer_type(self, color_buffer_type: ColorBufferType) -> Self

The type of the color buffer.

By default RGB buffer with all components sizes of 8 is requested.

pub fn with_api(self, api: Api) -> Self

The set of apis that are supported by this configuration.

The default Api depends on the used graphics platform interface. If you want to do config filtering based on the Api yourself, use Api::empty.

Api-specific

• EGL: Api::GLES2 bit is set by default to avoid matching Api::GLES1 configs;
• GLX/WGL/CGL: Api::OPENGL is always present in the result.

pub fn with_stereoscopy(self, stereoscopy: Option<bool>) -> Self

Whether the stereo pairs should be present.

By default it isn’t specified.

pub fn with_single_buffering(self, single_buffering: bool) -> Self

Whether the single buffer should be used.

By default false is requested.

pub fn with_transparency(self, transparency: bool) -> Self

Whether the configuration should support transparency.

The default is false.

Api-specific

EGL on X11 doesn’t provide a way to create a transparent surface at the time of writing. Use GLX for that instead.

pub fn with_pbuffer_sizes(self, width: NonZeroU32, height: NonZeroU32) -> Self

With the maximum sizes of pbuffer.

pub fn prefer_hardware_accelerated( self, hardware_accerelated: Option<bool>, ) -> Self

Whether the configuration should prefer hardware accelerated formats or not.

By default hardware acceleration or its absence is not requested.

pub fn compatible_with_native_window( self, native_window: RawWindowHandle, ) -> Self

Request config that can render to a particular native window.

Platform-specific

This will use native window when matching the config to get the best one suitable for rendering into that window.

When using WGL it’s the most reliable way to get a working configuration. With GLX it’ll use the visual passed in native_window to match the config.

pub fn with_swap_interval( self, min_swap_interval: Option<u16>, max_swap_interval: Option<u16>, ) -> Self

With supported swap intervals.

By default the value isn’t specified.

Api-specific

Only supported with EGL.

pub fn build(self) -> ConfigTemplate

Build the template to match the configs against.

Trait Implementations

impl Clone for ConfigTemplateBuilder

fn clone(&self) -> ConfigTemplateBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigTemplateBuilder

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

Formats the value using the given formatter.

impl Default for ConfigTemplateBuilder

fn default() -> ConfigTemplateBuilder

Returns the “default value” for a type.