Merge pull request #338 from Smithay/fixes/backend

src/backend/allocator/swapchain.rs

@@ -50,9 +50,8 @@ pub struct Swapchain<A: Allocator<B>, B: Buffer, U: 'static> {
 
 /// Slot of a swapchain containing an allocated buffer and its userdata.
 ///
-/// Can be cloned and passed around freely, the buffer is marked for re-use
+/// The buffer is marked for re-use once all copies are dropped.
-/// once all copies are dropped. Holding on to this struct will block the
+/// Holding on to this struct will block the buffer in the swapchain.
-/// buffer in the swapchain.
 #[derive(Debug)]
 pub struct Slot<B: Buffer, U: 'static>(Arc<InternalSlot<B, U>>);
 

src/backend/drm/mod.rs

@@ -20,13 +20,15 @@
 //!
 //! A [`connector`](drm::control::connector) represents a port on your computer, possibly with a connected monitor, TV, capture card, etc.
 //!
-//! A [`framebuffer`](drm::control::framebuffer) represents a buffer you may be rendering to, see `DrmSurface` below.
+//! A [`framebuffer`](drm::control::framebuffer) represents a buffer you may display, see `DrmSurface` below.
 //!
 //! A [`plane`](drm::control::plane) adds another layer on top of the crtcs, which allow us to layer multiple images on top of each other more efficiently
 //! then by combining the rendered images in the rendering phase, e.g. via OpenGL. Planes have to be explicitly used by the user to be useful.
 //! Every device has at least one primary plane used to display an image to the whole crtc. Additionally cursor and overlay planes may be present.
 //! Cursor planes are usually very restricted in size and meant to be used for hardware cursors, while overlay planes may
 //! be used for performance reasons to display any overlay on top of the image, e.g. the top-most windows.
+//! Overlay planes may have a bunch of weird limitation, that you cannot query, e.g. only working on round pixel coordinates.
+//! You code should never rely on a fixed set of overlay planes, but always have a fallback solution in place.
 //!
 //! The main functionality of a `Device` in smithay is to give access to all these properties for the user to
 //! choose an appropriate rendering configuration. What that means is defined by the requirements and constraints documented
@@ -41,11 +43,11 @@
 //!
 //! A surface is a part of a `Device` that may output a picture to a number of connectors. It pumps pictures of buffers to outputs.
 //!
-//! On surface creation a matching encoder for your `encoder`-`connector` is automatically selected,
+//! On surface creation a matching encoder for your `connector` is automatically selected, if one exists(!),
-//! if it exists, which means you still need to check your configuration.
+//! which means you still need to check your configuration beforehand, even if you do not need to provide an encoder.
 //!
 //! A surface consists of one `crtc` that is rendered to by the user. This is fixed for the `Surface`s lifetime and cannot be changed.
-//! A surface also always needs at least one connector to output the resulting image to as well as a `Mode` that is valid for the given connector.
+//! A surface also always needs at least one connector to output the resulting image to as well as a `Mode` that is valid for the given connectors.
 //!
 //! The state of a `Surface` is double-buffered, meaning all operations that chance the set of `connector`s or their `Mode` are stored and
 //! only applied on the next commit. `Surface`s do their best to validate these changes, if possible.

src/backend/egl/context.rs

@@ -320,7 +320,7 @@ impl Default for PixelFormatRequirements {
 }
 
 impl PixelFormatRequirements {
-    /// Append the  requirements to the given attribute list
+    /// Append the requirements to the given attribute list
     pub fn create_attributes(&self, out: &mut Vec<c_int>, logger: &slog::Logger) {
         if let Some(hardware_accelerated) = self.hardware_accelerated {
             out.push(ffi::egl::CONFIG_CAVEAT as c_int);