瀏覽代碼

Merge pull request #98264 from DevPoodle/rd-texture-format-docs

Add descriptions to RDTextureFormat's methods
Thaddeus Crews 10 月之前
父節點
當前提交
3128bd06ac
共有 2 個文件被更改,包括 3 次插入1 次删除
  1. 2 0
      doc/classes/RDTextureFormat.xml
  2. 1 1
      doc/classes/RDTextureView.xml

+ 2 - 0
doc/classes/RDTextureFormat.xml

@@ -13,12 +13,14 @@
 			<return type="void" />
 			<return type="void" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<description>
 			<description>
+				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.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="remove_shareable_format">
 		<method name="remove_shareable_format">
 			<return type="void" />
 			<return type="void" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
 			<description>
 			<description>
+				Removes [param format] from the list of valid formats that the corresponding [RDTextureView]'s [member RDTextureView.format_override] property can be set to.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>

+ 1 - 1
doc/classes/RDTextureView.xml

@@ -10,7 +10,7 @@
 	</tutorials>
 	</tutorials>
 	<members>
 	<members>
 		<member name="format_override" type="int" setter="set_format_override" getter="get_format_override" enum="RenderingDevice.DataFormat" default="218">
 		<member name="format_override" type="int" setter="set_format_override" getter="get_format_override" enum="RenderingDevice.DataFormat" default="218">
-			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.
+			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.
 		</member>
 		</member>
 		<member name="swizzle_a" type="int" setter="set_swizzle_a" getter="get_swizzle_a" enum="RenderingDevice.TextureSwizzle" default="6">
 		<member name="swizzle_a" type="int" setter="set_swizzle_a" getter="get_swizzle_a" enum="RenderingDevice.TextureSwizzle" default="6">
 			The channel to sample when sampling the alpha channel.
 			The channel to sample when sampling the alpha channel.