class_streamtexture.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 StreamTexture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_StreamTexture:
  6. StreamTexture
  7. =============
  8. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A ``.stex`` texture.
  10. Description
  11. -----------
  12. A texture that is loaded from a ``.stex`` file.
  13. Properties
  14. ----------
  15. +-----------------------------+----------------------------------------------------------+---------------------------+
  16. | :ref:`int<class_int>` | flags | ``0`` *(parent override)* |
  17. +-----------------------------+----------------------------------------------------------+---------------------------+
  18. | :ref:`String<class_String>` | :ref:`load_path<class_StreamTexture_property_load_path>` | ``""`` |
  19. +-----------------------------+----------------------------------------------------------+---------------------------+
  20. Methods
  21. -------
  22. +---------------------------------------+-------------------------------------------------------------------------------------------+
  23. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_StreamTexture_method_load>` **(** :ref:`String<class_String>` path **)** |
  24. +---------------------------------------+-------------------------------------------------------------------------------------------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_StreamTexture_property_load_path:
  28. - :ref:`String<class_String>` **load_path**
  29. +-----------+-----------------+
  30. | *Default* | ``""`` |
  31. +-----------+-----------------+
  32. | *Setter* | load(value) |
  33. +-----------+-----------------+
  34. | *Getter* | get_load_path() |
  35. +-----------+-----------------+
  36. The StreamTexture's file path to a ``.stex`` file.
  37. Method Descriptions
  38. -------------------
  39. .. _class_StreamTexture_method_load:
  40. - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
  41. Loads the texture from the given path.
  42. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`