Struct webrender::DebugFlags

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

Flags to enable/disable various builtin debugging tools.

Methods

impl DebugFlags

pub const PROFILER_DBG: DebugFlags

Display the frame profiler on screen.

pub const RENDER_TARGET_DBG: DebugFlags

Display intermediate render targets on screen.

pub const TEXTURE_CACHE_DBG: DebugFlags

Display all texture cache pages on screen.

pub const GPU_TIME_QUERIES: DebugFlags

Display GPU timing results.

pub const GPU_SAMPLE_QUERIES: DebugFlags

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: DebugFlags

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: DebugFlags

Display the pipeline epochs.

pub const COMPACT_PROFILER: DebugFlags

Reduce the amount of information displayed by the profiler so that it occupies less screen real-estate.

pub const ECHO_DRIVER_MESSAGES: DebugFlags

Print driver messages to stdout.

pub const NEW_FRAME_INDICATOR: DebugFlags

Show an indicator that moves every time a frame is rendered.

pub const NEW_SCENE_INDICATOR: DebugFlags

Show an indicator that moves every time a scene is built.

pub const SHOW_OVERDRAW: DebugFlags

Show an overlay displaying overdraw amount.

pub const GPU_CACHE_DBG: DebugFlags

Display the contents of GPU cache.

pub const SLOW_FRAME_INDICATOR: DebugFlags

Show a red bar that moves each time a slow frame is detected.

pub const TEXTURE_CACHE_DBG_CLEAR_EVICTED: DebugFlags

Clear evicted parts of the texture cache for debugging purposes.

pub const PICTURE_CACHING_DBG: DebugFlags

Show picture caching debug overlay

pub const PRIMITIVE_DBG: DebugFlags

Highlight all primitives with colors based on kind.

pub const ZOOM_DBG: DebugFlags

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

pub const SMALL_SCREEN: DebugFlags

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: DebugFlags

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

pub const DISABLE_ALPHA_PASS: DebugFlags

pub const DISABLE_CLIP_MASKS: DebugFlags

pub const DISABLE_TEXT_PRIMS: DebugFlags

pub const DISABLE_GRADIENT_PRIMS: DebugFlags

pub const OBSCURE_IMAGES: DebugFlags

pub const GLYPH_FLASHING: DebugFlags

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

pub const SMART_PROFILER: DebugFlags

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

pub const DISABLE_PICTURE_CACHING: DebugFlags

Dynamically control whether picture caching is enabled.

pub const INVALIDATION_DBG: DebugFlags

If set, dump picture cache invalidation debug to console.

pub const fn empty() -> DebugFlags

Returns an empty set of flags

pub const fn all() -> DebugFlags

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<DebugFlags>

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) -> DebugFlags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for DebugFlags

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

Formats the value using the given formatter.

impl BitAnd<DebugFlags> for DebugFlags

type Output = DebugFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<DebugFlags> for DebugFlags

fn bitand_assign(&mut self, other: DebugFlags)

Disables all flags disabled in the set.

impl BitOr<DebugFlags> for DebugFlags

type Output = DebugFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<DebugFlags> for DebugFlags

fn bitor_assign(&mut self, other: DebugFlags)

Adds the set of flags.

impl BitXor<DebugFlags> for DebugFlags

type Output = DebugFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<DebugFlags> for DebugFlags

fn bitxor_assign(&mut self, other: DebugFlags)

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 Copy for DebugFlags

impl Debug for DebugFlags

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

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<DebugFlags, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for DebugFlags

impl Extend<DebugFlags> for DebugFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<DebugFlags> for DebugFlags

fn from_iter<T>(iterator: T) -> DebugFlags where
    T: IntoIterator<Item = DebugFlags>, 

Creates a value from an iterator.

impl Hash for DebugFlags

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

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 DebugFlags

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

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

type Output = DebugFlags

The resulting type after applying the ! operator.

fn not(self) -> DebugFlags

Returns the complement of this set of flags.

impl Octal for DebugFlags

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<DebugFlags> for DebugFlags

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

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

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

This method tests for !=.

impl PartialOrd<DebugFlags> 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: &DebugFlags) -> bool

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

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

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

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

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

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

This method 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 as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for DebugFlags

impl StructuralPartialEq for DebugFlags

impl Sub<DebugFlags> for DebugFlags

type Output = DebugFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DebugFlags> for DebugFlags

fn sub_assign(&mut self, other: DebugFlags)

Disables all flags enabled in the set.

impl UpperHex for DebugFlags

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

Formats the value using the given formatter.