Struct Display

pub struct Display { /* private fields */ }

A wrapper for the EGLDisplay and its supported extensions.

Implementations

impl Display

pub unsafe fn new(raw_display: RawDisplayHandle) -> Result<Self>

Create EGL display with the native display.

Safety

raw_display must point to a valid system display. Using zero or std::ptr::null() for the display will result in using EGL_DEFAULT_DISPLAY, which is not recommended or will work on a platform with a concept of native display, like Wayland.

pub unsafe fn with_device( device: &Device, raw_display: Option<RawDisplayHandle>, ) -> Result<Self>

Create an EGL display using the specified device.

In most cases, prefer Display::new() unless you need to render off screen or use other extensions like EGLStreams.

This function may take an optional RawDisplayHandle argument. At the moment the raw_display argument is ignored and this function will return Err. This may change in the future.

Safety

If raw_display is Some, raw_display must point to a valid RawDisplayHandle::Drm. The provided [raw_display_handle::DrmDisplayHandle.fd] may be closed after calling this function.

pub fn device(&self) -> Result<Device>

Get the Device the display is using.

This function returns Err if the EGL_EXT_device_query or EGL_EXT_device_base extensions are not available.

pub fn egl(&self) -> &'static Egl

Get a reference to the initialized EGL API.

pub unsafe fn terminate(self)

Terminate the EGL display.

When the display is managed by glutin with the EGL_KHR_display_reference this function does nothing and eglTerminate will be automatically invoked during display destruction.

Safety

This function will destroy the global EGL state, even the one created and managed by other libraries. Use this function only when you’re bringing everything down.

Trait Implementations

impl AsRawDisplay for Display

fn raw_display(&self) -> RawDisplay

A raw handle to the underlying Api display.

impl Clone for Display

fn clone(&self) -> Display

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Display

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

Formats the value using the given formatter.

impl GetDisplayExtensions for Display

fn extensions(&self) -> &HashSet<&'static str>

Supported extensions by the display.

impl GlDisplay for Display

type Config = Config

A config that is used by the display.

type NotCurrentContext = NotCurrentContext

A context that is being used by the display.

type PbufferSurface = Surface<PbufferSurface>

A pbuffer surface created by the display.

type PixmapSurface = Surface<PixmapSurface>

A pixmap surface created by the display.

type WindowSurface = Surface<WindowSurface>

A window surface created by the display.

unsafe fn find_configs( &self, template: ConfigTemplate, ) -> Result<Box<dyn Iterator<Item = Self::Config> + '_>>

Find configurations matching the given template.

unsafe fn create_window_surface( &self, config: &Self::Config, surface_attributes: &SurfaceAttributes<WindowSurface>, ) -> Result<Self::WindowSurface>

Create the surface that can be used to render into native window.

unsafe fn create_pbuffer_surface( &self, config: &Self::Config, surface_attributes: &SurfaceAttributes<PbufferSurface>, ) -> Result<Self::PbufferSurface>

Create the surface that can be used to render into pbuffer.

unsafe fn create_context( &self, config: &Self::Config, context_attributes: &ContextAttributes, ) -> Result<Self::NotCurrentContext>

Create the graphics platform context.

unsafe fn create_pixmap_surface( &self, config: &Self::Config, surface_attributes: &SurfaceAttributes<PixmapSurface>, ) -> Result<Self::PixmapSurface>

Create the surface that can be used to render into pixmap.

fn get_proc_address(&self, addr: &CStr) -> *const c_void

Return the address of an OpenGL function.

fn version_string(&self) -> String

Helper to obtain the information about the underlying display.

fn supported_features(&self) -> DisplayFeatures

Get the features supported by the display.