Godot.GodotInstance

Borrowed compatibility handle returned by twodog.Engine.Start().

public class GodotInstance : IDisposable

Package: 2dog.engine
Namespace: Godot

This class is one of the few differences from stock Godot, which does not expose it. Its Engine owns the native instance and its lifecycle.

Create this object through twodog.Engine.Start() rather than its low-level static factory methods.

Compatibility Methods

Iteration

public bool Iteration()

Processes one main-loop frame. Returns true when Godot requests exit. In new host code, call Engine.Update() instead; it returns false when Godot quits.

while (!instance.Iteration())
{
    // One frame has completed.
}

IsStarted

public bool IsStarted()

Returns whether this instance has started.

FocusIn and FocusOut

public void FocusIn()
public void FocusOut()

Notify Godot that the host has gained or lost focus. Ordinary generic hosts let Godot's display server handle focus and do not call these methods directly.

Pause and Resume

public void Pause()
public void Resume()

Notify Godot that the host application has paused or resumed. These lifecycle hooks are useful when another application framework owns the outer window.

Choose one loop owner

Call Engine.Update() yourself or call Engine.Run(). Do not use both for the same instance. Do not dispose this borrowed handle. For lifecycle control, use Engine.RequestQuit(), Completion, Exited, and engine disposal.