godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TextureLayered.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

105 lines
3.7 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="TextureLayered" inherits="Texture" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<brief_description>
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com>
2022-09-08 08:19:54 +00:00
Base class for texture types which contain the data of multiple [Image]s. Each image is of the same size and format.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</brief_description>
<description>
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com>
2022-09-08 08:19:54 +00:00
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.
All images need to have the same width, height and number of mipmap levels.
A [TextureLayered] can be loaded with [code]method ResourceFormatLoader.load[/code].
To create such a texture file yourself, re-import your image files using the Godot Editor import presets.
Internally, Godot maps these files to their respective counterparts in the target rendering driver (GLES3, Vulkan).
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Discern between virtual and abstract class bindings * Previous "virtual" classes (which can't be instantiated) are not corretly named "abstract". * Added a new "virtual" category for classes, they can't be instantiated from the editor, but can be inherited from script and extensions. * Converted a large amount of classes from "abstract" to "virtual" where it makes sense. Most classes that make sense have been converted. Missing: * Physics servers * VideoStream * Script* classes. which will go in a separate PR due to the complexity involved.
2022-03-10 07:17:38 +00:00
<method name="_get_format" qualifiers="virtual const">
<return type="int" enum="Image.Format" />
<description>
</description>
</method>
<method name="_get_height" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_layer_data" qualifiers="virtual const">
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Discern between virtual and abstract class bindings * Previous "virtual" classes (which can't be instantiated) are not corretly named "abstract". * Added a new "virtual" category for classes, they can't be instantiated from the editor, but can be inherited from script and extensions. * Converted a large amount of classes from "abstract" to "virtual" where it makes sense. Most classes that make sense have been converted. Missing: * Physics servers * VideoStream * Script* classes. which will go in a separate PR due to the complexity involved.
2022-03-10 07:17:38 +00:00
<description>
</description>
</method>
<method name="_get_layered_type" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_layers" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_width" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_has_mipmaps" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<method name="get_format" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="Image.Format" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
Finish documenting BakedLightmap and TextureLayered
2020-02-04 20:25:02 +00:00
Returns the current format being used by this texture. See [enum Image.Format] for details.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name="get_height" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
Finish documenting BakedLightmap and TextureLayered
2020-02-04 20:25:02 +00:00
Returns the height of the texture. Height is typically represented by the Y-axis.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name="get_layer_data" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer" type="int" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns an [Image] resource with the data from specified [param layer].
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 08:10:34 +00:00
<method name="get_layered_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextureLayered.LayeredType" />
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 08:10:34 +00:00
<description>
</description>
</method>
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 08:59:06 +00:00
<method name="get_layers" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com>
2022-09-08 08:19:54 +00:00
Returns the number of referenced [Image]s.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
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 08:59:06 +00:00
<method name="get_width" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
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 08:59:06 +00:00
Returns the width of the texture. Width is typically represented by the X-axis.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 08:10:34 +00:00
<method name="has_mipmaps" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com>
2022-09-08 08:19:54 +00:00
Returns [code]true[/code] if the layers have generated mipmaps.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
</methods>
<constants>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 08:10:34 +00:00
<constant name="LAYERED_TYPE_2D_ARRAY" value="0" enum="LayeredType">
</constant>
<constant name="LAYERED_TYPE_CUBEMAP" value="1" enum="LayeredType">
</constant>
<constant name="LAYERED_TYPE_CUBEMAP_ARRAY" value="2" enum="LayeredType">
</constant>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constants>
</class>