egui

Struct ColorImage

Source
pub struct ColorImage {
    pub size: [usize; 2],
    pub pixels: Vec<Color32>,
}
Expand description

A 2D RGBA color image in RAM.

Fields§

§size: [usize; 2]

width, height.

§pixels: Vec<Color32>

The pixels, row by row, from top to bottom.

Implementations§

Source§

impl ColorImage

Source

pub fn new(size: [usize; 2], color: Color32) -> ColorImage

Create an image filled with the given color.

Source

pub fn from_rgba_unmultiplied(size: [usize; 2], rgba: &[u8]) -> ColorImage

Create a ColorImage from flat un-multiplied RGBA data.

This is usually what you want to use after having loaded an image file.

Panics if size[0] * size[1] * 4 != rgba.len().

§Example using the image crate:
fn load_image_from_path(path: &std::path::Path) -> Result<egui::ColorImage, image::ImageError> {
    let image = image::io::Reader::open(path)?.decode()?;
    let size = [image.width() as _, image.height() as _];
    let image_buffer = image.to_rgba8();
    let pixels = image_buffer.as_flat_samples();
    Ok(egui::ColorImage::from_rgba_unmultiplied(
        size,
        pixels.as_slice(),
    ))
}

fn load_image_from_memory(image_data: &[u8]) -> Result<ColorImage, image::ImageError> {
    let image = image::load_from_memory(image_data)?;
    let size = [image.width() as _, image.height() as _];
    let image_buffer = image.to_rgba8();
    let pixels = image_buffer.as_flat_samples();
    Ok(ColorImage::from_rgba_unmultiplied(
        size,
        pixels.as_slice(),
    ))
}
Source

pub fn from_rgba_premultiplied(size: [usize; 2], rgba: &[u8]) -> ColorImage

Source

pub fn from_gray(size: [usize; 2], gray: &[u8]) -> ColorImage

Create a ColorImage from flat opaque gray data.

Panics if size[0] * size[1] != gray.len().

Source

pub fn from_gray_iter( size: [usize; 2], gray_iter: impl Iterator<Item = u8>, ) -> ColorImage

Alternative method to from_gray. Create a ColorImage from iterator over flat opaque gray data.

Panics if size[0] * size[1] != gray_iter.len().

Source

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

A view of the underlying data as &[u8]

Source

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

A view of the underlying data as &mut [u8]

Source

pub fn region(&self, region: &Rect, pixels_per_point: Option<f32>) -> ColorImage

Create a new Image from a patch of the current image. This method is especially convenient for screenshotting a part of the app since region can be interpreted as screen coordinates of the entire screenshot if pixels_per_point is provided for the native application. The floats of emath::Rect are cast to usize, rounding them down in order to interpret them as indices to the image data.

Panics if region.min.x > region.max.x || region.min.y > region.max.y, or if a region larger than the image is passed.

Source

pub fn from_rgb(size: [usize; 2], rgb: &[u8]) -> ColorImage

Create a ColorImage from flat RGB data.

This is what you want to use after having loaded an image file (and if you are ignoring the alpha channel - considering it to always be 0xff)

Panics if size[0] * size[1] * 3 != rgb.len().

Source

pub fn example() -> ColorImage

An example color image, useful for tests.

Source

pub fn width(&self) -> usize

Source

pub fn height(&self) -> usize

Trait Implementations§

Source§

impl Clone for ColorImage

Source§

fn clone(&self) -> ColorImage

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColorImage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColorImage

Source§

fn default() -> ColorImage

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ColorImage

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&IconData> for ColorImage

Source§

fn from(icon: &IconData) -> Self

Converts to this type from the input type.
Source§

impl From<ColorImage> for ImageData

Source§

fn from(image: ColorImage) -> ImageData

Converts to this type from the input type.
Source§

impl From<IconData> for ColorImage

Source§

fn from(icon: IconData) -> Self

Converts to this type from the input type.
Source§

impl Index<(usize, usize)> for ColorImage

Source§

type Output = Color32

The returned type after indexing.
Source§

fn index(&self, _: (usize, usize)) -> &Color32

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<(usize, usize)> for ColorImage

Source§

fn index_mut(&mut self, _: (usize, usize)) -> &mut Color32

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl PartialEq for ColorImage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ColorImage

Source§

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. Read more
Source§

impl Eq for ColorImage

Source§

impl StructuralPartialEq for ColorImage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,