2020-05-16 00:24:38 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "ImageTextureLayered" inherits= "TextureLayered" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2020-05-16 00:24:38 +08:00
<brief_description >
2022-10-25 05:19:32 +08:00
Base class for texture types which contain the data of multiple [ImageTexture]s. Each image is of the same size and format.
2020-05-16 00:24:38 +08:00
</brief_description>
<description >
2022-10-25 05:19:32 +08:00
Base class for [Texture2DArray], [Cubemap] and [CubemapArray]. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also [Texture3D].
2020-05-16 00:24:38 +08:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "create_from_images" >
2021-07-30 21:28:05 +08:00
<return type= "int" enum= "Error" />
2022-09-01 01:24:04 +08:00
<param index= "0" name= "images" type= "Image[]" />
2020-05-16 00:24:38 +08:00
<description >
2022-10-25 05:19:32 +08:00
Creates an [ImageTextureLayered] from an array of [Image]s. See [method Image.create] for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images [i]must[/i] have the same width, height, image format and mipmapping setting.
2022-09-08 16:19:54 +08:00
Each [Image] represents one [code]layer[/code].
2020-05-16 00:24:38 +08:00
</description>
</method>
<method name= "update_layer" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "image" type= "Image" />
<param index= "1" name= "layer" type= "int" />
2020-05-16 00:24:38 +08:00
<description >
2023-04-27 03:36:04 +08:00
Replaces the existing [Image] data at the given [param layer] with this new image.
2023-10-03 02:11:43 +08:00
The given [Image] must have the same width, height, image format, and mipmapping flag as the rest of the referenced images.
2022-09-08 16:19:54 +08:00
If the image format is unsupported, it will be decompressed and converted to a similar and supported [enum Image.Format].
2022-10-25 05:19:32 +08:00
The update is immediate: it's synchronized with drawing.
2020-05-16 00:24:38 +08:00
</description>
</method>
</methods>
</class>