Enum glutin::surface::Surface

pub enum Surface<T: SurfaceTypeTrait> {
    Egl(Surface<T>),
    Glx(Surface<T>),
}

The GL surface that is used for rendering.

The GL surface is not thread safe, it can neither be Send nor Sync, so it should be created on the thread it’ll be used to render.

fn test_send<T: Send>() {}
test_send::<glutin::surface::Surface<glutin::surface::WindowSurface>>();

fn test_sync<T: Sync>() {}
test_sync::<glutin::surface::Surface<glutin::surface::WindowSurface>>();

Variants

Egl(Surface<T>)

Available on egl_backend only.

The EGL surface.

Glx(Surface<T>)

Available on glx_backend only.

The GLX surface.

Trait Implementations

impl<T: SurfaceTypeTrait> AsRawSurface for Surface<T>

fn raw_surface(&self) -> RawSurface

Get the raw handle to the surface.

impl<T: Debug + SurfaceTypeTrait> Debug for Surface<T>

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

Formats the value using the given formatter.

impl<T: SurfaceTypeTrait> GetGlDisplay for Surface<T>

type Target = Display

The display used by the object.

fn display(&self) -> Self::Target

Obtain the GL display used to create a particular GL object.

impl<T: SurfaceTypeTrait> GlSurface<T> for Surface<T>

type Context = PossiblyCurrentContext

The context to access surface data.

type SurfaceType = T

The type of the surface.

fn buffer_age(&self) -> u32

The age of the back buffer of that surface. The 0 indicates that the buffer is either a new one or we failed to get the information about its age. In both cases you must redraw the entire buffer.

fn width(&self) -> Option<u32>

The physical width of the underlying surface.

fn height(&self) -> Option<u32>

The physical height of the underlying surface.

fn is_single_buffered(&self) -> bool

Check whether the surface is single buffered.

fn swap_buffers(&self, context: &Self::Context) -> Result<()>

Swaps the underlying back buffers when the surface is not single buffered.

fn set_swap_interval( &self, context: &Self::Context, interval: SwapInterval ) -> Result<()>

Set swap interval for the surface.

fn is_current(&self, context: &Self::Context) -> bool

Check whether the surface is current on to the current thread.

fn is_current_draw(&self, context: &Self::Context) -> bool

Check whether the surface is the current draw surface to the current thread.

fn is_current_read(&self, context: &Self::Context) -> bool

Check whether the surface is the current read surface to the current thread.

fn resize(&self, context: &Self::Context, width: NonZeroU32, height: NonZeroU32)

where Self::SurfaceType: ResizeableSurface,

Resize the surface to a new size.