Trait luminance_glfw::surface::Surface

pub trait Surface: GraphicsContext {
    type Event;
    type Error;
    fn new(
        dim: WindowDim, 
        title: &str, 
        win_opt: WindowOpt
    ) -> Result<Self, Self::Error>;
    fn size(&self) -> [u32; 2];
    fn wait_events(&'a mut self) -> Box<Iterator<Item = Self::Event> + 'a>;
    fn poll_events(&'a mut self) -> Box<Iterator<Item = Self::Event> + 'a>;

    fn width(&self) -> u32 { ... }
    fn height(&self) -> u32 { ... }
}

Rendering surface.

This type holds anything related to rendering. The interface is straight forward, so feel free to have a look around.

Associated Types

type Event

Type of events.

type Error

Type of surface errors.

Required Methods

fn new(
    dim: WindowDim,
    title: &str,
    win_opt: WindowOpt
) -> Result<Self, Self::Error>

Create a surface along with its associated event stream and bootstrap a luminance environment that it lives as long as the surface lives.

fn size(&self) -> [u32; 2]

Size of the surface’s framebuffer.

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn wait_events(&'a mut self) -> Box<Iterator<Item = Self::Event> + 'a>

Get an iterator over events by blocking until the first event happens.

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn poll_events(&'a mut self) -> Box<Iterator<Item = Self::Event> + 'a>

Get an iterator over events without blocking if no event is there.

Provided Methods

fn width(&self) -> u32

Width of the surface’s framebuffer.

Defaults

Defaults to .size()[0].

fn height(&self) -> u32

Height of the surface’s framebuffer.

Defaults

Defaults to .size()[1].

Implementors

• impl Surface for GlfwSurface type Event = WindowEvent; type Error = GlfwSurfaceError;