Skip to content

[DRAFT] Support multi-threaded rendering with OpenGL on Android #109080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
+2,080 −2,614
Draft

[DRAFT] Support multi-threaded rendering with OpenGL on Android #109080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2739356
Unify and clean-up Godot Android surface allocation and render thread…
m4gr3d Apr 18, 2025
b4fd273
Migrate `GodotGLRenderView` & `GodotVulkanRenderView` to Kotlin - part 1
m4gr3d Apr 18, 2025
5ebcd66
Migrate `GodotGLRenderView` & `GodotVulkanRenderView` to Kotlin - part 2
m4gr3d Apr 18, 2025
1659b4b
Switch from the `javax.microedition.khronos.*` to the `androd.opengl.…
m4gr3d Aug 6, 2025
d8eea1e
Support multi-threaded rendering with OpenGL on Android
dsnopek Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion platform/android/SCsub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ android_files = [
"java_godot_lib_jni.cpp",
"java_class_wrapper.cpp",
"java_godot_wrapper.cpp",
"java_godot_view_wrapper.cpp",
"java_godot_io_wrapper.cpp",
"jni_utils.cpp",
"android_keys_utils.cpp",
Expand Down
85 changes: 58 additions & 27 deletions platform/android/display_server_android.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
#include "tts_android.h"

#include "core/config/project_settings.h"
#include "main/main.h"

#if defined(RD_ENABLED)
#include "servers/rendering/renderer_rd/renderer_compositor_rd.h"
Expand Down Expand Up @@ -484,24 +485,16 @@ int64_t DisplayServerAndroid::window_get_native_handle(HandleType p_handle_type,
}
#ifdef GLES3_ENABLED
case DISPLAY_HANDLE: {
if (rendering_driver == "opengl3") {
return reinterpret_cast<int64_t>(eglGetCurrentDisplay());
}
return 0;
return reinterpret_cast<int64_t>(egl_display);
}
case OPENGL_CONTEXT: {
if (rendering_driver == "opengl3") {
return reinterpret_cast<int64_t>(eglGetCurrentContext());
}
return 0;
return reinterpret_cast<int64_t>(egl_context);
}
case EGL_DISPLAY: {
// @todo Find a way to get this from the Java side.
return 0;
return reinterpret_cast<int64_t>(egl_display);
}
case EGL_CONFIG: {
// @todo Find a way to get this from the Java side.
return 0;
return reinterpret_cast<int64_t>(egl_config);
}
#endif
default: {
Expand Down Expand Up @@ -703,6 +696,9 @@ void DisplayServerAndroid::reset_window() {
}
}
#endif

// We force redraw to ensure we render at least once when the window is reset.
Main::force_redraw();
}

void DisplayServerAndroid::notify_surface_changed(int p_width, int p_height) {
Expand All @@ -711,6 +707,15 @@ void DisplayServerAndroid::notify_surface_changed(int p_width, int p_height) {
}
}

void DisplayServerAndroid::update_egl_resources(void *p_display, void *p_surface, void *p_context, void *p_config) {
#ifdef GLES3_ENABLED
egl_display = p_display;
egl_surface = p_surface;
egl_context = p_context;
egl_config = p_config;
#endif
}

DisplayServerAndroid::DisplayServerAndroid(const String &p_rendering_driver, DisplayServer::WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error) {
rendering_driver = p_rendering_driver;

Expand Down Expand Up @@ -792,6 +797,11 @@ DisplayServerAndroid::DisplayServerAndroid(const String &p_rendering_driver, Dis
#if defined(GLES3_ENABLED)
if (rendering_driver == "opengl3") {
RasterizerGLES3::make_current(false);

if (OS::get_singleton()->is_separate_thread_rendering_enabled()) {
GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
godot_java->set_separate_render_thread_enabled(true);
}
}
#endif

Expand Down Expand Up @@ -837,23 +847,23 @@ void DisplayServerAndroid::_mouse_update_mode() {
? mouse_mode_override
: mouse_mode_base;

if (!OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_update_pointer_icon() || !OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_capture_pointer()) {
if (!OS_Android::get_singleton()->get_godot_java()->can_capture_pointer()) {
return;
}
if (mouse_mode == wanted_mouse_mode) {
return;
}

if (wanted_mouse_mode == MouseMode::MOUSE_MODE_HIDDEN) {
OS_Android::get_singleton()->get_godot_java()->get_godot_view()->set_pointer_icon(CURSOR_TYPE_NULL);
OS_Android::get_singleton()->get_godot_java()->set_pointer_icon(CURSOR_TYPE_NULL);
} else {
cursor_set_shape(cursor_shape);
}

if (wanted_mouse_mode == MouseMode::MOUSE_MODE_CAPTURED) {
OS_Android::get_singleton()->get_godot_java()->get_godot_view()->request_pointer_capture();
OS_Android::get_singleton()->get_godot_java()->request_pointer_capture();
} else {
OS_Android::get_singleton()->get_godot_java()->get_godot_view()->release_pointer_capture();
OS_Android::get_singleton()->get_godot_java()->release_pointer_capture();
}

mouse_mode = wanted_mouse_mode;
Expand Down Expand Up @@ -903,17 +913,14 @@ BitField<MouseButtonMask> DisplayServerAndroid::mouse_get_button_state() const {
}

void DisplayServerAndroid::_cursor_set_shape_helper(CursorShape p_shape, bool force) {
if (!OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_update_pointer_icon()) {
return;
}
if (cursor_shape == p_shape && !force) {
return;
}

cursor_shape = p_shape;

if (mouse_mode == MouseMode::MOUSE_MODE_VISIBLE || mouse_mode == MouseMode::MOUSE_MODE_CONFINED) {
OS_Android::get_singleton()->get_godot_java()->get_godot_view()->set_pointer_icon(android_cursors[cursor_shape]);
OS_Android::get_singleton()->get_godot_java()->set_pointer_icon(android_cursors[cursor_shape]);
}
}

Expand All @@ -932,7 +939,7 @@ void DisplayServerAndroid::cursor_set_custom_image(const Ref<Resource> &p_cursor
if (!cursor_path.is_empty()) {
cursor_path = ProjectSettings::get_singleton()->globalize_path(cursor_path);
}
OS_Android::get_singleton()->get_godot_java()->get_godot_view()->configure_pointer_icon(android_cursors[cursor_shape], cursor_path, p_hotspot);
OS_Android::get_singleton()->get_godot_java()->configure_pointer_icon(android_cursors[cursor_shape], cursor_path, p_hotspot);
_cursor_set_shape_helper(p_shape, true);
}

Expand All @@ -953,16 +960,25 @@ DisplayServer::VSyncMode DisplayServerAndroid::window_get_vsync_mode(WindowID p_
return DisplayServer::VSYNC_ENABLED;
}

void DisplayServerAndroid::reset_swap_buffers_flag() {
swap_buffers_flag = false;
}
void DisplayServerAndroid::release_rendering_thread() {
if (egl_current_window_id == INVALID_WINDOW_ID) {
return;
}

bool DisplayServerAndroid::should_swap_buffers() const {
return swap_buffers_flag;
GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
ERR_FAIL_NULL(godot_java);
godot_java->release_current_gl_window(egl_current_window_id);
egl_current_window_id = INVALID_WINDOW_ID;
}

void DisplayServerAndroid::swap_buffers() {
swap_buffers_flag = true;
if (egl_current_window_id == INVALID_WINDOW_ID) {
return;
}

GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
ERR_FAIL_NULL(godot_java);
godot_java->egl_swap_buffers(egl_current_window_id);
}

void DisplayServerAndroid::set_native_icon(const String &p_filename) {
Expand All @@ -976,3 +992,18 @@ void DisplayServerAndroid::set_icon(const Ref<Image> &p_icon) {
bool DisplayServerAndroid::is_window_transparency_available() const {
return GLOBAL_GET_CACHED(bool, "display/window/per_pixel_transparency/allowed");
}

void DisplayServerAndroid::gl_window_make_current(DisplayServer::WindowID p_window_id) {
if (p_window_id == INVALID_WINDOW_ID) {
return;
}

if (egl_current_window_id == p_window_id) {
return;
}

GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
ERR_FAIL_NULL(godot_java);
godot_java->make_gl_window_current(p_window_id);
egl_current_window_id = p_window_id;
}
16 changes: 13 additions & 3 deletions platform/android/display_server_android.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,22 @@ class DisplayServerAndroid : public DisplayServer {
void _mouse_update_mode();

bool keep_screen_on;
bool swap_buffers_flag;
WindowID egl_current_window_id = MAIN_WINDOW_ID;

CursorShape cursor_shape = CursorShape::CURSOR_ARROW;

#if defined(RD_ENABLED)
RenderingContextDriver *rendering_context = nullptr;
RenderingDevice *rendering_device = nullptr;
#endif

#ifdef GLES3_ENABLED
void *egl_display = nullptr;
void *egl_surface = nullptr;
void *egl_context = nullptr;
void *egl_config = nullptr;
#endif

NativeMenu *native_menu = nullptr;

ObjectID window_attached_instance_id;
Expand Down Expand Up @@ -245,19 +253,21 @@ class DisplayServerAndroid : public DisplayServer {

void reset_window();
void notify_surface_changed(int p_width, int p_height);
void update_egl_resources(void *p_display, void *p_surface, void *p_context, void *p_config);

virtual Point2i mouse_get_position() const override;
virtual BitField<MouseButtonMask> mouse_get_button_state() const override;

void reset_swap_buffers_flag();
bool should_swap_buffers() const;
virtual void release_rendering_thread() override;
virtual void swap_buffers() override;

virtual void set_native_icon(const String &p_filename) override;
virtual void set_icon(const Ref<Image> &p_icon) override;

virtual bool is_window_transparency_available() const override;

virtual void gl_window_make_current(WindowID p_window_id) override;

DisplayServerAndroid(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);
~DisplayServerAndroid();
};
2 changes: 1 addition & 1 deletion platform/android/java/editor/src/main/java/org/godotengine/editor/BaseGodotEditor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading
Loading