Struct gfx_hal::window::CompositeAlphaMode
source · [−]pub struct CompositeAlphaMode { /* private fields */ }
Expand description
Specifies how the alpha channel of the images should be handled during compositing.
Implementations
sourceimpl CompositeAlphaMode
impl CompositeAlphaMode
sourcepub const OPAQUE: Self
pub const OPAQUE: Self
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.
sourcepub const PREMULTIPLIED: Self
pub const PREMULTIPLIED: Self
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.
sourcepub const POSTMULTIPLIED: Self
pub const POSTMULTIPLIED: Self
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.
sourcepub const INHERIT: Self
pub const INHERIT: Self
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.
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
.
Trait Implementations
sourceimpl Binary for CompositeAlphaMode
impl Binary for CompositeAlphaMode
sourceimpl BitAnd<CompositeAlphaMode> for CompositeAlphaMode
impl BitAnd<CompositeAlphaMode> for CompositeAlphaMode
sourceimpl BitAndAssign<CompositeAlphaMode> for CompositeAlphaMode
impl BitAndAssign<CompositeAlphaMode> for CompositeAlphaMode
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CompositeAlphaMode> for CompositeAlphaMode
impl BitOr<CompositeAlphaMode> for CompositeAlphaMode
sourcefn bitor(self, other: CompositeAlphaMode) -> Self
fn bitor(self, other: CompositeAlphaMode) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CompositeAlphaMode> for CompositeAlphaMode
impl BitOrAssign<CompositeAlphaMode> for CompositeAlphaMode
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CompositeAlphaMode> for CompositeAlphaMode
impl BitXor<CompositeAlphaMode> for CompositeAlphaMode
sourceimpl BitXorAssign<CompositeAlphaMode> for CompositeAlphaMode
impl BitXorAssign<CompositeAlphaMode> for CompositeAlphaMode
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CompositeAlphaMode
impl Clone for CompositeAlphaMode
sourcefn clone(&self) -> CompositeAlphaMode
fn clone(&self) -> CompositeAlphaMode
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CompositeAlphaMode
impl Debug for CompositeAlphaMode
sourceimpl Extend<CompositeAlphaMode> for CompositeAlphaMode
impl Extend<CompositeAlphaMode> for CompositeAlphaMode
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<CompositeAlphaMode> for CompositeAlphaMode
impl FromIterator<CompositeAlphaMode> for CompositeAlphaMode
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for CompositeAlphaMode
impl Hash for CompositeAlphaMode
sourceimpl LowerHex for CompositeAlphaMode
impl LowerHex for CompositeAlphaMode
sourceimpl Not for CompositeAlphaMode
impl Not for CompositeAlphaMode
sourceimpl Octal for CompositeAlphaMode
impl Octal for CompositeAlphaMode
sourceimpl Ord for CompositeAlphaMode
impl Ord for CompositeAlphaMode
sourceimpl PartialEq<CompositeAlphaMode> for CompositeAlphaMode
impl PartialEq<CompositeAlphaMode> for CompositeAlphaMode
sourcefn eq(&self, other: &CompositeAlphaMode) -> bool
fn eq(&self, other: &CompositeAlphaMode) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CompositeAlphaMode) -> bool
fn ne(&self, other: &CompositeAlphaMode) -> bool
This method tests for !=
.
sourceimpl PartialOrd<CompositeAlphaMode> for CompositeAlphaMode
impl PartialOrd<CompositeAlphaMode> for CompositeAlphaMode
sourcefn partial_cmp(&self, other: &CompositeAlphaMode) -> Option<Ordering>
fn partial_cmp(&self, other: &CompositeAlphaMode) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<CompositeAlphaMode> for CompositeAlphaMode
impl Sub<CompositeAlphaMode> for CompositeAlphaMode
sourceimpl SubAssign<CompositeAlphaMode> for CompositeAlphaMode
impl SubAssign<CompositeAlphaMode> for CompositeAlphaMode
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for CompositeAlphaMode
impl UpperHex for CompositeAlphaMode
impl Copy for CompositeAlphaMode
impl Eq for CompositeAlphaMode
impl StructuralEq for CompositeAlphaMode
impl StructuralPartialEq for CompositeAlphaMode
Auto Trait Implementations
impl RefUnwindSafe for CompositeAlphaMode
impl Send for CompositeAlphaMode
impl Sync for CompositeAlphaMode
impl Unpin for CompositeAlphaMode
impl UnwindSafe for CompositeAlphaMode
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more