Struct buffer_graphics_lib::prelude::IndexedImage

pub struct IndexedImage { /* private fields */ }

Implementations

impl IndexedImage

pub fn new( width: u8, height: u8, palette: Vec<Color>, pixels: Vec<u8> ) -> Result<IndexedImage, IndexedImageError>

pub fn blank(width: u8, height: u8, palette: Vec<Color>) -> IndexedImage

impl IndexedImage

pub fn set_palette( &mut self, palette: &[Color] ) -> Result<(), IndexedImageError>

Replace palette for image Will only return an error if the new palette has less colors than the image needs

pub fn set_palette_replace_id( &mut self, palette: &[Color], id: u8 ) -> Result<(), IndexedImageError>

Replace palette for image, any pixels outside the new palette will be replaced with id Will only return an error if id is outside the new palette

pub fn set_palette_replace_color<C>(&mut self, palette: &[Color], color: C)

where C: Into<Color> + Copy,

Replace palette for image, any color indexes outside the palette will be expanded with color

pub fn size(&self) -> (u8, u8)

pub fn set_pixel( &mut self, pixel_idx: usize, color_idx: u8 ) -> Result<(), IndexedImageError>

pub unsafe fn set_pixel_unchecked(&mut self, pixel_idx: usize, color_idx: u8)

Safety

Out of bounds may occur

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

pub fn get_pixel(&self, pixel_idx: usize) -> Result<u8, IndexedImageError>

pub unsafe fn get_pixel_unchecked(&self, pixel_idx: usize) -> u8

Safety

Out of bounds may occur

pub fn get_pixel_index(&self, x: u8, y: u8) -> Result<usize, IndexedImageError>

pub unsafe fn get_pixel_index_unchecked(&self, x: u8, y: u8) -> usize

Safety

Out of bounds may occur

pub fn get_color(&self, idx: u8) -> Result<Color, IndexedImageError>

pub unsafe fn get_color_unchecked(&self, idx: u8) -> Color

Safety

Out of bounds may occur

pub fn set_color( &mut self, idx: u8, color: Color ) -> Result<(), IndexedImageError>

pub fn set_color_unchecked(&mut self, idx: u8, color: Color)

Safety

Out of bounds may occur

pub fn get_palette(&self) -> &[Color]

pub fn min_palette_size_supported(&self) -> u8

pub fn width(&self) -> u8

pub fn height(&self) -> u8

pub fn rotate_cw(&self) -> IndexedImage

pub unsafe fn rotate_cw_unchecked(&self) -> IndexedImage

Safety

Out of bounds may occur

pub fn rotate_ccw(&self) -> IndexedImage

pub unsafe fn rotate_ccw_unchecked(&self) -> IndexedImage

Safety

Out of bounds may occur

pub fn flip_vertical(&self) -> Result<IndexedImage, IndexedImageError>

pub unsafe fn flip_vertical_unchecked(&self) -> IndexedImage

Safety

Out of bounds may occur

pub fn flip_horizontal(&self) -> Result<IndexedImage, IndexedImageError>

pub unsafe fn flip_horizontal_unchecked(&self) -> IndexedImage

Safety

Out of bounds may occur

pub fn scale(&self, algo: Scaling) -> Result<IndexedImage, IndexedImageError>

pub unsafe fn scale_unchecked(&self, algo: Scaling) -> IndexedImage

Safety

Out of bounds may occur

pub fn tint_palette_add( &self, color_diff: &[(isize, isize, isize, isize)] ) -> IndexedImage

pub fn tint_palette_mut( &self, color_diff: &[(f32, f32, f32, f32)] ) -> IndexedImage

pub fn tint_add( &self, color_diff: &(isize, isize, isize, isize) ) -> IndexedImage

pub fn tint_mul(&self, color_diff: &(f32, f32, f32, f32)) -> IndexedImage

impl IndexedImage

pub fn to_file_contents( &self, palette: &FilePalette ) -> Result<Vec<u8>, IndexedImageError>

Errors will only be returned if you FilePalette::Name and the len is invalid

pub fn from_file_contents( bytes: &[u8] ) -> Result<(IndexedImage, FilePalette), IndexedImageError>

Create an IndexedImage, image palette will be filled with transparency unless file contains colors use image.set_palette* to replace the palette

Trait Implementations

impl ChangeColors for IndexedImage

fn with_saturate(&self, amount: f32) -> IndexedImage

De/saturate color by percentage Negative amount increases saturation So -0.1 is 10% more saturated

fn with_brightness(&self, amount: f32) -> IndexedImage

Change brightness to amount So 1.1 is 10% brighter

fn saturate(&self) -> Self

where Self: Sized,

Increase saturation by 10%

fn desaturate(&self) -> Self

where Self: Sized,

Decrease saturation by 10%

fn lighten(&self) -> Self

where Self: Sized,

fn darken(&self) -> Self

where Self: Sized,

impl Clone for IndexedImage

fn clone(&self) -> IndexedImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexedImage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexedImage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<IndexedImage> for IndexedWrapper

fn from(value: IndexedImage) -> IndexedWrapper

Converts to this type from the input type.

impl PartialEq for IndexedImage

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Renderable<IndexedImage> for RenderableIndexedImage

fn render(&self, graphics: &mut Graphics<'_>)

impl Serialize for IndexedImage

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 Eq for IndexedImage

impl StructuralPartialEq for IndexedImage