Struct buffer_graphics_lib::prelude::IndexedImage

pub struct IndexedImage { /* private fields */ }

Implementations

impl IndexedImage

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

impl IndexedImage

pub fn set_palette( &mut self, palette: &[IciColor] ) -> 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: &[IciColor], 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: &[IciColor], color: C)

where C: Into<IciColor> + 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 fn get_pixels(&self) -> &[u8]

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

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

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

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

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

pub fn min_palette_size_supported(&self) -> u8

pub fn width(&self) -> u8

pub fn height(&self) -> u8

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) -> Self

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

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

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

impl StructuralEq for IndexedImage

impl StructuralPartialEq for IndexedImage