Struct png::Transformations
source · [−]pub struct Transformations { /* private fields */ }
Expand description
Output transformations
Many flags from libpng are not yet supported. A PR discussing/adding them would be nice.
/// Discard the alpha channel
const STRIP_ALPHA = 0x0002; // read only
/// Expand 1; 2 and 4-bit samples to bytes
const PACKING = 0x0004; // read and write
/// Change order of packed pixels to LSB first
const PACKSWAP = 0x0008; // read and write
/// Invert monochrome images
const INVERT_MONO = 0x0020; // read and write
/// Normalize pixels to the sBIT depth
const SHIFT = 0x0040; // read and write
/// Flip RGB to BGR; RGBA to BGRA
const BGR = 0x0080; // read and write
/// Flip RGBA to ARGB or GA to AG
const SWAP_ALPHA = 0x0100; // read and write
/// Byte-swap 16-bit samples
const SWAP_ENDIAN = 0x0200; // read and write
/// Change alpha from opacity to transparency
const INVERT_ALPHA = 0x0400; // read and write
const STRIP_FILLER = 0x0800; // write only
const STRIP_FILLER_BEFORE = 0x0800; // write only
const STRIP_FILLER_AFTER = 0x1000; // write only
const GRAY_TO_RGB = 0x2000; // read only
const EXPAND_16 = 0x4000; // read only
/// Similar to STRIP_16 but in libpng considering gamma?
/// Not entirely sure the documentation says it is more
/// accurate but doesn't say precisely how.
const SCALE_16 = 0x8000; // read only
Implementations
sourceimpl Transformations
impl Transformations
sourcepub const EXPAND: Self = _
pub const EXPAND: Self = _
Expand paletted images to RGB; expand grayscale images of less than 8-bit depth to 8-bit depth; and expand tRNS chunks to alpha channels.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
sourceimpl Transformations
impl Transformations
sourcepub fn normalize_to_color8() -> Transformations
pub fn normalize_to_color8() -> Transformations
Transform every input to 8bit grayscale or color.
This sets EXPAND
and STRIP_16
which is similar to the default transformation used by
this library prior to 0.17
.
Trait Implementations
sourceimpl Binary for Transformations
impl Binary for Transformations
sourceimpl BitAnd<Transformations> for Transformations
impl BitAnd<Transformations> for Transformations
type Output = Transformations
type Output = Transformations
&
operator.sourceimpl BitAndAssign<Transformations> for Transformations
impl BitAndAssign<Transformations> for Transformations
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<Transformations> for Transformations
impl BitOr<Transformations> for Transformations
sourcefn bitor(self, other: Transformations) -> Self
fn bitor(self, other: Transformations) -> Self
Returns the union of the two sets of flags.
type Output = Transformations
type Output = Transformations
|
operator.sourceimpl BitOrAssign<Transformations> for Transformations
impl BitOrAssign<Transformations> for Transformations
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<Transformations> for Transformations
impl BitXor<Transformations> for Transformations
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = Transformations
type Output = Transformations
^
operator.sourceimpl BitXorAssign<Transformations> for Transformations
impl BitXorAssign<Transformations> for Transformations
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for Transformations
impl Clone for Transformations
sourcefn clone(&self) -> Transformations
fn clone(&self) -> Transformations
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for Transformations
impl Debug for Transformations
sourceimpl Default for Transformations
impl Default for Transformations
Instantiate the default transformations, the identity transform.
sourcefn default() -> Transformations
fn default() -> Transformations
sourceimpl Extend<Transformations> for Transformations
impl Extend<Transformations> for Transformations
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<Transformations> for Transformations
impl FromIterator<Transformations> for Transformations
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for Transformations
impl Hash for Transformations
sourceimpl LowerHex for Transformations
impl LowerHex for Transformations
sourceimpl Not for Transformations
impl Not for Transformations
type Output = Transformations
type Output = Transformations
!
operator.sourceimpl Octal for Transformations
impl Octal for Transformations
sourceimpl Ord for Transformations
impl Ord for Transformations
sourcefn cmp(&self, other: &Transformations) -> Ordering
fn cmp(&self, other: &Transformations) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialEq<Transformations> for Transformations
impl PartialEq<Transformations> for Transformations
sourcefn eq(&self, other: &Transformations) -> bool
fn eq(&self, other: &Transformations) -> bool
sourceimpl PartialOrd<Transformations> for Transformations
impl PartialOrd<Transformations> for Transformations
sourcefn partial_cmp(&self, other: &Transformations) -> Option<Ordering>
fn partial_cmp(&self, other: &Transformations) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<Transformations> for Transformations
impl Sub<Transformations> for Transformations
type Output = Transformations
type Output = Transformations
-
operator.sourceimpl SubAssign<Transformations> for Transformations
impl SubAssign<Transformations> for Transformations
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.