doc: Document ignored damage

Damage that fall outside the surface is ignored.

Author: madsmtm

src/backends/wayland/mod.rs

@@ -260,6 +260,8 @@ impl BufferInterface for BufferImpl<'_> {
             self.surface.damage(0, 0, i32::MAX, i32::MAX);
         } else {
             for rect in damage {
+                // Damage that falls outside the surface is ignored.
+                // https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_surface
                 let x = rect.x.try_into().unwrap_or(i32::MAX);
                 let y = rect.y.try_into().unwrap_or(i32::MAX);
                 let width = rect.width.get().try_into().unwrap_or(i32::MAX);

src/lib.rs

@@ -289,6 +289,8 @@ impl Buffer<'_> {
 
     /// Presents buffer to the window, with damage regions.
     ///
+    /// Damage regions that fall outside the surface are ignored.
+    ///
     /// # Platform dependent behavior
     ///
     /// Supported on: