Files
godot-docs/classes/class_streamtexture.rst
2020-03-13 17:17:50 +01:00

61 lines
1.9 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the StreamTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_StreamTexture:
StreamTexture
=============
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A ``.stex`` texture.
Description
-----------
A texture that is loaded from a ``.stex`` file.
Properties
----------
+-----------------------------+----------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`load_path<class_StreamTexture_property_load_path>` | ``""`` |
+-----------------------------+----------------------------------------------------------+--------+
Methods
-------
+---------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_StreamTexture_method_load>` **(** :ref:`String<class_String>` path **)** |
+---------------------------------------+-------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_StreamTexture_property_load_path:
- :ref:`String<class_String>` **load_path**
+-----------+-----------------+
| *Default* | ``""`` |
+-----------+-----------------+
| *Setter* | load(value) |
+-----------+-----------------+
| *Getter* | get_load_path() |
+-----------+-----------------+
The StreamTexture's file path to a ``.stex`` file.
Method Descriptions
-------------------
.. _class_StreamTexture_method_load:
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the texture from the given path.