Struct wayland_client::cursor::CursorImageBuffer

pub struct CursorImageBuffer<'a> { /* fields omitted */ }

A buffer containing a cursor image.

You can access the Proxy<WlBuffer> via Deref.

Note that this proxy will be considered as "unmanaged" by the crate, as such you should not try to act on it beyond assigning it to wl_surfaces.

Methods from Deref<Target = Proxy<WlBuffer>>

pub fn send(&self, msg: I::Request)

Send a request through this object

Warning: This method is mostly intended to be used by code generated by wayland-scanner, and you should probably never need to use it directly, but rather use the appropriate RequestsTrait for your proxy.

This is the generic method to send requests.

If your request needs to create an object, use send_constructor.

pub fn send_constructor<J, F>(
    &self,
    msg: I::Request,
    implementor: F,
    version: Option<u32>
) -> Result<Proxy<J>, ()> where
    J: Interface,
    F: FnOnce(NewProxy<J>) -> Proxy<J>, 

Send a request creating an object through this object

Warning: This method is mostly intended to be used by code generated by wayland-scanner, and you should probably never need to use it directly, but rather use the appropriate RequestsTrait for your proxy.

This is the generic method to send requests that create objects

The slot in the message corresponding with the newly created object must have been filled by a placeholder object (see child_placeholder).

pub fn is_alive(&self) -> bool

Check if the object associated with this proxy is still alive

Will return false if the object has been destroyed.

If the object is not managed by this library, this will always returns true.

pub fn version(&self) -> u32

Retrieve the interface version of this wayland object instance

Returns 0 on dead objects

pub fn id(&self) -> u32

Retrieve the object id of this wayland object

pub fn user_data<UD: 'static>(&self) -> Option<&UD>

Access the arbitrary payload associated to this object

You need to specify the expected type of this payload, and this function will return None if either the types don't match or you are attempting to access a non Send + Sync user data from the wrong thread.

This value is associated to the Proxy when you implement it, and you cannot access it mutably afterwards. If you need interior mutability, you are responsible for using a Mutex or similar type to achieve it.

pub fn equals(&self, other: &Proxy<I>) -> bool

Check if the other proxy refers to the same underlying wayland object

pub fn child<C: Interface>(&self) -> NewProxy<C>

Create a new child object

Warning: This method is mostly intended to be used by code generated by wayland-scanner, and you should probably never need to use it directly, but rather use the appropriate RequestsTrait for your proxy.

This creates a new wayland object, considered as a child of this object. It will notably inherit its interface version.

The created object should immediately be implemented and sent in a request to the server, to keep the object list properly synchronized. Failure to do so will likely cause a protocol error.

pub fn anonymize(&self) -> Proxy<AnonymousObject>

Creates a handle of this proxy with its actual type erased

pub fn make_wrapper(&self, queue: &QueueToken) -> Result<Proxy<I>, ()>

Create a wrapper for this object for queue management

As assigning a proxy to an event queue can be a racy operation in contexts involving multiple thread, this provides a facility to do this safely.

The wrapper object created behaves like a regular Proxy, except that all objects created as the result of its requests will be assigned to the queue associated to the provided token, rather than the queue of their parent. This does not change the queue of the proxy itself.

pub fn child_placeholder<J: Interface>(&self) -> Proxy<J>

Create a placeholder object, to be used with send_constructor

Warning: This method is mostly intended to be used by code generated by wayland-scanner, and you should probably never need to use it directly, but rather use the appropriate RequestsTrait for your proxy.

pub fn is_external(&self) -> bool

Check whether this proxy is managed by the library or not

See from_c_ptr for details.

pub fn c_ptr(&self) -> *mut wl_proxy

Get a raw pointer to the underlying wayland object

Retrieve a pointer to the object from the libwayland-client.so library. You will mostly need it to interface with C libraries needing access to wayland objects (to initialize an opengl context for example).

Trait Implementations

impl<'a> Send for CursorImageBuffer<'a>

impl<'a> Deref for CursorImageBuffer<'a>

type Target = Proxy<WlBuffer>

The resulting type after dereferencing.

fn deref(&self) -> &Proxy<WlBuffer>

Dereferences the value.