| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CompressedTexture2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CompressedTexture2D:
- CompressedTexture2D
- ===================
- **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A ``.ctex`` texture.
- Description
- -----------
- A texture that is loaded from a ``.ctex`` file.
- Properties
- ----------
- +-----------------------------+----------------------------------------------------------------+--------+
- | :ref:`String<class_String>` | :ref:`load_path<class_CompressedTexture2D_property_load_path>` | ``""`` |
- +-----------------------------+----------------------------------------------------------------+--------+
- Methods
- -------
- +---------------------------------------+-------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_CompressedTexture2D_method_load>` **(** :ref:`String<class_String>` path **)** |
- +---------------------------------------+-------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_CompressedTexture2D_property_load_path:
- - :ref:`String<class_String>` **load_path**
- +-----------+-----------------+
- | *Default* | ``""`` |
- +-----------+-----------------+
- | *Setter* | load(value) |
- +-----------+-----------------+
- | *Getter* | get_load_path() |
- +-----------+-----------------+
- The CompressedTexture's file path to a ``.ctex`` file.
- Method Descriptions
- -------------------
- .. _class_CompressedTexture2D_method_load:
- - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
- Loads the texture from the given path.
- .. |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.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
