[−]Struct renderdoc::OverlayBits
Bit flags for customizing the RenderDoc overlay.
Methods
impl OverlayBits
pub const ENABLED: OverlayBits
Controls whether the overlay is enabled or disabled globally.
pub const FRAME_RATE: OverlayBits
Shows the average, minimum, and maximum sampled frame rate.
pub const FRAME_NUMBER: OverlayBits
Shows the current frame number.
pub const CAPTURE_LIST: OverlayBits
Shows a list of recent captures, out of the total captures made.
pub const DEFAULT: OverlayBits
Sets the default configuration for the overlay.
pub const ALL: OverlayBits
Enables all overlay configuration bits.
pub const NONE: OverlayBits
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 Clone for OverlayBits
fn clone(&self) -> OverlayBits
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Ord for OverlayBits
fn cmp(&self, other: &OverlayBits) -> Ordering
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
fn clamp(self, min: Self, max: Self) -> Self
[src]
clamp
)Restrict a value to a certain interval. Read more
impl Extend<OverlayBits> for OverlayBits
fn extend<T: IntoIterator<Item = OverlayBits>>(&mut self, iterator: T)
impl Eq for OverlayBits
impl Copy for OverlayBits
impl PartialOrd<OverlayBits> for OverlayBits
fn partial_cmp(&self, other: &OverlayBits) -> Option<Ordering>
fn lt(&self, other: &OverlayBits) -> bool
fn le(&self, other: &OverlayBits) -> bool
fn gt(&self, other: &OverlayBits) -> bool
fn ge(&self, other: &OverlayBits) -> bool
impl PartialEq<OverlayBits> for OverlayBits
fn eq(&self, other: &OverlayBits) -> bool
fn ne(&self, other: &OverlayBits) -> bool
impl Debug for OverlayBits
impl Sub<OverlayBits> 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<OverlayBits> 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 BitAnd<OverlayBits> 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 BitOr<OverlayBits> 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 BitXor<OverlayBits> 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 BitAndAssign<OverlayBits> for OverlayBits
fn bitand_assign(&mut self, other: OverlayBits)
Disables all flags disabled in the set.
impl BitOrAssign<OverlayBits> for OverlayBits
fn bitor_assign(&mut self, other: OverlayBits)
Adds the set of flags.
impl BitXorAssign<OverlayBits> for OverlayBits
fn bitxor_assign(&mut self, other: OverlayBits)
Toggles the set of flags.
impl Hash for OverlayBits
fn hash<__H: Hasher>(&self, state: &mut __H)
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 FromIterator<OverlayBits> for OverlayBits
fn from_iter<T: IntoIterator<Item = OverlayBits>>(iterator: T) -> OverlayBits
impl Octal for OverlayBits
impl Binary for OverlayBits
impl LowerHex for OverlayBits
impl UpperHex for OverlayBits
Auto Trait Implementations
impl Send for OverlayBits
impl Sync for OverlayBits
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,