Struct gfx_hal::window::CompositeAlphaMode

pub struct CompositeAlphaMode { /* fields omitted */ }

Specifies how the alpha channel of the images should be handled during compositing.

Methods

impl CompositeAlphaMode

pub const OPAQUE: CompositeAlphaMode

The alpha channel, if it exists, of the images is ignored in the compositing process. Instead, the image is treated as if it has a constant alpha of 1.0.

pub const PREMULTIPLIED: CompositeAlphaMode

The alpha channel, if it exists, of the images is respected in the compositing process. The non-alpha channels of the image are expected to already be multiplied by the alpha channel by the application.

pub const POSTMULTIPLIED: CompositeAlphaMode

The alpha channel, if it exists, of the images is respected in the compositing process. The non-alpha channels of the image are not expected to already be multiplied by the alpha channel by the application; instead, the compositor will multiply the non-alpha channels of the image by the alpha channel during compositing.

pub const INHERIT: CompositeAlphaMode

The way in which the presentation engine treats the alpha channel in the images is unknown to gfx-hal. Instead, the application is responsible for setting the composite alpha blending mode using native window system commands. If the application does not set the blending mode using native window system commands, then a platform-specific default will be used.

pub const fn empty() -> CompositeAlphaMode

Returns an empty set of flags

pub const fn all() -> CompositeAlphaMode

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

pub const fn from_bits_truncate(bits: u32) -> CompositeAlphaMode

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> CompositeAlphaMode

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for CompositeAlphaMode

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

Formats the value using the given formatter.

impl BitAnd<CompositeAlphaMode> for CompositeAlphaMode

type Output = CompositeAlphaMode

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<CompositeAlphaMode> for CompositeAlphaMode

fn bitand_assign(&mut self, other: CompositeAlphaMode)

Disables all flags disabled in the set.

impl BitOr<CompositeAlphaMode> for CompositeAlphaMode

type Output = CompositeAlphaMode

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<CompositeAlphaMode> for CompositeAlphaMode

fn bitor_assign(&mut self, other: CompositeAlphaMode)

Adds the set of flags.

impl BitXor<CompositeAlphaMode> for CompositeAlphaMode

type Output = CompositeAlphaMode

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<CompositeAlphaMode> for CompositeAlphaMode

fn bitxor_assign(&mut self, other: CompositeAlphaMode)

Toggles the set of flags.

impl Clone for CompositeAlphaMode

fn clone(&self) -> CompositeAlphaMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CompositeAlphaMode

impl Debug for CompositeAlphaMode

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

Formats the value using the given formatter.

impl Eq for CompositeAlphaMode

impl Extend<CompositeAlphaMode> for CompositeAlphaMode

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

Extends a collection with the contents of an iterator.

impl FromIterator<CompositeAlphaMode> for CompositeAlphaMode

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

Creates a value from an iterator.

impl Hash for CompositeAlphaMode

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 LowerHex for CompositeAlphaMode

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

Formats the value using the given formatter.

impl Not for CompositeAlphaMode

type Output = CompositeAlphaMode

The resulting type after applying the ! operator.

fn not(self) -> CompositeAlphaMode

Returns the complement of this set of flags.

impl Octal for CompositeAlphaMode

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

Formats the value using the given formatter.

impl Ord for CompositeAlphaMode

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<CompositeAlphaMode> for CompositeAlphaMode

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

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

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

This method tests for !=.

impl PartialOrd<CompositeAlphaMode> for CompositeAlphaMode

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for CompositeAlphaMode

impl StructuralPartialEq for CompositeAlphaMode

impl Sub<CompositeAlphaMode> for CompositeAlphaMode

type Output = CompositeAlphaMode

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<CompositeAlphaMode> for CompositeAlphaMode

fn sub_assign(&mut self, other: CompositeAlphaMode)

Disables all flags enabled in the set.

impl UpperHex for CompositeAlphaMode

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

Formats the value using the given formatter.