Struct gfx_hal::display::SurfaceTransformFlags
source · [−]pub struct SurfaceTransformFlags { /* private fields */ }
Expand description
List of the hardware display transformations
Implementations
sourceimpl SurfaceTransformFlags
impl SurfaceTransformFlags
sourcepub const ROTATE_180: Self
pub const ROTATE_180: Self
Specify that image content is rotated 180 degrees clockwise.
sourcepub const ROTATE_270: Self
pub const ROTATE_270: Self
Specify that image content is rotated 270 degrees clockwise.
sourcepub const HORIZONTAL_MIRROR: Self
pub const HORIZONTAL_MIRROR: Self
Specify that image content is mirrored horizontally.
sourcepub const HORIZONTAL_MIRROR_ROTATE_90: Self
pub const HORIZONTAL_MIRROR_ROTATE_90: Self
Specify that image content is mirrored horizontally, then rotated 90 degrees clockwise.
sourcepub const HORIZONTAL_MIRROR_ROTATE_180: Self
pub const HORIZONTAL_MIRROR_ROTATE_180: Self
Specify that image content is mirrored horizontally, then rotated 180 degrees clockwise.
sourcepub const HORIZONTAL_MIRROR_ROTATE_270: Self
pub const HORIZONTAL_MIRROR_ROTATE_270: Self
Specify that image content is mirrored horizontally, then rotated 270 degrees clockwise.
sourcepub const INHERIT: Self
pub const INHERIT: Self
Specify that the presentation transform is not specified, and is instead determined by platform-specific considerations and mechanisms outside Vulkan.
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 SurfaceTransformFlags
impl Binary for SurfaceTransformFlags
sourceimpl BitAndAssign<SurfaceTransformFlags> for SurfaceTransformFlags
impl BitAndAssign<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<SurfaceTransformFlags> for SurfaceTransformFlags
impl BitOr<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn bitor(self, other: SurfaceTransformFlags) -> Self
fn bitor(self, other: SurfaceTransformFlags) -> 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<SurfaceTransformFlags> for SurfaceTransformFlags
impl BitOrAssign<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<SurfaceTransformFlags> for SurfaceTransformFlags
impl BitXorAssign<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for SurfaceTransformFlags
impl Clone for SurfaceTransformFlags
sourcefn clone(&self) -> SurfaceTransformFlags
fn clone(&self) -> SurfaceTransformFlags
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 SurfaceTransformFlags
impl Debug for SurfaceTransformFlags
sourceimpl Extend<SurfaceTransformFlags> for SurfaceTransformFlags
impl Extend<SurfaceTransformFlags> for SurfaceTransformFlags
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 From<SurfaceTransform> for SurfaceTransformFlags
impl From<SurfaceTransform> for SurfaceTransformFlags
sourcefn from(surface_transformation: SurfaceTransform) -> Self
fn from(surface_transformation: SurfaceTransform) -> Self
Performs the conversion.
sourceimpl FromIterator<SurfaceTransformFlags> for SurfaceTransformFlags
impl FromIterator<SurfaceTransformFlags> for SurfaceTransformFlags
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 SurfaceTransformFlags
impl Hash for SurfaceTransformFlags
sourceimpl LowerHex for SurfaceTransformFlags
impl LowerHex for SurfaceTransformFlags
sourceimpl Not for SurfaceTransformFlags
impl Not for SurfaceTransformFlags
sourceimpl Octal for SurfaceTransformFlags
impl Octal for SurfaceTransformFlags
sourceimpl Ord for SurfaceTransformFlags
impl Ord for SurfaceTransformFlags
sourceimpl PartialEq<SurfaceTransformFlags> for SurfaceTransformFlags
impl PartialEq<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn eq(&self, other: &SurfaceTransformFlags) -> bool
fn eq(&self, other: &SurfaceTransformFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SurfaceTransformFlags) -> bool
fn ne(&self, other: &SurfaceTransformFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<SurfaceTransformFlags> for SurfaceTransformFlags
impl PartialOrd<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn partial_cmp(&self, other: &SurfaceTransformFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SurfaceTransformFlags) -> 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 SubAssign<SurfaceTransformFlags> for SurfaceTransformFlags
impl SubAssign<SurfaceTransformFlags> for SurfaceTransformFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for SurfaceTransformFlags
impl UpperHex for SurfaceTransformFlags
impl Copy for SurfaceTransformFlags
impl Eq for SurfaceTransformFlags
impl StructuralEq for SurfaceTransformFlags
impl StructuralPartialEq for SurfaceTransformFlags
Auto Trait Implementations
impl RefUnwindSafe for SurfaceTransformFlags
impl Send for SurfaceTransformFlags
impl Sync for SurfaceTransformFlags
impl Unpin for SurfaceTransformFlags
impl UnwindSafe for SurfaceTransformFlags
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