Skip to content

Commit a0829dc

Browse files
committed
Add descriptions to RDTextureFormat's methods
1 parent 04692d8 commit a0829dc

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

doc/classes/RDTextureFormat.xml

+2
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313
<return type="void" />
1414
<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
1515
<description>
16+
Adds [param format] as a valid format for the corresponding [RDTextureView]'s [member RDTextureView.format_override] property. If any format is added as shareable, then the main [member format] must also be added.
1617
</description>
1718
</method>
1819
<method name="remove_shareable_format">
1920
<return type="void" />
2021
<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
2122
<description>
23+
Removes [param format] from the list of valid formats that the corresponding [RDTextureView]'s [member RDTextureView.format_override] property can be set to.
2224
</description>
2325
</method>
2426
</methods>

doc/classes/RDTextureView.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
</tutorials>
1111
<members>
1212
<member name="format_override" type="int" setter="set_format_override" getter="get_format_override" enum="RenderingDevice.DataFormat" default="218">
13-
Optional override for the data format to return sampled values in. The default value of [constant RenderingDevice.DATA_FORMAT_MAX] does not override the format.
13+
Optional override for the data format to return sampled values in. The corresponding [RDTextureFormat] must have had this added as a shareable format. The default value of [constant RenderingDevice.DATA_FORMAT_MAX] does not override the format.
1414
</member>
1515
<member name="swizzle_a" type="int" setter="set_swizzle_a" getter="get_swizzle_a" enum="RenderingDevice.TextureSwizzle" default="6">
1616
The channel to sample when sampling the alpha channel.

0 commit comments

Comments
 (0)