Struct DebugFlags

#[repr(C)]
pub struct DebugFlags { /* private fields */ }

Flags to enable/disable various builtin debugging tools.

Implementations

impl DebugFlags

pub const PROFILER_DBG: Self

Display the frame profiler on screen.

pub const RENDER_TARGET_DBG: Self

Display intermediate render targets on screen.

pub const TEXTURE_CACHE_DBG: Self

Display all texture cache pages on screen.

pub const GPU_TIME_QUERIES: Self

Display GPU timing results.

pub const GPU_SAMPLE_QUERIES: Self

Query the number of pixels that pass the depth test divided and show it in the profiler as a percentage of the number of pixels in the screen (window width times height).

pub const DISABLE_BATCHING: Self

Render each quad with their own draw call.

Terrible for performance but can help with understanding the drawing order when inspecting renderdoc or apitrace recordings.

pub const EPOCHS: Self

Display the pipeline epochs.

pub const ECHO_DRIVER_MESSAGES: Self

Print driver messages to stdout.

pub const SHOW_OVERDRAW: Self

Show an overlay displaying overdraw amount.

pub const GPU_CACHE_DBG: Self

Display the contents of GPU cache.

pub const TEXTURE_CACHE_DBG_CLEAR_EVICTED: Self

Clear evicted parts of the texture cache for debugging purposes.

pub const PICTURE_CACHING_DBG: Self

Show picture caching debug overlay

pub const PRIMITIVE_DBG: Self

Highlight all primitives with colors based on kind.

pub const ZOOM_DBG: Self

Draw a zoom widget showing part of the framebuffer zoomed in.

pub const SMALL_SCREEN: Self

Scale the debug renderer down for a smaller screen. This will disrupt any mapping between debug display items and page content, so shouldn’t be used with overlays like the picture caching or primitive display.

pub const DISABLE_OPAQUE_PASS: Self

Disable various bits of the WebRender pipeline, to help narrow down where slowness might be coming from.

pub const DISABLE_ALPHA_PASS: Self

pub const DISABLE_CLIP_MASKS: Self

pub const DISABLE_TEXT_PRIMS: Self

pub const DISABLE_GRADIENT_PRIMS: Self

pub const OBSCURE_IMAGES: Self

pub const GLYPH_FLASHING: Self

Taint the transparent area of the glyphs with a random opacity to easily see when glyphs are re-rasterized.

pub const SMART_PROFILER: Self

The profiler only displays information that is out of the ordinary.

pub const INVALIDATION_DBG: Self

If set, dump picture cache invalidation debug to console.

pub const TILE_CACHE_LOGGING_DBG: Self

Log tile cache to memory for later saving as part of wr-capture

pub const PROFILER_CAPTURE: Self

Collect and dump profiler statistics to captures.

pub const FORCE_PICTURE_INVALIDATION: Self

Invalidate picture tiles every frames (useful when inspecting GPU work in external tools).

pub const USE_BATCHED_TEXTURE_UPLOADS: Self

pub const USE_DRAW_CALLS_FOR_TEXTURE_COPY: Self

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: u32) -> Self

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

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.

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: Self) -> bool

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

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for DebugFlags

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

Formats the value using the given formatter.

impl BitAnd for DebugFlags

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = DebugFlags

The resulting type after applying the & operator.

impl BitAndAssign for DebugFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for DebugFlags

fn bitor(self, other: DebugFlags) -> Self

Returns the union of the two sets of flags.

type Output = DebugFlags

The resulting type after applying the | operator.

impl BitOrAssign for DebugFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for DebugFlags

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = DebugFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DebugFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for DebugFlags

fn clone(&self) -> DebugFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DebugFlags

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

Formats the value using the given formatter.

impl Default for DebugFlags

fn default() -> DebugFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DebugFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<DebugFlags> for DebugFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<DebugFlags> for DebugFlags

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

Creates a value from an iterator.

impl Hash for DebugFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for DebugFlags

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

Formats the value using the given formatter.

impl MallocSizeOf for DebugFlags

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl Not for DebugFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = DebugFlags

The resulting type after applying the ! operator.

impl Octal for DebugFlags

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

Formats the value using the given formatter.

impl Ord for DebugFlags

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DebugFlags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DebugFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for DebugFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for DebugFlags

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = DebugFlags

The resulting type after applying the - operator.

impl SubAssign for DebugFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for DebugFlags

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

Formats the value using the given formatter.

impl Copy for DebugFlags

impl Eq for DebugFlags

impl StructuralPartialEq for DebugFlags