Struct RendererDebug

pub struct RendererDebug {
    pub flags: DebugFlags,
    pub profiler_ui: String,
}

Webrender renderer debug flags and profiler UI.

Fields

flags: DebugFlags

Debug flags.

profiler_ui: String

Profiler UI rendered when DebugFlags::PROFILER_DBG is set.

Syntax

Comma-separated list of tokens with trailing and leading spaces trimmed. Each tokens can be:

• A counter name with an optional prefix. The name corresponds to the displayed name.
  • By default (no prefix) the counter is shown as average + max over half a second.
  • With a ‘#’ prefix the counter is shown as a graph.
  • With a ‘*’ prefix the counter is shown as a change indicator.
  • Some special counters such as GPU time queries have specific visualizations ignoring prefixes.
• A preset name to append the preset to the UI.
• An empty token to insert a bit of vertical space.
• A ‘|’ token to start a new column.
• A ‘_’ token to start a new row.

Preset & Counter Names

• "Default": "FPS,|,Slow indicators,_,Time graphs,|,Frame times, ,Transaction times, ,Frame stats, ,Memory, ,Interners,_,GPU time queries,_,Paint phase graph"
• "Compact": "FPS, ,Frame times, ,Frame stats"

See the webrender/src/profiler.rs file for more details and more counter names.

Implementations

impl RendererDebug

pub fn disabled() -> Self

Default mode, no debugging enabled.

pub fn profiler(ui: impl Into<String>) -> Self

Enable profiler UI rendering.

pub fn flags(flags: DebugFlags) -> Self

Custom flags with no UI string.

pub fn is_empty(&self) -> bool

If no flag nor profiler UI are set.

Trait Implementations

impl Clone for RendererDebug

fn clone(&self) -> RendererDebug

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RendererDebug

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

Formats the value using the given formatter.

impl Default for RendererDebug

fn default() -> Self

Disabled

impl<'de> Deserialize<'de> for RendererDebug

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for RendererDebug

fn from(profiler: &str) -> Self

Converts to this type from the input type.

impl From<DebugFlags> for RendererDebug

fn from(flags: DebugFlags) -> Self

Converts to this type from the input type.

impl From<Txt> for RendererDebug

fn from(profiler: Txt) -> Self

Converts to this type from the input type.

impl From<bool> for RendererDebug

fn from(profiler_default: bool) -> Self

Converts to this type from the input type.

impl IntoVar<RendererDebug> for &str

type Var = LocalVar<RendererDebug>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<RendererDebug> for DebugFlags

type Var = LocalVar<RendererDebug>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<RendererDebug> for Txt

type Var = LocalVar<RendererDebug>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<RendererDebug> for bool

type Var = LocalVar<RendererDebug>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for RendererDebug

fn eq(&self, other: &RendererDebug) -> 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 Serialize for RendererDebug

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RendererDebug

impl IntoValue<RendererDebug> for &str

impl IntoValue<RendererDebug> for DebugFlags

impl IntoValue<RendererDebug> for Txt

impl IntoValue<RendererDebug> for bool

impl StructuralPartialEq for RendererDebug