Struct gbm::BufferObjectFlags
source · pub struct BufferObjectFlags { /* private fields */ }
Expand description
Flags to indicate the intended use for the buffer - these are passed into
Device::create_buffer_object()
.
Use Device::is_format_supported()
to check if the combination of format
and use flags are supported
Implementations§
source§impl BufferObjectFlags
impl BufferObjectFlags
sourcepub const SCANOUT: Self = _
pub const SCANOUT: Self = _
Buffer is going to be presented to the screen using an API such as KMS
sourcepub const CURSOR_64X64: Self = _
👎Deprecated: Use CURSOR instead
pub const CURSOR_64X64: Self = _
Buffer is going to be used as cursor (deprecated)
sourcepub const RENDERING: Self = _
pub const RENDERING: Self = _
Buffer is to be used for rendering - for example it is going to be used as the storage for a color buffer
sourcepub const WRITE: Self = _
pub const WRITE: Self = _
Buffer can be used for BufferObject::write()
. This is guaranteed to work
with Self::CURSOR
, but may not work for other combinations.
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§
source§impl Binary for BufferObjectFlags
impl Binary for BufferObjectFlags
source§impl BitAnd<BufferObjectFlags> for BufferObjectFlags
impl BitAnd<BufferObjectFlags> for BufferObjectFlags
source§impl BitAndAssign<BufferObjectFlags> for BufferObjectFlags
impl BitAndAssign<BufferObjectFlags> for BufferObjectFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<BufferObjectFlags> for BufferObjectFlags
impl BitOr<BufferObjectFlags> for BufferObjectFlags
source§fn bitor(self, other: BufferObjectFlags) -> Self
fn bitor(self, other: BufferObjectFlags) -> Self
Returns the union of the two sets of flags.
§type Output = BufferObjectFlags
type Output = BufferObjectFlags
|
operator.source§impl BitOrAssign<BufferObjectFlags> for BufferObjectFlags
impl BitOrAssign<BufferObjectFlags> for BufferObjectFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<BufferObjectFlags> for BufferObjectFlags
impl BitXor<BufferObjectFlags> for BufferObjectFlags
source§impl BitXorAssign<BufferObjectFlags> for BufferObjectFlags
impl BitXorAssign<BufferObjectFlags> for BufferObjectFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for BufferObjectFlags
impl Clone for BufferObjectFlags
source§fn clone(&self) -> BufferObjectFlags
fn clone(&self) -> BufferObjectFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BufferObjectFlags
impl Debug for BufferObjectFlags
source§impl Extend<BufferObjectFlags> for BufferObjectFlags
impl Extend<BufferObjectFlags> for BufferObjectFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<BufferObjectFlags> for BufferObjectFlags
impl FromIterator<BufferObjectFlags> for BufferObjectFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for BufferObjectFlags
impl Hash for BufferObjectFlags
source§impl LowerHex for BufferObjectFlags
impl LowerHex for BufferObjectFlags
source§impl Not for BufferObjectFlags
impl Not for BufferObjectFlags
source§impl Octal for BufferObjectFlags
impl Octal for BufferObjectFlags
source§impl Ord for BufferObjectFlags
impl Ord for BufferObjectFlags
source§fn cmp(&self, other: &BufferObjectFlags) -> Ordering
fn cmp(&self, other: &BufferObjectFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<BufferObjectFlags> for BufferObjectFlags
impl PartialEq<BufferObjectFlags> for BufferObjectFlags
source§fn eq(&self, other: &BufferObjectFlags) -> bool
fn eq(&self, other: &BufferObjectFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<BufferObjectFlags> for BufferObjectFlags
impl PartialOrd<BufferObjectFlags> for BufferObjectFlags
source§fn partial_cmp(&self, other: &BufferObjectFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &BufferObjectFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<BufferObjectFlags> for BufferObjectFlags
impl Sub<BufferObjectFlags> for BufferObjectFlags
source§impl SubAssign<BufferObjectFlags> for BufferObjectFlags
impl SubAssign<BufferObjectFlags> for BufferObjectFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for BufferObjectFlags
impl UpperHex for BufferObjectFlags
impl Copy for BufferObjectFlags
impl Eq for BufferObjectFlags
impl StructuralEq for BufferObjectFlags
impl StructuralPartialEq for BufferObjectFlags
Auto Trait Implementations§
impl RefUnwindSafe for BufferObjectFlags
impl Send for BufferObjectFlags
impl Sync for BufferObjectFlags
impl Unpin for BufferObjectFlags
impl UnwindSafe for BufferObjectFlags
Blanket Implementations§
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.