Struct blend2d::image::FormatFlags

pub struct FormatFlags { /* fields omitted */ }

Pixel format flags.

Methods

impl FormatFlags

pub const RGB: FormatFlags

Pixel format provides RGB components.

pub const ALPHA: FormatFlags

Pixel format provides only alpha component.

pub const RGBA: FormatFlags

A combination of RGB | ALPHA.

pub const LUM: FormatFlags

Pixel format provides LUM component (and not RGB components).

pub const LUMA: FormatFlags

A combination of BL_FORMAT_FLAG_LUM | BL_FORMAT_FLAG_ALPHA.

pub const INDEXED: FormatFlags

Indexed pixel format the requres a palette (I/O only).

pub const PREMULTIPLIED: FormatFlags

RGB components are premultiplied by alpha component.

pub const BYTE_SWAP: FormatFlags

Pixel format doesn't use native byte-order (I/O only).

pub const BYTE_ALIGNED: FormatFlags

Pixel components are byte aligned (all 8bpp).

pub fn empty() -> FormatFlags

Returns an empty set of flags.

pub fn all() -> FormatFlags

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<FormatFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u32) -> FormatFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: FormatFlags) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: FormatFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: FormatFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: FormatFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: FormatFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: FormatFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl PartialEq<FormatFlags> for FormatFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for FormatFlags

fn clone(&self) -> FormatFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<FormatFlags> for FormatFlags

fn partial_cmp(&self, other: &FormatFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FormatFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FormatFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FormatFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FormatFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for FormatFlags

impl Extend<FormatFlags> for FormatFlags

fn extend<T: IntoIterator<Item = FormatFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Ord for FormatFlags

fn cmp(&self, other: &FormatFlags) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Copy for FormatFlags

impl Debug for FormatFlags

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

Formats the value using the given formatter.

impl Sub<FormatFlags> for FormatFlags

type Output = FormatFlags

The resulting type after applying the - operator.

fn sub(self, other: FormatFlags) -> FormatFlags

Returns the set difference of the two sets of flags.

impl SubAssign<FormatFlags> for FormatFlags

fn sub_assign(&mut self, other: FormatFlags)

Disables all flags enabled in the set.

impl Not for FormatFlags

type Output = FormatFlags

The resulting type after applying the ! operator.

fn not(self) -> FormatFlags

Returns the complement of this set of flags.

impl BitAnd<FormatFlags> for FormatFlags

type Output = FormatFlags

The resulting type after applying the & operator.

fn bitand(self, other: FormatFlags) -> FormatFlags

Returns the intersection between the two sets of flags.

impl BitOr<FormatFlags> for FormatFlags

type Output = FormatFlags

The resulting type after applying the | operator.

fn bitor(self, other: FormatFlags) -> FormatFlags

Returns the union of the two sets of flags.

impl BitXor<FormatFlags> for FormatFlags

type Output = FormatFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: FormatFlags) -> FormatFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<FormatFlags> for FormatFlags

fn bitand_assign(&mut self, other: FormatFlags)

Disables all flags disabled in the set.

impl BitOrAssign<FormatFlags> for FormatFlags

fn bitor_assign(&mut self, other: FormatFlags)

Adds the set of flags.

impl BitXorAssign<FormatFlags> for FormatFlags

fn bitxor_assign(&mut self, other: FormatFlags)

Toggles the set of flags.

impl Hash for FormatFlags

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, 

Feeds a slice of this type into the given [Hasher].

impl FromIterator<FormatFlags> for FormatFlags

fn from_iter<T: IntoIterator<Item = FormatFlags>>(iterator: T) -> FormatFlags

Creates a value from an iterator.

impl Octal for FormatFlags

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

Formats the value using the given formatter.

impl Binary for FormatFlags

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

Formats the value using the given formatter.

impl LowerHex for FormatFlags

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

Formats the value using the given formatter.

impl UpperHex for FormatFlags

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

Formats the value using the given formatter.