vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

shm: detail what SHM is

This commit is contained in:
Victor Berger 2017-02-22 19:36:52 +01:00
parent 00b6f3db2c
commit 4fc1e44f62
No known key found for this signature in database
GPG Key ID: 3638519DDEAAD525
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/shm/mod.rs
View File

@ -2,6 +2,15 @@
//! //!
//! This module provides helpers to handle SHM-based buffers from wayland clients. //! This module provides helpers to handle SHM-based buffers from wayland clients.
//! //!
//! SHM (Shared Memory) is the most basic way wayland clients can send content to
//! the compositor: by sending a file descriptor to some (likely RAM-backed) storage
//! containing the actual data. This helper handles for you most of the logic for
//! handling these file descriptor and accessing their contents as simple `&[u8]` slices.
//!
//! This module is heavily inspired from
//! [the similar helpers](https://cgit.freedesktop.org/wayland/wayland/tree/src/wayland-shm.c)
//! of the wayland C libraries.
//!
//! To use it, first add a `ShmGlobal` to your event loop, specifying the formats //! To use it, first add a `ShmGlobal` to your event loop, specifying the formats
//! you want to support (ARGB8888 and XRGB8888 are always considered as supported, //! you want to support (ARGB8888 and XRGB8888 are always considered as supported,
//! as specified by the wayland protocol) and obtain its `ShmGlobalToken`. //! as specified by the wayland protocol) and obtain its `ShmGlobalToken`.
@ -47,7 +56,7 @@
//! //!
//! **Note** //! **Note**
//! //!
//! This handler makes itself safe regading the client providing a wring size for the memory pool //! This handler makes itself safe regading the client providing a wrong size for the memory pool
//! by using a SIGBUS handler. //! by using a SIGBUS handler.
//! //!
//! If you are already using an handler for this signal, you probably don't want to use this handler. //! If you are already using an handler for this signal, you probably don't want to use this handler.