Struct webrender::DebugFlags

source ·
#[repr(C)]
pub struct DebugFlags { pub(crate) bits: u32, }
Expand description

Flags to enable/disable various builtin debugging tools.

Fields§

§bits: u32

Implementations§

source§

impl DebugFlags

source

pub const PROFILER_DBG: DebugFlags = _

Display the frame profiler on screen.

source

pub const RENDER_TARGET_DBG: DebugFlags = _

Display intermediate render targets on screen.

source

pub const TEXTURE_CACHE_DBG: DebugFlags = _

Display all texture cache pages on screen.

source

pub const GPU_TIME_QUERIES: DebugFlags = _

Display GPU timing results.

source

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

source

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.

source

pub const EPOCHS: DebugFlags = _

Display the pipeline epochs.

source

pub const ECHO_DRIVER_MESSAGES: DebugFlags = _

Print driver messages to stdout.

source

pub const SHOW_OVERDRAW: DebugFlags = _

Show an overlay displaying overdraw amount.

source

pub const GPU_CACHE_DBG: DebugFlags = _

Display the contents of GPU cache.

source

pub const TEXTURE_CACHE_DBG_CLEAR_EVICTED: DebugFlags = _

Clear evicted parts of the texture cache for debugging purposes.

source

pub const PICTURE_CACHING_DBG: DebugFlags = _

Show picture caching debug overlay

source

pub const PRIMITIVE_DBG: DebugFlags = _

Highlight all primitives with colors based on kind.

source

pub const ZOOM_DBG: DebugFlags = _

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

source

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.

source

pub const DISABLE_OPAQUE_PASS: DebugFlags = _

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

source

pub const DISABLE_ALPHA_PASS: DebugFlags = _

source

pub const DISABLE_CLIP_MASKS: DebugFlags = _

source

pub const DISABLE_TEXT_PRIMS: DebugFlags = _

source

pub const DISABLE_GRADIENT_PRIMS: DebugFlags = _

source

pub const OBSCURE_IMAGES: DebugFlags = _

source

pub const GLYPH_FLASHING: DebugFlags = _

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

source

pub const SMART_PROFILER: DebugFlags = _

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

source

pub const INVALIDATION_DBG: DebugFlags = _

If set, dump picture cache invalidation debug to console.

source

pub const TILE_CACHE_LOGGING_DBG: DebugFlags = _

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

source

pub const PROFILER_CAPTURE: DebugFlags = _

Collect and dump profiler statistics to captures.

source

pub const FORCE_PICTURE_INVALIDATION: DebugFlags = _

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

source

pub const USE_BATCHED_TEXTURE_UPLOADS: DebugFlags = _

source

pub const USE_DRAW_CALLS_FOR_TEXTURE_COPY: DebugFlags = _

source

pub const fn empty() -> DebugFlags

Returns an empty set of flags.

source

pub const fn all() -> DebugFlags

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

source

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

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

source

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

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.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

source

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

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.

source

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

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.

source

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

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.

source

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

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.

source

pub const fn complement(self) -> DebugFlags

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§

source§

impl Binary for DebugFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd<DebugFlags> for DebugFlags

source§

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

Returns the intersection between the two sets of flags.

§

type Output = DebugFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign<DebugFlags> for DebugFlags

source§

fn bitand_assign(&mut self, other: DebugFlags)

Disables all flags disabled in the set.

source§

impl BitOr<DebugFlags> for DebugFlags

source§

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

Returns the union of the two sets of flags.

§

type Output = DebugFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign<DebugFlags> for DebugFlags

source§

fn bitor_assign(&mut self, other: DebugFlags)

Adds the set of flags.

source§

impl BitXor<DebugFlags> for DebugFlags

source§

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

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

§

type Output = DebugFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<DebugFlags> for DebugFlags

source§

fn bitxor_assign(&mut self, other: DebugFlags)

Toggles the set of flags.

source§

impl Clone for DebugFlags

source§

fn clone(&self) -> DebugFlags

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DebugFlags

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DebugFlags

source§

fn default() -> DebugFlags

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>( __deserializer: __D ) -> Result<DebugFlags, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Extend<DebugFlags> for DebugFlags

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl FromIterator<DebugFlags> for DebugFlags

source§

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

Creates a value from an iterator. Read more
source§

impl Hash for DebugFlags

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for DebugFlags

source§

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

Formats the value using the given formatter.
source§

impl MallocSizeOf for DebugFlags

source§

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.
source§

impl Not for DebugFlags

source§

fn not(self) -> DebugFlags

Returns the complement of this set of flags.

§

type Output = DebugFlags

The resulting type after applying the ! operator.
source§

impl Octal for DebugFlags

source§

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

Formats the value using the given formatter.
source§

impl Ord for DebugFlags

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<DebugFlags> for DebugFlags

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd<DebugFlags> for DebugFlags

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for DebugFlags

source§

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. Read more
source§

impl Sub<DebugFlags> for DebugFlags

source§

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

Returns the set difference of the two sets of flags.

§

type Output = DebugFlags

The resulting type after applying the - operator.
source§

impl SubAssign<DebugFlags> for DebugFlags

source§

fn sub_assign(&mut self, other: DebugFlags)

Disables all flags enabled in the set.

source§

impl UpperHex for DebugFlags

source§

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

Formats the value using the given formatter.
source§

impl Copy for DebugFlags

source§

impl Eq for DebugFlags

source§

impl StructuralEq for DebugFlags

source§

impl StructuralPartialEq for DebugFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,