Struct RgbBuffer

pub struct RgbBuffer<'s, const X: usize, const Y: usize, D: HasDisplayHandle, W: HasWindowHandle> {
    pub buffer: Buffer<'s, D, W>,
    pub pixels: &'s mut [[Color; X]],
}

An RgbBuffer contains a softbuffer buffer and pixels, a mutable slice of the same data. buffer and pixels reference the same underlying data. Modifying the elements of one will affect the values of the other.

Color data is represented as a 4-element array where the first element is always 0. This will align the color data correctly for softbuffer.

Generic parameters:

• X and Y are the width and height of the surface. This should always match the actual dimensions of the underlying Surface.
• D and W are generics that should match those of the Buffer<D, W>.

Fields

buffer: Buffer<'s, D, W>

The “raw” softbuffer Buffer.

pixels: &'s mut [[Color; X]]

The “raw” RGB pixel data as a 3D array where the axes are: Y, X, and 4 (XRGB). Note that the order is: Y, X. Therefore, to get the pixel at x=4, y=5: self.pixels[y][x]. The color has four elements. The first element should always be 0, and the other three are R, G, and B: self.pixels[y][x] = [0, 200, 160, 30]; This will align the color data correctly for softbuffer.

Do not reassign the entire array! It’s a slice of self.buffer. If it’s something else, something bad might happen!

Implementations

impl<'s, const X: usize, const Y: usize, D: HasDisplayHandle, W: HasWindowHandle> RgbBuffer<'s, X, Y, D, W>

pub fn from_softbuffer(buffer: Buffer<'s, D, W>) -> Result<Self, SizeError>

Convert a Buffer into an RgbBuffer. This consumes buffer and returns an RgbBuffer. This returns an Error if X * Y != buffer.len() (i.e. if the dimensions of the RgbBuffer are invalid).

pub fn fill(&mut self, color: Color)

Fill the buffer with an [0, r, g, b] color.

pub fn set_pixels(&mut self, positions: &[[usize; 2]], color: Color)

Set the color of multiple pixels.

• positions: A slice of [x, y] positions.
• color: The [0, r, g, b] color.

Panics if any position in positions is out of bounds.

pub fn fill_rectangle( &mut self, x: usize, y: usize, w: usize, h: usize, color: Color, )

Fill a rectangle with a color.

• x and y are the coordinates of the top-left pixel.
• w and h are the width and height of the rectangle.
• color is the [0, r, g, b] color.

Panics if the top-left or bottom-right positions are out of bounds.