Class DebugUI.Widget

Base class for all debug UI widgets.

Inheritance
object
DebugUI.Widget
DebugUI.Button
DebugUI.Container
DebugUI.Field<T>
DebugUI.MessageBox
DebugUI.Value
DebugUI.ValueTuple
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public abstract class DebugUI.Widget

Fields

isHiddenCallback

Optional delegate that can be used to conditionally hide widgets at runtime (e.g. due to state of other widgets).

Declaration
public Func<bool> isHiddenCallback
Field Value
Type Description
Func<bool>

m_Panel

Panels containing the widget.

Declaration
protected DebugUI.Panel m_Panel
Field Value
Type Description
DebugUI.Panel

m_Parent

Parent container.

Declaration
protected DebugUI.IContainer m_Parent
Field Value
Type Description
DebugUI.IContainer

Properties

displayName

Display name.

Declaration
public string displayName { get; set; }
Property Value
Type Description
string

flags

Flags for the widget.

Declaration
public DebugUI.Flags flags { get; set; }
Property Value
Type Description
DebugUI.Flags

isEditorOnly

True if the widget is Editor only.

Declaration
public bool isEditorOnly { get; }
Property Value
Type Description
bool

isHidden

If shouldHideDelegate has been set and returns true, the widget is hidden from the UI.

Declaration
public bool isHidden { get; }
Property Value
Type Description
bool

isInactiveInEditor

True if the widget is inactive in the editor (i.e. widget is runtime only and the application is not 'Playing').

Declaration
public bool isInactiveInEditor { get; }
Property Value
Type Description
bool

isRuntimeOnly

True if the widget is Runtime only.

Declaration
public bool isRuntimeOnly { get; }
Property Value
Type Description
bool

nameAndTooltip

Helper setter to allow more compact initialization of widgets.

Declaration
public DebugUI.Widget.NameAndTooltip nameAndTooltip { set; }
Property Value
Type Description
DebugUI.Widget.NameAndTooltip

panel

Panels containing the widget.

Declaration
public virtual DebugUI.Panel panel { get; }
Property Value
Type Description
DebugUI.Panel

parent

Parent container.

Declaration
public virtual DebugUI.IContainer parent { get; }
Property Value
Type Description
DebugUI.IContainer

queryPath

Path of the widget.

Declaration
public string queryPath { get; }
Property Value
Type Description
string

tooltip

Tooltip.

Declaration
public string tooltip { get; set; }
Property Value
Type Description
string

Methods

GetHashCode()

Returns the hash code of the widget.

Declaration
public override int GetHashCode()
Returns
Type Description
int

The hash code of the widget.
Overrides

Extension Methods