Unify and clean-up Godot Android surface allocation and render thread logic

Author: m4gr3d

platform/android/java/editor/src/main/java/org/godotengine/editor/BaseGodotEditor.kt

@@ -316,7 +316,7 @@ abstract class BaseGodotEditor : GodotActivity(), GameMenuFragment.GameMenuListe
 
 		runOnUiThread {
 			// Enable long press, panning and scaling gestures
-			godotFragment?.godot?.renderView?.inputHandler?.apply {
+			godotFragment?.godot?.godotInputHandler?.apply {
 				enableLongPress(longPressEnabled)
 				enablePanningAndScalingGestures(panScaleEnabled)
 				setOverrideVolumeButtons(overrideVolumeButtonsEnabled)

platform/android/java/lib/src/org/godotengine/godot/Godot.kt

@@ -62,6 +62,10 @@ import org.godotengine.godot.io.file.FileAccessHandler
 import org.godotengine.godot.plugin.AndroidRuntimePlugin
 import org.godotengine.godot.plugin.GodotPlugin
 import org.godotengine.godot.plugin.GodotPluginRegistry
+import org.godotengine.godot.render.GodotGLRenderView
+import org.godotengine.godot.render.GodotRenderer
+import org.godotengine.godot.render.GodotVulkanRenderView
+import org.godotengine.godot.render.Renderer
 import org.godotengine.godot.tts.GodotTTS
 import org.godotengine.godot.utils.DialogUtils
 import org.godotengine.godot.utils.GodotNetUtils
@@ -112,6 +116,8 @@ class Godot private constructor(val context: Context) {
 		internal fun isEditorBuild() = BuildConfig.FLAVOR == EDITOR_FLAVOR
 	}
 
+	private lateinit var renderer: GodotRenderer
+
 	private val mSensorManager: SensorManager? by lazy { context.getSystemService(Context.SENSOR_SERVICE) as? SensorManager }
 	private val mClipboard: ClipboardManager? by lazy { context.getSystemService(Context.CLIPBOARD_SERVICE) as? ClipboardManager }
 	private val vibratorService: Vibrator? by lazy { context.getSystemService(Context.VIBRATOR_SERVICE) as? Vibrator }
@@ -133,7 +139,7 @@ class Godot private constructor(val context: Context) {
 	val directoryAccessHandler = DirectoryAccessHandler(context)
 	val fileAccessHandler = FileAccessHandler(context)
 	val netUtils = GodotNetUtils(context)
-	private val godotInputHandler = GodotInputHandler(context, this)
+	val godotInputHandler = GodotInputHandler(context, this)
 
 	/**
 	 * Task to run when the engine terminates.
@@ -182,18 +188,23 @@ class Godot private constructor(val context: Context) {
 	/**
 	 * Returns true if the native engine has been initialized through [onInitNativeLayer], false otherwise.
 	 */
-	private fun isNativeInitialized() = nativeLayerInitializeCompleted && nativeLayerSetupCompleted
+	private fun isNativeInitialized() = nativeLayerInitializeCompleted && nativeLayerSetupCompleted && ::renderer.isInitialized
 
 	/**
 	 * Returns true if the engine has been initialized, false otherwise.
 	 */
 	fun isInitialized() = primaryHost != null && isNativeInitialized() && renderViewInitialized
 
 	/**
-	 * Provides access to the primary host [Activity]
+	 * Provides access to the primary host [Activity].
 	 */
 	fun getActivity() = primaryHost?.activity
 
+	/**
+	 * Provides access to the Godot [Renderer].
+	 */
+	fun getRenderer(): Renderer = renderer
+
 	/**
 	 * Start initialization of the Godot engine.
 	 *
@@ -331,6 +342,21 @@ class Godot private constructor(val context: Context) {
 					Log.v(TAG, "Godot native layer setup completed")
 				}
 			}
+
+			val useVulkan = if (usesVulkan()) {
+				if (meetsVulkanRequirements(context.packageManager)) {
+					true
+				} else if (canFallbackToOpenGL()) {
+					// Fallback to OpenGl.
+					false
+				} else {
+					throw IllegalStateException(context.getString(R.string.error_missing_vulkan_requirements_message))
+				}
+			} else {
+				false
+			}
+			renderer = GodotRenderer(useVulkan)
+			renderer.startRenderer()
 		} finally {
 			endBenchmarkMeasure("Startup", "Godot::initEngine")
 		}
@@ -489,23 +515,13 @@ class Godot private constructor(val context: Context) {
 			val shouldBeTransparent =
 				!isProjectManagerHint() && !isEditorHint() && java.lang.Boolean.parseBoolean(GodotLib.getGlobal("display/window/per_pixel_transparency/allowed"))
 			Log.d(TAG, "Render view should be transparent: $shouldBeTransparent")
-			renderView = if (usesVulkan()) {
-				if (meetsVulkanRequirements(context.packageManager)) {
-					GodotVulkanRenderView(this, godotInputHandler, shouldBeTransparent)
-				} else if (canFallbackToOpenGL()) {
-					// Fallback to OpenGl.
-					GodotGLRenderView(this, godotInputHandler, xrMode, useDebugOpengl, shouldBeTransparent)
-				} else {
-					throw IllegalStateException(context.getString(R.string.error_missing_vulkan_requirements_message))
-				}
-
+			renderView = if (renderer.useVulkan) {
+				GodotVulkanRenderView(this, renderer, godotInputHandler, shouldBeTransparent)
 			} else {
-				// Fallback to OpenGl.
-				GodotGLRenderView(this, godotInputHandler, xrMode, useDebugOpengl, shouldBeTransparent)
+				GodotGLRenderView(this, renderer, godotInputHandler, xrMode, useDebugOpengl, shouldBeTransparent)
 			}
 
 			renderView?.let {
-				it.startRenderer()
 				containerLayout?.addView(
 					it.view,
 					ViewGroup.LayoutParams(
@@ -557,7 +573,7 @@ class Godot private constructor(val context: Context) {
 				override fun onEnd(animation: WindowInsetsAnimationCompat) {}
 			})
 
-			renderView?.queueOnRenderThread {
+			runOnRenderThread {
 				for (plugin in pluginRegistry.allPlugins) {
 					plugin.onRegisterPluginWithGodotNative()
 				}
@@ -593,7 +609,10 @@ class Godot private constructor(val context: Context) {
 			return
 		}
 
-		renderView?.onActivityStarted()
+		renderer.onActivityStarted()
+		for (plugin in pluginRegistry.allPlugins) {
+			plugin.onMainStart()
+		}
 	}
 
 	fun onResume(host: GodotHost) {
@@ -603,7 +622,7 @@ class Godot private constructor(val context: Context) {
 			return
 		}
 
-		renderView?.onActivityResumed()
+		renderer.onActivityResumed()
 		registerSensorsIfNeeded()
 		for (plugin in pluginRegistry.allPlugins) {
 			plugin.onMainResume()
@@ -636,11 +655,11 @@ class Godot private constructor(val context: Context) {
 			return
 		}
 
-		renderView?.onActivityPaused()
-		mSensorManager?.unregisterListener(godotInputHandler)
 		for (plugin in pluginRegistry.allPlugins) {
 			plugin.onMainPause()
 		}
+		renderer.onActivityPaused()
+		mSensorManager?.unregisterListener(godotInputHandler)
 	}
 
 	fun onStop(host: GodotHost) {
@@ -649,7 +668,10 @@ class Godot private constructor(val context: Context) {
 			return
 		}
 
-		renderView?.onActivityStopped()
+		for (plugin in pluginRegistry.allPlugins) {
+			plugin.onMainStop()
+		}
+		renderer.onActivityStopped()
 	}
 
 	fun onDestroy(primaryHost: GodotHost) {
@@ -658,12 +680,22 @@ class Godot private constructor(val context: Context) {
 		}
 		Log.v(TAG, "OnDestroy: $primaryHost")
 
+		// If the host activity is being destroyed because it's changing configurations, it'll be recreated, so we keep
+		// the engine around to continue where we left off.
+		val isHostChangingConfigurations = primaryHost.activity?.isChangingConfigurations == true
+		if (!isHostChangingConfigurations) {
+			destroyEngine()
+		}
+		this.primaryHost = null
+	}
+
+	private fun destroyEngine() {
+		Log.d(TAG, "Destroying Godot Engine")
 		for (plugin in pluginRegistry.allPlugins) {
 			plugin.onMainDestroy()
 		}
 
-		renderView?.onActivityDestroyed()
-		this.primaryHost = null
+		renderer.onActivityDestroyed()
 	}
 
 	/**
@@ -724,7 +756,7 @@ class Godot private constructor(val context: Context) {
 		val scrollDeadzoneDisabled = java.lang.Boolean.parseBoolean(GodotLib.getGlobal("input_devices/pointing/android/disable_scroll_deadzone"))
 
 		runOnHostThread {
-			renderView?.inputHandler?.apply {
+			godotInputHandler.apply {
 				enableLongPress(longPressEnabled)
 				enablePanningAndScalingGestures(panScaleEnabled)
 				setOverrideVolumeButtons(overrideVolumeButtons)
@@ -811,7 +843,7 @@ class Godot private constructor(val context: Context) {
 	 * This must be called after the render thread has started.
 	 */
 	fun runOnRenderThread(action: Runnable) {
-		renderView?.queueOnRenderThread(action)
+		renderer.queueOnRenderThread(action)
 	}
 
 	/**
@@ -983,7 +1015,7 @@ class Godot private constructor(val context: Context) {
 		runOnTerminate.set(destroyRunnable)
 
 		runOnHostThread {
-			onDestroy(host)
+			destroyEngine()
 		}
 	}
 
@@ -1003,7 +1035,7 @@ class Godot private constructor(val context: Context) {
 		for (plugin in pluginRegistry.allPlugins) {
 			plugin.onMainBackPressed()
 		}
-		renderView?.queueOnRenderThread { GodotLib.back() }
+		runOnRenderThread { GodotLib.back() }
 	}
 
 	/**

platform/android/java/lib/src/org/godotengine/godot/GodotLib.java

@@ -30,9 +30,9 @@
 
 package org.godotengine.godot;
 
-import org.godotengine.godot.gl.GodotRenderer;
 import org.godotengine.godot.io.directory.DirectoryAccessHandler;
 import org.godotengine.godot.io.file.FileAccessHandler;
+import org.godotengine.godot.render.GodotRenderer;
 import org.godotengine.godot.tts.GodotTTS;
 import org.godotengine.godot.utils.GodotNetUtils;
 import org.godotengine.godot.variant.Callable;
@@ -42,8 +42,6 @@
 import android.hardware.SensorEvent;
 import android.view.Surface;
 
-import javax.microedition.khronos.opengles.GL10;
-
 /**
  * Wrapper for native library
  */
@@ -81,7 +79,7 @@ public static native boolean initialize(
 	 * @param p_surface
 	 * @param p_width
 	 * @param p_height
-	 * @see org.godotengine.godot.gl.GLSurfaceView.Renderer#onSurfaceChanged(GL10, int, int)
+	 * @see GodotRenderer#onRenderSurfaceChanged(Surface, int, int)
 	 */
 	public static native void resize(Surface p_surface, int p_width, int p_height);
 
@@ -98,7 +96,7 @@ public static native boolean initialize(
 
 	/**
 	 * Invoked on the GL thread to draw the current frame.
-	 * @see org.godotengine.godot.gl.GLSurfaceView.Renderer#onDrawFrame(GL10)
+	 * @see GodotRenderer#onRenderDrawFrame()
 	 */
 	public static native boolean step();
 

platform/android/java/lib/src/org/godotengine/godot/GodotRenderView.java

@@ -38,26 +38,6 @@
 public interface GodotRenderView {
 	SurfaceView getView();
 
-	/**
-	 * Starts the thread that will drive Godot's rendering.
-	 */
-	void startRenderer();
-
-	/**
-	 * Queues a runnable to be run on the rendering thread.
-	 */
-	void queueOnRenderThread(Runnable event);
-
-	void onActivityPaused();
-
-	void onActivityStopped();
-
-	void onActivityResumed();
-
-	void onActivityStarted();
-
-	void onActivityDestroyed();
-
 	GodotInputHandler getInputHandler();
 
 	void configurePointerIcon(int pointerType, String imagePath, float hotSpotX, float hotSpotY);

platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPlugin.java

@@ -206,6 +206,16 @@ public void onMainRequestPermissionsResult(int requestCode, String[] permissions
 	 */
 	public void onMainPause() {}
 
+	/**
+	 * @see Activity#onStop()
+	 */
+	public void onMainStop() {}
+
+	/**
+	 * @see Activity#onStart()
+	 */
+	public void onMainStart() {}
+
 	/**
 	 * @see Activity#onResume()
 	 */
@@ -238,37 +248,71 @@ public void onGodotMainLoopStarted() {}
 	/**
 	 * When using the OpenGL renderer, this is invoked once per frame on the GL thread after the
 	 * frame is drawn.
+	 *
+	 * @deprecated Use {@link #onRenderDrawFrame()} instead.
 	 */
+	@Deprecated
 	public void onGLDrawFrame(GL10 gl) {}
 
 	/**
 	 * When using the OpenGL renderer, this is called on the GL thread after the surface is created
 	 * and whenever the OpenGL ES surface size changes.
+	 *
+	 * @deprecated Use {@link #onRenderSurfaceChanged(Surface, int, int)} instead.
 	 */
+	@Deprecated
 	public void onGLSurfaceChanged(GL10 gl, int width, int height) {}
 
 	/**
 	 * When using the OpenGL renderer, this is called on the GL thread when the surface is created
 	 * or recreated.
+	 *
+	 * @deprecated Use {@link #onRenderSurfaceCreated(Surface)} instead.
 	 */
+	@Deprecated
 	public void onGLSurfaceCreated(GL10 gl, EGLConfig config) {}
 
+	/**
+	 * This is called on the render thread when the surface is created or recreated.
+	 */
+	public void onRenderSurfaceCreated(Surface surface) {}
+
+	/**
+	 * This is called on the render thread after the surface is created and whenever the surface
+	 * size changes.
+	 */
+	public void onRenderSurfaceChanged(Surface surface, int width, int height) {}
+
+	/**
+	 * Invoked once per frame on the render thread after the frame is drawn.
+	 */
+	public void onRenderDrawFrame() {}
+
 	/**
 	 * When using the Vulkan renderer, this is invoked once per frame on the Vulkan thread after
 	 * the frame is drawn.
+	 *
+	 * @deprecated Use {@link #onRenderDrawFrame()} instead.
 	 */
+	@Deprecated
 	public void onVkDrawFrame() {}
 
 	/**
 	 * When using the Vulkan renderer, this is called on the Vulkan thread after the surface is
 	 * created and whenever the surface size changes.
+	 *
+	 * @deprecated Use {@link #onRenderSurfaceChanged(Surface, int, int)} instead.
 	 */
+	@Deprecated
 	public void onVkSurfaceChanged(Surface surface, int width, int height) {}
 
 	/**
 	 * When using the Vulkan renderer, this is called on the Vulkan thread when the surface is
 	 * created or recreated.
+	 *
+	 * @deprecated Use {@link #onRenderSurfaceCreated(Surface)} instead.
 	 */
+	@Deprecated
 	public void onVkSurfaceCreated(Surface surface) {}
 
 	/**