Struct Image 

pub struct Image<Storage: ?Sized> { /* private fields */ }

Implementations

impl<Storage: AsRef<[u8]> + ?Sized> Image<Storage>

pub fn put_subimage_request<R>( &self, drawable: impl Into<Drawable>, gc: impl Into<Gcontext>, src_x: usize, src_y: usize, width: usize, height: usize, dst_x: i16, dst_y: i16, discard_reply: bool, raw_request_handler: impl FnOnce(RawRequest<'_, '_>) -> R, ) -> R

Get a PutImageRequest that could be used to send a part of this image to the display.

impl<Storage: AsRef<[u8]>> Image<Storage>

pub fn new( storage: Storage, width: u16, height: u16, format: Format, byte_order: ImageOrder, scanline_pad: u8, ) -> Self

Create a new Image from a Storage and its individual parameters.

pub fn with_display( storage: Storage, width: u16, height: u16, image_format: ImageFormat, depth: u8, setup: &Setup, ) -> Result<Self>

Create a new Image, but use a specific Display to set certain important values.

pub fn into_storage(self) -> Storage

Convert the image back into its Storage.

pub fn map_storage<R, F>(self, f: F) -> Image<R>

where F: FnOnce(Storage) -> R,

Map the storage for this image.

This function assumes that nothing else about the image is changed.

impl<Storage: ?Sized> Image<Storage>

pub fn depth(&self) -> u8

Get the depth of this image.

pub fn storage(&self) -> &Storage

pub fn storage_mut(&mut self) -> &mut Storage

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn format(&self) -> &Format

impl<Storage: AsRef<[u8]> + ?Sized> Image<Storage>

pub fn borrow(&self) -> Image<&[u8]>

pub fn pixel(&self, x: usize, y: usize) -> u32

Get the value of the pixel at the given coordinates.

pub fn put_image_request( &self, drawable: impl Into<Drawable>, gc: impl Into<Gcontext>, dst_x: i16, dst_y: i16, ) -> PutImageRequest<'_>

Create a PutImageRequest for this image.

pub fn crop( &self, x: usize, y: usize, width: usize, height: usize, ) -> Image<Vec<u8>>

Crop this image down to the given dimensions.

Performance

This function creates a new image and then manually copies all of the pixels from this image to that one, using the pixel and set_pixel functions. This usually leads to poor performance.

impl<Storage: AsMut<[u8]> + ?Sized> Image<Storage>

pub fn borrow_mut(&mut self) -> Image<&mut [u8]>

pub fn set_pixel(&mut self, x: usize, y: usize, pixel: u32)

Set the value of a pixel at the given coordinates.

impl Image<Vec<u8>>

pub fn from_get_image_reply( reply: GetImageReply, width: u16, height: u16, format: ImageFormat, setup: &Setup, ) -> Result<Self>

Create a new image based on a GetImageReply.

Trait Implementations

impl<Storage: ?Sized> AsMut<Storage> for Image<Storage>

fn as_mut(&mut self) -> &mut Storage

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Storage: ?Sized> AsRef<Storage> for Image<Storage>

fn as_ref(&self) -> &Storage

Converts this type into a shared reference of the (usually inferred) input type.

impl<Storage: Clone + ?Sized> Clone for Image<Storage>

fn clone(&self) -> Image<Storage>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Storage: Debug + ?Sized> Debug for Image<Storage>

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

Formats the value using the given formatter.

impl<Storage: Hash + ?Sized> Hash for Image<Storage>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Storage: Ord + ?Sized> Ord for Image<Storage>

fn cmp(&self, other: &Image<Storage>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Storage: PartialEq + ?Sized> PartialEq for Image<Storage>

fn eq(&self, other: &Image<Storage>) -> 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<Storage: PartialOrd + ?Sized> PartialOrd for Image<Storage>

fn partial_cmp(&self, other: &Image<Storage>) -> 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<Storage: Copy + ?Sized> Copy for Image<Storage>

impl<Storage: Eq + ?Sized> Eq for Image<Storage>

impl<Storage: ?Sized> StructuralPartialEq for Image<Storage>