pandemonium_engine_docs/classes/class_externaltexture.rst

68 lines
2.7 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ExternalTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ExternalTexture:
ExternalTexture
===============
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Enable OpenGL ES external texture extension.
Description
-----------
Enable support for the OpenGL ES external texture extension as defined by `OES_EGL_image_external <https://www.khronos.org/registry/OpenGL/extensions/OES/OES_EGL_image_external.txt>`__.
**Note:** This is only supported for Android platforms.
Properties
----------
+-------------------------------+--------------------------------------------------+------------------------------+
| :ref:`int<class_int>` | flags | ``2048`` *(parent override)* |
+-------------------------------+--------------------------------------------------+------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_ExternalTexture_property_size>` | ``Vector2( 1, 1 )`` |
+-------------------------------+--------------------------------------------------+------------------------------+
Methods
-------
+-----------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_external_texture_id<class_ExternalTexture_method_get_external_texture_id>` **(** **)** |
+-----------------------+--------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_ExternalTexture_property_size:
- :ref:`Vector2<class_Vector2>` **size**
+-----------+---------------------+
| *Default* | ``Vector2( 1, 1 )`` |
+-----------+---------------------+
| *Setter* | set_size(value) |
+-----------+---------------------+
| *Getter* | get_size() |
+-----------+---------------------+
External texture size.
Method Descriptions
-------------------
.. _class_ExternalTexture_method_get_external_texture_id:
- :ref:`int<class_int>` **get_external_texture_id** **(** **)**
Returns the external texture name.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`