class_externaltexture.rst 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ExternalTexture.xml.
  6. .. _class_ExternalTexture:
  7. ExternalTexture
  8. ===============
  9. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Enable OpenGL ES external texture extension.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. 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>`__.
  15. \ **Note:** This is only supported for Android platforms.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------+--------------------------------------------------+-------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | flags | ``2048`` (overrides :ref:`Texture<class_Texture_property_flags>`) |
  23. +-------------------------------+--------------------------------------------------+-------------------------------------------------------------------+
  24. | :ref:`Vector2<class_Vector2>` | :ref:`size<class_ExternalTexture_property_size>` | ``Vector2( 1, 1 )`` |
  25. +-------------------------------+--------------------------------------------------+-------------------------------------------------------------------+
  26. .. rst-class:: classref-reftable-group
  27. Methods
  28. -------
  29. .. table::
  30. :widths: auto
  31. +-----------------------+--------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`get_external_texture_id<class_ExternalTexture_method_get_external_texture_id>` **(** **)** |
  33. +-----------------------+--------------------------------------------------------------------------------------------------+
  34. .. rst-class:: classref-section-separator
  35. ----
  36. .. rst-class:: classref-descriptions-group
  37. Property Descriptions
  38. ---------------------
  39. .. _class_ExternalTexture_property_size:
  40. .. rst-class:: classref-property
  41. :ref:`Vector2<class_Vector2>` **size** = ``Vector2( 1, 1 )``
  42. .. rst-class:: classref-property-setget
  43. - void **set_size** **(** :ref:`Vector2<class_Vector2>` value **)**
  44. - :ref:`Vector2<class_Vector2>` **get_size** **(** **)**
  45. External texture size.
  46. .. rst-class:: classref-section-separator
  47. ----
  48. .. rst-class:: classref-descriptions-group
  49. Method Descriptions
  50. -------------------
  51. .. _class_ExternalTexture_method_get_external_texture_id:
  52. .. rst-class:: classref-method
  53. :ref:`int<class_int>` **get_external_texture_id** **(** **)**
  54. Returns the external texture name.
  55. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  56. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  57. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  58. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`