Struct renderdoc::OverlayBits

pub struct OverlayBits { /* fields omitted */ }

Bit flags for customizing the RenderDoc overlay.

Implementations

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 const fn empty() -> OverlayBits

Returns an empty set of flags

pub const fn all() -> OverlayBits

Returns the set containing all flags.

pub const 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 const fn from_bits_truncate(bits: u32) -> OverlayBits

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> OverlayBits

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: OverlayBits) -> bool

Returns true if there are flags common to both self and other.

pub const 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 Binary for OverlayBits

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

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 BitAndAssign<OverlayBits> for OverlayBits

fn bitand_assign(&mut self, other: OverlayBits)

Disables all flags disabled in the set.

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 BitOrAssign<OverlayBits> for OverlayBits

fn bitor_assign(&mut self, other: OverlayBits)

Adds the set 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 BitXorAssign<OverlayBits> for OverlayBits

fn bitxor_assign(&mut self, other: OverlayBits)

Toggles the set of flags.

impl Clone for OverlayBits

fn clone(&self) -> OverlayBits

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OverlayBits

impl Debug for OverlayBits

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for OverlayBits

impl Extend<OverlayBits> for OverlayBits

fn extend<T: IntoIterator<Item = OverlayBits>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<OverlayBits> for OverlayBits

fn from_iter<T: IntoIterator<Item = OverlayBits>>(iterator: T) -> OverlayBits

Creates a value from an iterator.

impl Hash for OverlayBits

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for OverlayBits

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

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 Octal for OverlayBits

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for OverlayBits

fn cmp(&self, other: &OverlayBits) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<OverlayBits> for OverlayBits

fn eq(&self, other: &OverlayBits) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OverlayBits) -> bool

This method tests for !=.

impl PartialOrd<OverlayBits> for OverlayBits

fn partial_cmp(&self, other: &OverlayBits) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &OverlayBits) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &OverlayBits) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &OverlayBits) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &OverlayBits) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for OverlayBits

impl StructuralPartialEq 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 UpperHex for OverlayBits

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.