mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
66 lines
2.5 KiB
ReStructuredText
66 lines
2.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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:`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:`int<class_int>` | flags | ``0`` *(parent override)* |
|
|
+-----------------------------+----------------------------------------------------------+---------------------------+
|
|
| :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.
|
|
|
|
.. |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.)`
|