diff options
Diffstat (limited to 'doc/classes/TextureLayered.xml')
| -rw-r--r-- | doc/classes/TextureLayered.xml | 66 |
1 files changed, 9 insertions, 57 deletions
diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index f20f46b6c4..f9ecdb02f0 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -4,33 +4,17 @@ Base class for 3D texture types. </brief_description> <description> - Base class for [Texture3D] and [TextureArray]. Cannot be used directly, but contains all the functions necessary for accessing and using [Texture3D] and [TextureArray]. Data is set on a per-layer basis. For [Texture3D]s, the layer sepcifies the depth or Z-index, they can be treated as a bunch of 2D slices. Similarly, for [TextureArray]s, the layer specifies the array layer. + 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"> - <return type="void"> + <method name="create_from_images"> + <return type="int" enum="Error"> </return> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <argument index="2" name="depth" type="int"> - </argument> - <argument index="3" name="format" type="int" enum="Image.Format"> - </argument> - <argument index="4" name="flags" type="int" default="4"> + <argument index="0" name="images" type="Array"> </argument> <description> - Creates the [Texture3D] or [TextureArray] with specified [code]width[/code], [code]height[/code], and [code]depth[/code]. See [enum Image.Format] for [code]format[/code] options. See [enum Flags] enumerator for [code]flags[/code] options. - </description> - </method> - <method name="get_depth" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the depth of the texture. Depth is the 3rd dimension (typically Z-axis). </description> </method> <method name="get_format" qualifiers="const"> @@ -56,31 +40,20 @@ Returns an [Image] resource with the data from specified [code]layer[/code]. </description> </method> - <method name="get_width" qualifiers="const"> + <method name="get_layers" 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="set_data_partial"> - <return type="void"> + <method name="get_width" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="image" type="Image"> - </argument> - <argument index="1" name="x_offset" type="int"> - </argument> - <argument index="2" name="y_offset" type="int"> - </argument> - <argument index="3" name="layer" type="int"> - </argument> - <argument index="4" name="mipmap" type="int" default="0"> - </argument> <description> - Partially sets the data for a specified [code]layer[/code] by overwriting using the data of the specified [code]image[/code]. [code]x_offset[/code] and [code]y_offset[/code] determine where the [Image] is "stamped" over the texture. The [code]image[/code] must fit within the texture. + Returns the width of the texture. Width is typically represented by the X-axis. </description> </method> - <method name="set_layer_data"> + <method name="update_layer"> <return type="void"> </return> <argument index="0" name="image" type="Image"> @@ -88,30 +61,9 @@ <argument index="1" name="layer" type="int"> </argument> <description> - Sets the data for the specified layer. Data takes the form of a 2-dimensional [Image] resource. </description> </method> </methods> - <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data" default="{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}"> - Returns a dictionary with all the data used by this texture. - </member> - <member name="flags" type="int" setter="set_flags" getter="get_flags" default="4"> - Specifies which [enum Flags] apply to this texture. - </member> - </members> <constants> - <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> - Texture will generate mipmaps on creation. - </constant> - <constant name="FLAG_REPEAT" value="2" enum="Flags"> - Texture will repeat when UV used is outside the 0-1 range. - </constant> - <constant name="FLAG_FILTER" value="4" enum="Flags"> - Use filtering when reading from texture. Filtering smooths out pixels. Turning filtering off is slightly faster and more appropriate when you need access to individual pixels. - </constant> - <constant name="FLAGS_DEFAULT" value="4" enum="Flags"> - Equivalent to [constant FLAG_FILTER]. - </constant> </constants> </class> |