Struct DisplayBuilder

pub struct DisplayBuilder { /* private fields */ }

The helper to perform Display creation and OpenGL platform bootstrapping with the help of winit with little to no platform specific code.

This is only required for the initial setup. If you want to create additional windows just use the finalize_window function and the configuration you’ve used either for the original window or picked with the existing Display.

Implementations

impl DisplayBuilder

pub fn new() -> Self

Create new display builder.

pub fn with_preference(self, preference: ApiPreference) -> Self

The preference in picking the configuration.

pub fn with_window_attributes( self, window_attributes: Option<WindowAttributes>, ) -> Self

The window attributes to use when building a window.

By default no window is created.

pub fn build<Picker>( self, event_loop: &impl GlutinEventLoop, template_builder: ConfigTemplateBuilder, config_picker: Picker, ) -> Result<(Option<Window>, Config), Box<dyn Error>>

where Picker: FnOnce(Box<dyn Iterator<Item = Config> + '_>) -> Config,

Initialize the OpenGL platform and create a compatible window to use with it when the WindowAttributes was passed with Self::with_window_attributes(). It’s optional, since on some platforms like Android it is not available early on, so you want to find configuration and later use it with the finalize_window. But if you don’t care about such platform you can always pass WindowAttributes.

Api-specific

WGL: - WindowAttributes must be passed in Self::with_window_attributes() if modern OpenGL(ES) is desired, otherwise only builtin functions like glClear will be available.

Trait Implementations

impl Clone for DisplayBuilder

fn clone(&self) -> DisplayBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayBuilder

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

Formats the value using the given formatter.

impl Default for DisplayBuilder

fn default() -> DisplayBuilder

Returns the “default value” for a type.