godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation

Browse Source 
This brings the overall class reference completion percentage from 87% to 92%.
This commit is contained in:
Hugo Locurcio
2023-03-28 17:32:29 +02:00
parent 64eeb04d2c
commit 5056c427d3
30 changed files with 1378 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/classes/RDTextureFormat.xml
View File

@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RDTextureFormat" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Texture format (used by [RenderingDevice]).
</brief_description>
<description>
This object is used by [RenderingDevice].
</description>
<tutorials>
</tutorials>
@@ -22,22 +24,31 @@
</methods>
<members>
<member name="array_layers" type="int" setter="set_array_layers" getter="get_array_layers" default="1">
The number of layers in the texture. Only relevant for 2D texture arrays.
</member>
<member name="depth" type="int" setter="set_depth" getter="get_depth" default="1">
The texture's depth (in pixels). This is always [code]1[/code] for 2D textures.
</member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="RenderingDevice.DataFormat" default="8">
The texture's pixel data format.
</member>
<member name="height" type="int" setter="set_height" getter="get_height" default="1">
The texture's height (in pixels).
</member>
<member name="mipmaps" type="int" setter="set_mipmaps" getter="get_mipmaps" default="1">
The number of mipmaps available in the texture.
</member>
<member name="samples" type="int" setter="set_samples" getter="get_samples" enum="RenderingDevice.TextureSamples" default="0">
The number of samples used when sampling the texture.
</member>
<member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="RenderingDevice.TextureType" default="1">
The texture type.
</member>
<member name="usage_bits" type="int" setter="set_usage_bits" getter="get_usage_bits" enum="RenderingDevice.TextureUsageBits" default="0">
The texture's usage bits, which determine what can be done using the texture.
</member>
<member name="width" type="int" setter="set_width" getter="get_width" default="1">
The texture's width (in pixels).
</member>
</members>
</class>