godot/doc/classes/TextureLayered.xml
Rémi Verschelde 0e3d625737 doc: Sync classref with current source
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.

Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00

70 lines
2.0 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextureLayered" inherits="Resource" version="4.0">
<brief_description>
Base class for 3D texture types.
</brief_description>
<description>
Base class for [Texture2DArray], [Cubemap] and [CubemapArray]. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. Data is set on a per-layer basis. For [Texture2DArray]s, the layer specifies the array layer.
</description>
<tutorials>
</tutorials>
<methods>
<method name="create_from_images">
<return type="int" enum="Error">
</return>
<argument index="0" name="images" type="Array">
</argument>
<description>
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="Image.Format">
</return>
<description>
Returns the current format being used by this texture. See [enum Image.Format] for details.
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="int">
</return>
<description>
Returns the height of the texture. Height is typically represented by the Y-axis.
</description>
</method>
<method name="get_layer_data" qualifiers="const">
<return type="Image">
</return>
<argument index="0" name="layer" type="int">
</argument>
<description>
Returns an [Image] resource with the data from specified [code]layer[/code].
</description>
</method>
<method name="get_layers" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_width" qualifiers="const">
<return type="int">
</return>
<description>
Returns the width of the texture. Width is typically represented by the X-axis.
</description>
</method>
<method name="update_layer">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<argument index="1" name="layer" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>