class_externaltexture.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ExternalTexture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ExternalTexture:
  6. ExternalTexture
  7. ===============
  8. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Enable OpenGL ES external texture extension.
  10. Description
  11. -----------
  12. 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>`__.
  13. **Note:** This is only supported for Android platforms.
  14. Properties
  15. ----------
  16. +-------------------------------+--------------------------------------------------+------------------------------+
  17. | :ref:`int<class_int>` | flags | ``2048`` *(parent override)* |
  18. +-------------------------------+--------------------------------------------------+------------------------------+
  19. | :ref:`Vector2<class_Vector2>` | :ref:`size<class_ExternalTexture_property_size>` | ``Vector2( 1, 1 )`` |
  20. +-------------------------------+--------------------------------------------------+------------------------------+
  21. Methods
  22. -------
  23. +-----------------------+--------------------------------------------------------------------------------------------------+
  24. | :ref:`int<class_int>` | :ref:`get_external_texture_id<class_ExternalTexture_method_get_external_texture_id>` **(** **)** |
  25. +-----------------------+--------------------------------------------------------------------------------------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_ExternalTexture_property_size:
  29. - :ref:`Vector2<class_Vector2>` **size**
  30. +-----------+---------------------+
  31. | *Default* | ``Vector2( 1, 1 )`` |
  32. +-----------+---------------------+
  33. | *Setter* | set_size(value) |
  34. +-----------+---------------------+
  35. | *Getter* | get_size() |
  36. +-----------+---------------------+
  37. External texture size.
  38. Method Descriptions
  39. -------------------
  40. .. _class_ExternalTexture_method_get_external_texture_id:
  41. - :ref:`int<class_int>` **get_external_texture_id** **(** **)**
  42. Returns the external texture name.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`