Class ProfilerAttributeValue

The ProfilerAttributeValue class represents a specific value for an attribute that can be associated with an event sample.

Constructors

Properties

active: boolean

Whether the attribute value should be submitted to profiler runtime. If false, the attribute value will only be returned to instance pool during synchronization.

Definition of attribute that has this value assigned in the sample.

eventSample: ProfilerEventSample

Event sample to which this attribute value belongs.

value: any

Value of the attribute. Can be of any type, but it will be converted to integer, real or string during profiler synchronization at the and of the frame.

_instancePool: ProfilerAttributeValue[]

Methods

  • Configures attribute value to be active in given event sample.

    Parameters

    • eventSample: ProfilerEventSample

      Sample to which this attribute value belongs.

    • attribute: ProfilerAttribute

      Attribute definition.

    • value: any

      Value that will be associated with the attribute in given event sample.

    Returns void

  • Configures attribute value as inactive.

    Returns void

  • Retrieves an unused attribute value instance from static instance pool. Useful to avoid unnecesary object instantiation during profiling.

    Returns ProfilerAttributeValue

    Unused attribute value instance, not cleared.

  • Returns an instance of attribute value into the static instance pool.

    Parameters

    Returns void