Struct webrender_api::DebugFlags

#[repr(C)]
pub struct DebugFlags(pub(crate) u32);

Flags to enable/disable various builtin debugging tools.

Tuple Fields

0: u32

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 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 WINDOW_VISIBILITY_DBG: Self = _

Display window visibility on screen.

pub const RESTRICT_BLOB_SIZE: Self = _

Render large blobs with at a smaller size (incorrectly). This is a temporary workaround for fuzzing.

pub const SURFACE_PROMOTION_LOGGING: Self = _

Enable surface promotion logging.

impl DebugFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl DebugFlags

pub const fn iter(&self) -> Iter<DebugFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<DebugFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

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

The bitwise and (&) of the bits in two flags values.

type Output = DebugFlags

The resulting type after applying the & operator.

impl BitAndAssign for DebugFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for DebugFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = DebugFlags

The resulting type after applying the | operator.

impl BitOrAssign for DebugFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for DebugFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = DebugFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DebugFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

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)

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<DebugFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> DebugFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<DebugFlags> for DebugFlags

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

The bitwise or (|) of the bits in each flags value.

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

type Item = DebugFlags

The type of the elements being iterated over.

type IntoIter = Iter<DebugFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

The bitwise negation (!) of the bits in a flags value, truncating the result.

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 + PartialOrd,

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = DebugFlags

The resulting type after applying the - operator.

impl SubAssign for DebugFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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