Struct Display

Source

pub struct Display(/* private fields */);

Expand description

A handle to the platform-specific display backend.

On X11, for instance, it wraps a connection to the X server.

Implementations§

Source §

impl<'dpy> Display

Source

pub fn open() -> Result<Self, Error>

Attempts to get one handle to the platform-specific display backend.

You should need only one.

Examples found in repository ?

examples/window.rs (line 8)

7fn main() {
8    let display = Display::open().expect("Could not open display!");
9    let window = display.create_window(&Default::default()).expect("Couldn't create window!");
10    window.set_title("Three");
11    window.show();
12    sleep(Duration::from_secs(1));
13    window.set_title("Two");
14    sleep(Duration::from_secs(1));
15    window.set_title("One");
16    sleep(Duration::from_secs(1));
17}

Source

pub fn open_x11_display_name(name: Option<&CStr>) -> Result<Self, Error>

X11-only specialization of open() where you can specify the name given to XOpenDisplay().

Source

pub fn create_window( &'dpy self, settings: &Settings, ) -> Result<Window<'dpy>, Error>

Attempts to create a Window with the given settings.

Examples found in repository ?

examples/window.rs (line 9)

7fn main() {
8    let display = Display::open().expect("Could not open display!");
9    let window = display.create_window(&Default::default()).expect("Couldn't create window!");
10    window.set_title("Three");
11    window.show();
12    sleep(Duration::from_secs(1));
13    window.set_title("Two");
14    sleep(Duration::from_secs(1));
15    window.set_title("One");
16    sleep(Duration::from_secs(1));
17}

Source

pub fn create_window_and_show( &'dpy self, settings: &Settings, ) -> Result<Window<'dpy>, Error>

Same as create_window(), but immediately shows the window afterwards if it succeeds.

Source

pub fn create_gl_context( &'dpy self, settings: &GLContextSettings<'_>, ) -> Result<GLContext<'dpy>, Error>

Attempts to create a backend-specific OpenGL context.

Source

pub fn create_software_gl_context( &'dpy self, settings: &GLContextSettings<'_>, ) -> Result<GLContext<'dpy>, Error>

Sames as create_gl_context(), but attempts to get a context that is not hardware-accelerated (on some platforms, this might try to load the Mesa driver). The use case for this is simple apps that don’t specifically need a lot of perf, and would rather prefer saving battery power.

This won’t attempt to fall back to the default implementation - in other words, this will succeed only if it is certain that there is a software implementation available AND a context could be created out of it.

Source