class_compressedtexture2d.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture2D.xml.
  6. .. _class_CompressedTexture2D:
  7. CompressedTexture2D
  8. ===================
  9. **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A ``.ctex`` texture.
  11. Description
  12. -----------
  13. A texture that is loaded from a ``.ctex`` file.
  14. Properties
  15. ----------
  16. +-----------------------------+----------------------------------------------------------------+--------+
  17. | :ref:`String<class_String>` | :ref:`load_path<class_CompressedTexture2D_property_load_path>` | ``""`` |
  18. +-----------------------------+----------------------------------------------------------------+--------+
  19. Methods
  20. -------
  21. +---------------------------------------+-------------------------------------------------------------------------------------------------+
  22. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_CompressedTexture2D_method_load>` **(** :ref:`String<class_String>` path **)** |
  23. +---------------------------------------+-------------------------------------------------------------------------------------------------+
  24. Property Descriptions
  25. ---------------------
  26. .. _class_CompressedTexture2D_property_load_path:
  27. - :ref:`String<class_String>` **load_path**
  28. +-----------+-----------------+
  29. | *Default* | ``""`` |
  30. +-----------+-----------------+
  31. | *Setter* | load(value) |
  32. +-----------+-----------------+
  33. | *Getter* | get_load_path() |
  34. +-----------+-----------------+
  35. The CompressedTexture's file path to a ``.ctex`` file.
  36. Method Descriptions
  37. -------------------
  38. .. _class_CompressedTexture2D_method_load:
  39. - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
  40. Loads the texture from the given path.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`