EngineProfiler

Documentation

Overview

Package EngineProfiler provides methods for working with EngineProfiler object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsEngineProfiler() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEngineProfiler() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.EngineProfiler

This class can be used to implement custom profilers that are able to interact with the engine and editor debugger. See [EngineDebugger] and [EditorDebuggerPlugin] for more information.

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=EngineProfiler)

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsEngineProfiler

func (self Instance) AsEngineProfiler() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	//Called when the profiler is enabled/disabled, along with a set of [param options].
	Toggle(enable bool, options []any)
	//Called when data is added to profiler using [method EngineDebugger.profiler_add_frame_data].
	AddFrame(data []any)
	//Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better.
	Tick(frame_time Float.X, process_time Float.X, physics_time Float.X, physics_frame_time Float.X)
}