Struct amethyst_rendy::rendy::hal::window::CompositeAlpha

[+] Show declaration

pub struct CompositeAlpha { /* fields omitted */ }

[−] Expand description

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

Methods

impl CompositeAlpha[−]

pub const OPAQUE: CompositeAlpha[−][−]

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: CompositeAlpha[−][−]

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: CompositeAlpha[−][−]

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: CompositeAlpha[−][−]

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() -> CompositeAlpha[−]

Returns an empty set of flags

pub const fn all() -> CompositeAlpha[−]

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<CompositeAlpha>[−]

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) -> CompositeAlpha[−]

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

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: CompositeAlpha) -> bool[−]

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

pub const fn contains(&self, other: CompositeAlpha) -> bool[−]

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

pub fn insert(&mut self, other: CompositeAlpha)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: CompositeAlpha)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: CompositeAlpha)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: CompositeAlpha, value: bool)[−]

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

Trait Implementations

impl Binary for CompositeAlpha[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl BitOrAssign<CompositeAlpha> for CompositeAlpha[+]

fn bitor_assign(&mut self, other: CompositeAlpha)[−]

Adds the set of flags.

impl FromIterator<CompositeAlpha> for CompositeAlpha[+]

[+] Show hidden undocumented items

fn from_iter<T>(iterator: T) -> CompositeAlpha where
    T: IntoIterator<Item = CompositeAlpha>, [−]

Creates a value from an iterator.

impl Clone for CompositeAlpha[+]

[+] Show hidden undocumented items

fn clone(&self) -> CompositeAlpha[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Serialize for CompositeAlpha[+]

[+] Show hidden undocumented items

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl PartialEq<CompositeAlpha> for CompositeAlpha[+]

[+] Show hidden undocumented items

fn eq(&self, other: &CompositeAlpha) -> bool[−]

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

fn ne(&self, other: &CompositeAlpha) -> bool[−]

This method tests for !=.

impl Sub<CompositeAlpha> for CompositeAlpha[+]

type Output = CompositeAlpha

The resulting type after applying the - operator.

fn sub(self, other: CompositeAlpha) -> CompositeAlpha[−]

Returns the set difference of the two sets of flags.

impl Ord for CompositeAlpha[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &CompositeAlpha) -> 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 Debug for CompositeAlpha[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl LowerHex for CompositeAlpha[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl BitOr<CompositeAlpha> for CompositeAlpha[+]

type Output = CompositeAlpha

The resulting type after applying the | operator.

fn bitor(self, other: CompositeAlpha) -> CompositeAlpha[−]

Returns the union of the two sets of flags.

impl<'de> Deserialize<'de> for CompositeAlpha[+]

[+] Show hidden undocumented items

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CompositeAlpha, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Copy for CompositeAlpha

impl SubAssign<CompositeAlpha> for CompositeAlpha[+]

fn sub_assign(&mut self, other: CompositeAlpha)[−]

Disables all flags enabled in the set.

impl Not for CompositeAlpha[+]

type Output = CompositeAlpha

The resulting type after applying the ! operator.

fn not(self) -> CompositeAlpha[−]

Returns the complement of this set of flags.

impl Eq for CompositeAlpha

impl BitXor<CompositeAlpha> for CompositeAlpha[+]

type Output = CompositeAlpha

The resulting type after applying the ^ operator.

fn bitxor(self, other: CompositeAlpha) -> CompositeAlpha[−]

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

impl BitAndAssign<CompositeAlpha> for CompositeAlpha[+]

fn bitand_assign(&mut self, other: CompositeAlpha)[−]

Disables all flags disabled in the set.

impl Octal for CompositeAlpha[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl UpperHex for CompositeAlpha[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl BitXorAssign<CompositeAlpha> for CompositeAlpha[+]

fn bitxor_assign(&mut self, other: CompositeAlpha)[−]

Toggles the set of flags.

impl Extend<CompositeAlpha> for CompositeAlpha[+]

[+] Show hidden undocumented items

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = CompositeAlpha>, [−]

Extends a collection with the contents of an iterator.

impl PartialOrd<CompositeAlpha> for CompositeAlpha[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &CompositeAlpha) -> Option<Ordering>[−]

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

fn lt(&self, other: &CompositeAlpha) -> bool[−]

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

fn le(&self, other: &CompositeAlpha) -> bool[−]

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

fn gt(&self, other: &CompositeAlpha) -> bool[−]

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

fn ge(&self, other: &CompositeAlpha) -> bool[−]

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

impl Hash for CompositeAlpha[+]

[+] Show hidden undocumented items

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, [−]

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

impl BitAnd<CompositeAlpha> for CompositeAlpha[+]

type Output = CompositeAlpha

The resulting type after applying the & operator.

fn bitand(self, other: CompositeAlpha) -> CompositeAlpha[−]

Returns the intersection between the two sets of flags.