Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

ExternalTexture

Inherits: Texture2D < Texture < Resource < RefCounted < Object

Texture which displays the content of an external buffer.

Description

Displays the content of an external buffer provided by the platform.

Requires the OES_EGL_image_external extension (OpenGL) or VK_ANDROID_external_memory_android_hardware_buffer extension (Vulkan).

Note: This is currently only supported in Android builds.

Properties

bool

resource_local_to_scene

false (overrides Resource)

Vector2

size

Vector2(256, 256)

Methods

int

get_external_texture_id() const

void

set_external_buffer_id(external_buffer_id: int)

Property Descriptions

Vector2 size = Vector2(256, 256) 🔗

External texture size.

Method Descriptions

int get_external_texture_id() const 🔗

Returns the external texture ID.

Depending on your use case, you may need to pass this to platform APIs, for example, when creating an android.graphics.SurfaceTexture on Android.

void set_external_buffer_id(external_buffer_id: int) 🔗

Sets the external buffer ID.

Depending on your use case, you may need to call this with data received from a platform API, for example, SurfaceTexture.getHardwareBuffer() on Android.