Add Buffer::byte_stride

Author: madsmtm

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Added `Buffer::pixels()` for accessing the buffer's pixel data.
 - Added `Buffer::pixel_rows()` for iterating over rows of the buffer data.
 - Added `Buffer::pixels_iter()` for iterating over each pixel with its associated `x`/`y` coordinate.
+- Added `Buffer::byte_stride()` for pixel buffers whose rows are aligned and may contain padding bytes at the end. Prefer to use the above helpers instead of accessing pixel data directly.
 - **Breaking:** Add `Pixel` struct, and use that for pixels instead of `u32`.
 - **Breaking:** The pixel format is now target-dependent. Access `PixelFormat::default()` to see which format is used on the current platform.
 - **Breaking:** Removed generic type parameters `D` and `W` from `Buffer<'_>` struct.

examples/animation.rs

@@ -23,7 +23,7 @@ fn main() {
             let window = util::make_window(event_loop, |w| w);
 
             let old_size = (0, 0);
-            let frames = pre_render_frames(0, 0);
+            let frames = pre_render_frames(0, 0, 0);
 
             (window, old_size, frames)
         },
@@ -64,7 +64,7 @@ fn main() {
                 let size = (buffer.width().get(), buffer.height().get());
                 if size != *old_size {
                     *old_size = size;
-                    *frames = pre_render_frames(size.0, size.1);
+                    *frames = pre_render_frames(buffer.byte_stride().get() / 4, size.0, size.1);
                 }
 
                 let frame = &frames[((elapsed * 60.0).round() as usize).clamp(0, 59)];
@@ -94,11 +94,11 @@ fn main() {
     util::run_app(event_loop, app);
 }
 
-fn pre_render_frames(width: u32, height: u32) -> Vec<Vec<Pixel>> {
+fn pre_render_frames(stride: u32, width: u32, height: u32) -> Vec<Vec<Pixel>> {
     let render = |frame_id| {
         let elapsed = ((frame_id as f64) / (60.0)) * 2.0 * PI;
 
-        let coords = (0..height).flat_map(|x| (0..width).map(move |y| (x, y)));
+        let coords = (0..height).flat_map(|x| (0..stride).map(move |y| (x, y)));
         coords
             .map(|(x, y)| {
                 let y = (y as f64) / (height as f64);

examples/fruit.rs

@@ -52,10 +52,10 @@ fn main() {
                 };
 
                 let mut buffer = surface.buffer_mut().unwrap();
-                let width = fruit.width();
+                let stride = buffer.byte_stride().get() / 4;
                 for (x, y, pixel) in fruit.pixels() {
                     let pixel = Pixel::new_rgb(pixel.0[0], pixel.0[1], pixel.0[2]);
-                    buffer.pixels()[(y * width + x) as usize] = pixel;
+                    buffer.pixels()[(y * stride + x) as usize] = pixel;
                 }
 
                 buffer.present().unwrap();

src/backend_dispatch.rs

@@ -146,6 +146,16 @@ macro_rules! make_dispatch {
         }
 
         impl BufferInterface for BufferDispatch<'_> {
+            #[inline]
+            fn byte_stride(&self) -> NonZeroU32 {
+                match self {
+                    $(
+                        $(#[$attr])*
+                        Self::$name(inner) => inner.byte_stride(),
+                    )*
+                }
+            }
+
             #[inline]
             fn width(&self) -> NonZeroU32 {
                 match self {

src/backend_interface.rs

@@ -35,6 +35,7 @@ pub(crate) trait SurfaceInterface<D: HasDisplayHandle + ?Sized, W: HasWindowHand
 }
 
 pub(crate) trait BufferInterface {
+    fn byte_stride(&self) -> NonZeroU32;
     fn width(&self) -> NonZeroU32;
     fn height(&self) -> NonZeroU32;
     fn pixels_mut(&mut self) -> &mut [Pixel];

src/backends/android.rs

@@ -124,6 +124,10 @@ pub struct BufferImpl<'a> {
 unsafe impl Send for BufferImpl<'_> {}
 
 impl BufferInterface for BufferImpl<'_> {
+    fn byte_stride(&self) -> NonZeroU32 {
+        NonZeroU32::new(self.width().get() * 4).unwrap()
+    }
+
     fn width(&self) -> NonZeroU32 {
         NonZeroU32::new(self.native_window_buffer.width() as u32).unwrap()
     }

src/backends/cg.rs

@@ -279,6 +279,10 @@ pub struct BufferImpl<'a> {
 }
 
 impl BufferInterface for BufferImpl<'_> {
+    fn byte_stride(&self) -> NonZeroU32 {
+        NonZeroU32::new(self.width().get() * 4).unwrap()
+    }
+
     fn width(&self) -> NonZeroU32 {
         NonZeroU32::new(self.width as u32).unwrap()
     }

src/backends/kms.rs

@@ -308,6 +308,10 @@ impl<D: ?Sized, W: ?Sized> Drop for KmsImpl<D, W> {
 }
 
 impl BufferInterface for BufferImpl<'_> {
+    fn byte_stride(&self) -> NonZeroU32 {
+        NonZeroU32::new(self.width().get() * 4).unwrap()
+    }
+
     fn width(&self) -> NonZeroU32 {
         self.size.0
     }

src/backends/orbital.rs

@@ -153,6 +153,10 @@ pub struct BufferImpl<'a> {
 }
 
 impl BufferInterface for BufferImpl<'_> {
+    fn byte_stride(&self) -> NonZeroU32 {
+        NonZeroU32::new(self.width().get() * 4).unwrap()
+    }
+
     fn width(&self) -> NonZeroU32 {
         NonZeroU32::new(self.width as u32).unwrap()
     }

src/backends/wayland/mod.rs

@@ -219,6 +219,10 @@ pub struct BufferImpl<'a> {
 }
 
 impl BufferInterface for BufferImpl<'_> {
+    fn byte_stride(&self) -> NonZeroU32 {
+        NonZeroU32::new(self.width as u32 * 4).unwrap()
+    }
+
     fn width(&self) -> NonZeroU32 {
         NonZeroU32::new(self.width as u32).unwrap()
     }