Enum AlphaMode 

#[non_exhaustive]
pub enum AlphaMode {
    Straight,
    Premultiplied,
    Unknown,
}

Alpha modes.

The alpha mode defines how the alpha channel should be handled when converting video frames.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Straight

Unassociated alpha.

Premultiplied

Associated alpha.

Unknown

Alpha mode is not specified or unknown

Implementations

impl AlphaMode

pub const fn name(&self) -> &'static str

Returns the name of the alpha mode as a string.

Examples

use ff_format::color::AlphaMode;

assert_eq!(AlphaMode::Straight.name(), "straight");
assert_eq!(AlphaMode::Premultiplied.name(), "premultiplied");

pub const fn is_straight(&self) -> bool

Returns true if this is a straight alpha mode.

Examples

use ff_format::color::AlphaMode;

assert!(AlphaMode::Straight.is_straight());
assert!(!AlphaMode::Premultiplied.is_straight());

pub const fn is_premultiplied(&self) -> bool

Returns true if this is a premultiplied alpha mode.

Examples

use ff_format::color::AlphaMode;

assert!(AlphaMode::Premultiplied.is_premultiplied());
assert!(!AlphaMode::Straight.is_premultiplied());

pub const fn is_unknown(&self) -> bool

Returns true if the alpha mode is unknown.

Examples

use ff_format::color::AlphaMode;

assert!(AlphaMode::Unknown.is_unknown());
assert!(!AlphaMode::Straight.is_unknown());

Trait Implementations

impl Clone for AlphaMode

fn clone(&self) -> AlphaMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AlphaMode

impl Debug for AlphaMode

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

Formats the value using the given formatter.

impl Default for AlphaMode

fn default() -> AlphaMode

Returns the “default value” for a type.

impl Display for AlphaMode

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

Formats the value using the given formatter.

impl Eq for AlphaMode

impl Hash for AlphaMode

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

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