wlroots 0.4.0

Wayland compositor framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use std::ptr;

use wlroots_sys::{wlr_backend, wl_display, wlr_wl_backend_create,
                  wlr_wl_output_create, wlr_input_device_is_wl, wlr_output_is_wl};

use {backend::UnsafeRenderSetupFunction,
     output::{self, Output},
     input,
     utils::{Handleable, safe_as_cstring}};

/// When the compositor is running in a nested Wayland environment.
/// e.g. your compositor is executed while the user is running Gnome+Mutter or Weston.
///
/// This is useful for testing and iterating on the design of the compositor.
#[derive(Debug, Hash, Eq, PartialEq)]
pub struct Wayland {
    pub(crate) backend: *mut wlr_backend
}

impl Wayland {
    /// Creates a new wlr_wl_backend. This backend will be created with no outputs;
    /// you must use wlr_wl_output_create to add them.
    ///
    /// The `remote` argument is the name of the host compositor wayland socket. Set
    /// to `None` for the default behaviour (WAYLAND_DISPLAY env variable or wayland-0
    /// default)
    pub unsafe fn new(display: *mut wl_display,
                      remote: Option<String>,
                      render_setup_func: Option<UnsafeRenderSetupFunction>)
                      -> Self {
        let remote_cstr = remote.map(|remote| safe_as_cstring(remote));
        let remote_ptr = remote_cstr.as_ref()
            .map(|s| s.as_ptr())
            .unwrap_or_else(|| ptr::null_mut());
        let backend = wlr_wl_backend_create(display, remote_ptr, render_setup_func);
        if backend.is_null() {
            panic!("Could not construct Wayland backend");
        }
        Wayland { backend }
    }


    /// Adds a new output to this backend.
    ///
    /// You may remove outputs by destroying them.
    ///
    /// Note that if called before initializing the backend, this will return None
    /// and your outputs will be created during initialization (and given to you via
    /// the output_add signal).
    pub fn create_output(&self) -> Option<output::Handle> {
        unsafe {
            let output_ptr = wlr_wl_output_create(self.backend);
            if output_ptr.is_null() {
                None
            } else {
                Some(output::Handle::from_ptr(output_ptr))
            }

        }
    }

    /// True if the given input device is a wlr_wl_input_device.
    pub fn is_wl_input_device(&self, input_device: &input::Device) -> bool {
        unsafe {
            wlr_input_device_is_wl(input_device.as_ptr())
        }
    }

    /// True if the given output is a wlr_wl_output.
    pub fn is_wl_output_device(&self, output: &Output) -> bool {
        unsafe {
            wlr_output_is_wl(output.as_ptr())
        }
    }
}