godot.gen.godot.EngineProfiler.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of godot-library-debug Show documentation

Contains godot api as kotlin classes and jvm cpp interaction code.

There is a newer version: 0.11.0-4.3

// THIS FILE IS GENERATED! DO NOT EDIT IT MANUALLY!
@file:Suppress("PackageDirectoryMismatch", "unused", "FunctionName", "RedundantModalityModifier",
    "UNCHECKED_CAST", "JoinDeclarationAndAssignment", "USELESS_CAST",
    "RemoveRedundantQualifierName", "NOTHING_TO_INLINE", "NON_FINAL_MEMBER_IN_OBJECT",
    "RedundantVisibilityModifier", "RedundantUnitReturnType", "MemberVisibilityCanBePrivate")

package godot

import godot.`annotation`.GodotBaseType
import godot.core.TypeManager
import godot.core.VariantArray
import godot.util.VoidPtr
import kotlin.Any
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.Suppress
import kotlin.Unit

/**
 * Base class for creating custom profilers.
 *
 * This class can be used to implement custom profilers that are able to interact with the engine and editor debugger.
 *
 * See [godot.EngineDebugger] and [godot.EditorDebuggerPlugin] for more information.
 */
@GodotBaseType
public open class EngineProfiler : RefCounted() {
  public override fun new(scriptIndex: Int): Boolean {
    callConstructor(ENGINECLASS_ENGINEPROFILER, scriptIndex)
    return true
  }

  /**
   * Called when the profiler is enabled/disabled, along with a set of [options].
   */
  public open fun _toggle(enable: Boolean, options: VariantArray): Unit {
  }

  /**
   * Called when data is added to profiler using [godot.EngineDebugger.profilerAddFrameData].
   */
  public open fun _addFrame(`data`: VariantArray): Unit {
  }

  /**
   * 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.
   */
  public open fun _tick(
    frameTime: Double,
    processTime: Double,
    physicsTime: Double,
    physicsFrameTime: Double,
  ): Unit {
  }

  public companion object

  internal object MethodBindings {
    public val _togglePtr: VoidPtr = TypeManager.getMethodBindPtr("EngineProfiler", "_toggle")

    public val _addFramePtr: VoidPtr = TypeManager.getMethodBindPtr("EngineProfiler", "_add_frame")

    public val _tickPtr: VoidPtr = TypeManager.getMethodBindPtr("EngineProfiler", "_tick")
  }
}