Struct renderdoc::OverlayBits
[−]
pub struct OverlayBits { /* fields omitted */ }
Bit flags for customizing the RenderDoc overlay.
Methods
impl OverlayBits
pub const ENABLED: OverlayBits
ENABLED: OverlayBits = OverlayBits{bits: 1,}
Controls whether the overlay is enabled or disabled globally.
pub const FRAME_RATE: OverlayBits
FRAME_RATE: OverlayBits = OverlayBits{bits: 2,}
Shows the average, minimum, and maximum sampled frame rate.
pub const FRAME_NUMBER: OverlayBits
FRAME_NUMBER: OverlayBits = OverlayBits{bits: 4,}
Shows the current frame number.
pub const CAPTURE_LIST: OverlayBits
CAPTURE_LIST: OverlayBits = OverlayBits{bits: 8,}
Shows a list of recent captures, out of the total captures made.
pub const DEFAULT: OverlayBits
DEFAULT: OverlayBits = OverlayBits{bits: 1 | 2 | 4 | 8,}
Sets the default configuration for the overlay.
pub const ALL: OverlayBits
ALL: OverlayBits = OverlayBits{bits: u32::MAX,}
Enables all overlay configuration bits.
pub const NONE: OverlayBits
NONE: OverlayBits = OverlayBits{bits: u32::MIN,}
Disables all overlay configuration bits.
pub fn empty() -> OverlayBits
Returns an empty set of flags.
pub fn all() -> OverlayBits
Returns the set containing all flags.
pub fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<OverlayBits>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub fn from_bits_truncate(bits: u32) -> OverlayBits
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub fn intersects(&self, other: OverlayBits) -> bool
Returns true
if there are flags common to both self
and other
.
pub fn contains(&self, other: OverlayBits) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: OverlayBits)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: OverlayBits)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: OverlayBits)
Toggles the specified flags in-place.
pub fn set(&mut self, other: OverlayBits, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Copy for OverlayBits
impl PartialEq for OverlayBits
fn eq(&self, __arg_0: &OverlayBits) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &OverlayBits) -> bool
This method tests for !=
.
impl Eq for OverlayBits
impl Clone for OverlayBits
fn clone(&self) -> OverlayBits
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialOrd for OverlayBits
fn partial_cmp(&self, __arg_0: &OverlayBits) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &OverlayBits) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &OverlayBits) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &OverlayBits) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &OverlayBits) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for OverlayBits
fn cmp(&self, __arg_0: &OverlayBits) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for OverlayBits
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for OverlayBits
impl Binary for OverlayBits
impl Octal for OverlayBits
impl LowerHex for OverlayBits
impl UpperHex for OverlayBits
impl BitOr for OverlayBits
type Output = OverlayBits
The resulting type after applying the |
operator.
fn bitor(self, other: OverlayBits) -> OverlayBits
Returns the union of the two sets of flags.
impl BitOrAssign for OverlayBits
fn bitor_assign(&mut self, other: OverlayBits)
Adds the set of flags.
impl BitXor for OverlayBits
type Output = OverlayBits
The resulting type after applying the ^
operator.
fn bitxor(self, other: OverlayBits) -> OverlayBits
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign for OverlayBits
fn bitxor_assign(&mut self, other: OverlayBits)
Toggles the set of flags.
impl BitAnd for OverlayBits
type Output = OverlayBits
The resulting type after applying the &
operator.
fn bitand(self, other: OverlayBits) -> OverlayBits
Returns the intersection between the two sets of flags.
impl BitAndAssign for OverlayBits
fn bitand_assign(&mut self, other: OverlayBits)
Disables all flags disabled in the set.
impl Sub for OverlayBits
type Output = OverlayBits
The resulting type after applying the -
operator.
fn sub(self, other: OverlayBits) -> OverlayBits
Returns the set difference of the two sets of flags.
impl SubAssign for OverlayBits
fn sub_assign(&mut self, other: OverlayBits)
Disables all flags enabled in the set.
impl Not for OverlayBits
type Output = OverlayBits
The resulting type after applying the !
operator.
fn not(self) -> OverlayBits
Returns the complement of this set of flags.
impl Extend<OverlayBits> for OverlayBits
fn extend<T: IntoIterator<Item = OverlayBits>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<OverlayBits> for OverlayBits
fn from_iter<T: IntoIterator<Item = OverlayBits>>(iterator: T) -> OverlayBits
Creates a value from an iterator. Read more