Class DebugUI.Value

A field that displays a read-only value.

Inheritance
object
DebugUI.Widget
DebugUI.Value
DebugUI.ProgressBarValue
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public class DebugUI.Value : DebugUI.Widget

Constructors

Value()

Constructor.

Declaration
public Value()

Fields

formatString

Optional C# numeric format string, using following syntax: "{0[:numericFormatString]}" See https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings and https://docs.microsoft.com/en-us/dotnet/standard/base-types/composite-formatting Example: 123.45678 with formatString "{0:F2} ms" --> "123.45 ms".

Declaration
public string formatString
Field Value
Type Description
string

refreshRate

Refresh rate for the read-only value (runtime only)

Declaration
public float refreshRate
Field Value
Type Description
float

Properties

getter

Getter for the Value.

Declaration
public Func<object> getter { get; set; }
Property Value
Type Description
Func<object>

isHeader

If is a header, and it should be displayed with bold font

Declaration
public bool isHeader { get; set; }
Property Value
Type Description
bool

Methods

Create()

Creates the VisualElement for the widget that will be added to the panel UI.

Declaration
protected override VisualElement Create()
Returns
Type Description
VisualElement

The widget's VisualElement
Overrides

FormatString(object)

Returns the formatted value string for display purposes.

Declaration
public virtual string FormatString(object value)
Parameters
Type Name Description
object value

Value to be formatted.
Returns
Type Description
string

The formatted value string.

GetValue()

Returns the value of the widget.

Declaration
public virtual object GetValue()
Returns
Type Description
object

The value of the widget.

Extension Methods