Enum Orientation

pub enum Orientation {
    NoTransforms,
    Rotate90,
    Rotate180,
    Rotate270,
    FlipHorizontal,
    FlipVertical,
    Rotate90FlipH,
    Rotate270FlipH,
}

Describes the transformations to be applied to the image. Compatible with Exif orientation.

Orientation is specified in the file’s metadata, and is often written by cameras.

You can apply it to an image via DynamicImage::apply_orientation.

Variants

NoTransforms

Do not perform any transformations.

Rotate90

Rotate by 90 degrees clockwise.

Rotate180

Rotate by 180 degrees. Can be performed in-place.

Rotate270

Rotate by 270 degrees clockwise. Equivalent to rotating by 90 degrees counter-clockwise.

FlipHorizontal

Flip horizontally. Can be performed in-place.

FlipVertical

Flip vertically. Can be performed in-place.

Rotate90FlipH

Rotate by 90 degrees clockwise and flip horizontally.

Rotate270FlipH

Rotate by 270 degrees clockwise and flip horizontally.

Implementations

impl Orientation

pub fn from_exif(exif_orientation: u8) -> Option<Orientation>

Converts from Exif orientation

pub fn to_exif(self) -> u8

Converts into Exif orientation

pub fn from_exif_chunk(chunk: &[u8]) -> Option<Orientation>

Extracts the image orientation from a raw Exif chunk.

You can obtain the Exif chunk using ImageDecoder::exif_metadata.

It is more convenient to use ImageDecoder::orientation than to invoke this function. Only use this function if you extract and process the Exif chunk separately.

pub fn remove_from_exif_chunk(chunk: &mut [u8]) -> Option<Orientation>

Extracts the image orientation from a raw Exif chunk and sets the orientation in the Exif chunk to Orientation::NoTransforms. This is useful if you want to apply the orientation yourself, and then encode the image with the rest of the Exif chunk intact.

If the orientation data is not cleared from the Exif chunk after you apply the orientation data yourself, the image will end up being rotated once again by any software that correctly handles Exif, leading to an incorrect result.

If the Exif value is present but invalid, None is returned and the Exif chunk is not modified.

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Orientation

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

Formats the value using the given formatter.

impl Hash for Orientation

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

where __H: Hasher,

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 PartialEq for Orientation

fn eq(&self, other: &Orientation) -> 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 Copy for Orientation

impl Eq for Orientation

impl StructuralPartialEq for Orientation