Struct TheRGBABuffer 

pub struct TheRGBABuffer { /* private fields */ }

Implementations

impl TheRGBABuffer

TheRGBABuffer contains the pixel buffer for a canvas or icon.

pub fn empty() -> TheRGBABuffer

Create an empty buffer.

pub fn new(dim: TheDim) -> TheRGBABuffer

Creates a buffer of the given dimension.

pub fn from(buffer: Vec<u8>, width: u32, height: u32) -> TheRGBABuffer

Creates a buffer from existing data.

pub fn resize(&mut self, width: i32, height: i32)

Resizes the buffer.

pub fn is_valid(&self) -> bool

Check for size validity

pub fn dim(&self) -> &TheDim

Gets the width (stride) of the buffer.

pub fn dim_mut(&mut self) -> &mut TheDim

Gets the width (stride) of the buffer.

pub fn stride(&self) -> usize

Gets the width (stride) of the buffer.

pub fn pixels(&self) -> &[u8]

Gets a slice of the buffer.

pub fn pixels_mut(&mut self) -> &mut [u8]

Gets a mutable slice of the buffer.

pub fn set_dim(&mut self, dim: TheDim)

Set the dimension of the buffer.

pub fn is_empty(&self) -> bool

Check if the buffer is empty

pub fn len(&self) -> usize

Returns the len of the underlying Vec

pub fn allocate(&mut self)

Allocates the buffer.

pub fn extract(&self, dim: &TheDim) -> TheRGBABuffer

Extracts a sub-buffer of given dimensions from the current buffer.

pub fn copy_into(&mut self, x: i32, y: i32, other: &TheRGBABuffer)

Copy the other buffer into this buffer at the given coordinates.

pub fn copy_into_par(&mut self, x: i32, y: i32, other: &TheRGBABuffer)

Parallel version of copy_into using Rayon. Has identical clipping/safety behavior. Enabled when the rayon feature is on. When the feature is off, it falls back to the serial version.

pub fn blend_into(&mut self, x: i32, y: i32, other: &TheRGBABuffer)

Blend the other buffer into this buffer at the given coordinates (single-threaded reference path).

pub fn blend_into_par(&mut self, x: i32, y: i32, other: &TheRGBABuffer)

Blend the other buffer into this buffer at the given coordinates (adaptive parallel version). Falls back to the single-threaded path for small regions to avoid overhead.

pub fn copy_horizontal_range_into( &mut self, x: i32, y: i32, other: &TheRGBABuffer, range: Range<i32>, )

Copy the horizontal range of the other buffer into this buffer at the given coordinates.

pub fn copy_vertical_range_into( &mut self, x: i32, y: i32, other: &TheRGBABuffer, range: Range<i32>, )

Copy the vertical range of the other buffer into this buffer at the given coordinates.

pub fn scaled(&self, new_width: i32, new_height: i32) -> TheRGBABuffer

Creates a scaled version of the buffer.

pub fn scaled_into(&self, into: &mut TheRGBABuffer)

Creates a scaled version of the buffer by writing into the other buffer.

pub fn scaled_into_linear(&self, into: &mut TheRGBABuffer)

Creates a scaled version of the buffer by writing into the other buffer.

pub fn scaled_into_using_dim(&self, into: &mut TheRGBABuffer, dim: &TheDim)

Creates a scaled version of the buffer by writing into the other buffer while respecting the dimensions.

pub fn extract_region(&self, region: &TheRGBARegion) -> TheRGBABuffer

Extracts a region from the buffer.

pub fn extract_sequence( &self, sequence: &TheRGBARegionSequence, ) -> Vec<TheRGBABuffer>

Extracts the regions of the sequence from the buffer.

pub fn at_f_vec4f(&self, uv: Vec2<f32>) -> Option<Vec4<f32>>

Returns the pixel at the given UV coordinate as [f32;4]

pub fn at_f(&self, uv: Vec2<f32>) -> Option<[u8; 4]>

Returns the pixel at the given UV coordinate.

pub fn at(&self, position: Vec2<i32>) -> Option<[u8; 4]>

Returns the pixel at the given position.

pub fn at_vec4(&self, position: Vec2<i32>) -> Option<Vec4<f32>>

pub fn fill(&mut self, color: [u8; 4])

Fills the entire buffer with the given RGBA color.

pub fn multiply_by_pixel(&mut self, add: [u8; 4], pixel: [u8; 4])

Multiplies every pixel in the buffer by the given RGBA pixel (component-wise, 0-255 space).

pub fn draw_line(&mut self, x0: i32, y0: i32, x1: i32, y1: i32, color: [u8; 4])

Draws a line from (x0, y0) to (x1, y1) with the given color.

pub fn draw_horizontal_line(&mut self, x0: i32, x1: i32, y: i32, color: [u8; 4])

Draws a horizontal line from (x0, y) to (x1, y) with the given color.

pub fn draw_vertical_line(&mut self, x: i32, y0: i32, y1: i32, color: [u8; 4])

Draws a vertical line from (x, y0) to (x, y1) with the given color.

pub fn draw_rect_outline(&mut self, rect: &TheDim, color: &[u8; 4])

Draws the outline of a given rectangle

pub fn draw_rounded_rect( &mut self, dim: &TheDim, color: &[u8; 4], rounding: &(f32, f32, f32, f32), border_size: f32, border_color: &[u8; 4], )

Draws a rounded rect with a border

pub fn draw_disc( &mut self, dim: &TheDim, color: &[u8; 4], border_size: f32, border_color: &[u8; 4], )

Draws a rounded rect with a border

pub fn draw_text( &mut self, position: Vec2<i32>, font: &Font, text: &str, size: f32, color: [u8; 4], halign: TheHorizontalAlign, valign: TheVerticalAlign, )

Render an aligned text in the buffer.

pub fn pixel_index(&self, x: i32, y: i32) -> Option<usize>

Helper method to calculate the buffer index for a pixel at (x, y).

pub fn get_pixel(&self, x: i32, y: i32) -> Option<[u8; 4]>

Get a pixel at (x, y).

pub fn set_pixel(&mut self, x: i32, y: i32, color: &[u8; 4])

Sets the color of a pixel at (x, y).

pub fn to_png(&self) -> Result<Vec<u8>, EncodingError>

Convert the buffer to an RGBA PNG image.

pub fn render_hsl_hue_waveform(&mut self)

Draw an hsl hue waveform used by color pickers.

pub fn find_closest_color_position( &self, target_rgb: [u8; 3], ) -> Option<Vec2<i32>>

Finds the X position in the buffer that best matches the given RGB color. Optionally specify a Y row (defaults to center row). Finds the (x, y) position in the buffer that best matches the given RGB color.

Trait Implementations

impl Clone for TheRGBABuffer

fn clone(&self) -> TheRGBABuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TheRGBABuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TheRGBABuffer

fn default() -> TheRGBABuffer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TheRGBABuffer

fn deserialize<__D>( __deserializer: __D, ) -> Result<TheRGBABuffer, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TheRGBABuffer

fn eq(&self, other: &TheRGBABuffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TheRGBABuffer

fn partial_cmp(&self, other: &TheRGBABuffer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TheRGBABuffer

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TheRGBABuffer