pub struct ZwpLinuxDmabufV1 { /* private fields */ }
Expand description
factory for creating dmabuf-based wl_buffers
Following the interfaces from: https://www.khronos.org/registry/egl/extensions/EXT/EGL_EXT_image_dma_buf_import.txt https://www.khronos.org/registry/EGL/extensions/EXT/EGL_EXT_image_dma_buf_import_modifiers.txt and the Linux DRM sub-system’s AddFb2 ioctl.
This interface offers ways to create generic dmabuf-based wl_buffers.
Clients can use the get_surface_feedback request to get dmabuf feedback for a particular surface. If the client wants to retrieve feedback not tied to a surface, they can use the get_default_feedback request.
The following are required from clients:
-
Clients must ensure that either all data in the dma-buf is coherent for all subsequent read access or that coherency is correctly handled by the underlying kernel-side dma-buf implementation.
-
Don’t make any more attachments after sending the buffer to the compositor. Making more attachments later increases the risk of the compositor not being able to use (re-import) an existing dmabuf-based wl_buffer.
The underlying graphics stack must ensure the following:
- The dmabuf file descriptors relayed to the server will stay valid for the whole lifetime of the wl_buffer. This means the server may at any time use those fds to import the dmabuf into any kernel sub-system that might accept it.
However, when the underlying graphics stack fails to deliver the promise, because of e.g. a device hot-unplug which raises internal errors, after the wl_buffer has been successfully created the compositor must not raise protocol errors to the client when dmabuf import later fails.
To create a wl_buffer from one or more dmabufs, a client creates a zwp_linux_dmabuf_params_v1 object with a zwp_linux_dmabuf_v1.create_params request. All planes required by the intended format are added with the ‘add’ request. Finally, a ‘create’ or ‘create_immed’ request is issued, which has the following outcome depending on the import success.
The ‘create’ request,
- on success, triggers a ‘created’ event which provides the final wl_buffer to the client.
- on failure, triggers a ‘failed’ event to convey that the server cannot use the dmabufs received from the client.
For the ‘create_immed’ request,
- on success, the server immediately imports the added dmabufs to create a wl_buffer. No event is sent from the server in this case.
- on failure, the server can choose to either:
- terminate the client by raising a fatal error.
- mark the wl_buffer as failed, and send a ‘failed’ event to the client. If the client uses a failed wl_buffer as an argument to any request, the behaviour is compositor implementation-defined.
For all DRM formats and unless specified in another protocol extension, pre-multiplied alpha is used for pixel values.
Unless specified otherwise in another protocol extension, implicit synchronization is used. In other words, compositors and clients must wait and signal fences implicitly passed via the DMA-BUF’s reservation mechanism.
See also the Event enum for this interface.
Implementations§
source§impl ZwpLinuxDmabufV1
impl ZwpLinuxDmabufV1
sourcepub fn destroy(&self)
pub fn destroy(&self)
unbind the factory
Objects created through this interface, especially wl_buffers, will remain valid.
sourcepub fn create_params<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxBufferParamsV1, U> + 'static>(
&self,
qh: &QueueHandle<D>,
udata: U,
) -> ZwpLinuxBufferParamsV1
pub fn create_params<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxBufferParamsV1, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> ZwpLinuxBufferParamsV1
create a temporary object for buffer parameters
This temporary object is used to collect multiple dmabuf handles into a single batch to create a wl_buffer. It can only be used once and should be destroyed after a ‘created’ or ‘failed’ event has been received.
sourcepub fn get_default_feedback<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxDmabufFeedbackV1, U> + 'static>(
&self,
qh: &QueueHandle<D>,
udata: U,
) -> ZwpLinuxDmabufFeedbackV1
pub fn get_default_feedback<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxDmabufFeedbackV1, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> ZwpLinuxDmabufFeedbackV1
get default feedback
This request creates a new wp_linux_dmabuf_feedback object not bound to a particular surface. This object will deliver feedback about dmabuf parameters to use if the client doesn’t support per-surface feedback (see get_surface_feedback).
sourcepub fn get_surface_feedback<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxDmabufFeedbackV1, U> + 'static>(
&self,
surface: &WlSurface,
qh: &QueueHandle<D>,
udata: U,
) -> ZwpLinuxDmabufFeedbackV1
pub fn get_surface_feedback<U: Send + Sync + 'static, D: Dispatch<ZwpLinuxDmabufFeedbackV1, U> + 'static>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> ZwpLinuxDmabufFeedbackV1
get feedback for a surface
This request creates a new wp_linux_dmabuf_feedback object for the specified wl_surface. This object will deliver feedback about dmabuf parameters to use for buffers attached to this surface.
If the surface is destroyed before the wp_linux_dmabuf_feedback object, the feedback object becomes inert.
Trait Implementations§
source§impl Borrow<ObjectId> for ZwpLinuxDmabufV1
impl Borrow<ObjectId> for ZwpLinuxDmabufV1
source§impl Clone for ZwpLinuxDmabufV1
impl Clone for ZwpLinuxDmabufV1
source§fn clone(&self) -> ZwpLinuxDmabufV1
fn clone(&self) -> ZwpLinuxDmabufV1
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ZwpLinuxDmabufV1
impl Debug for ZwpLinuxDmabufV1
source§impl Hash for ZwpLinuxDmabufV1
impl Hash for ZwpLinuxDmabufV1
source§impl PartialEq<Weak<ZwpLinuxDmabufV1>> for ZwpLinuxDmabufV1
impl PartialEq<Weak<ZwpLinuxDmabufV1>> for ZwpLinuxDmabufV1
source§impl PartialEq for ZwpLinuxDmabufV1
impl PartialEq for ZwpLinuxDmabufV1
source§impl Proxy for ZwpLinuxDmabufV1
impl Proxy for ZwpLinuxDmabufV1
source§fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
source§fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
source§fn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
source§fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
source§fn send_constructor<I: Proxy>(
&self,
req: Self::Request<'_>,
data: Arc<dyn ObjectData>,
) -> Result<I, InvalidId>
fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>
source§fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
source§fn inert(backend: WeakBackend) -> Self
fn inert(backend: WeakBackend) -> Self
source§fn parse_event(
conn: &Connection,
msg: Message<ObjectId, OwnedFd>,
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>
source§fn write_request<'a>(
&self,
conn: &Connection,
msg: Self::Request<'a>,
) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
impl Eq for ZwpLinuxDmabufV1
Auto Trait Implementations§
impl Freeze for ZwpLinuxDmabufV1
impl !RefUnwindSafe for ZwpLinuxDmabufV1
impl Send for ZwpLinuxDmabufV1
impl Sync for ZwpLinuxDmabufV1
impl Unpin for ZwpLinuxDmabufV1
impl !UnwindSafe for ZwpLinuxDmabufV1
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.