virtualx-engine/doc/classes/Material.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Material" inherits="Resource" version="4.0">
	<brief_description>
		Abstract base [Resource] for coloring and shading geometry.
	</brief_description>
	<description>
		Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance3D] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here.
	</description>
	<tutorials>
		<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<methods>
		<method name="inspect_native_shader_code">
			<return type="void" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass">
			Sets the [Material] to be used for the next pass. This renders the object again using a different material.
			[b]Note:[/b] only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".
		</member>
		<member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0">
			Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.
			[b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
		</member>
	</members>
	<constants>
		<constant name="RENDER_PRIORITY_MAX" value="127">
			Maximum value for the [member render_priority] parameter.
		</constant>
		<constant name="RENDER_PRIORITY_MIN" value="-128">
			Minimum value for the [member render_priority] parameter.
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="Material" inherits="Resource" version="4.0">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Abstract base [Resource] for coloring and shading geometry.`
			`</brief_description>`
			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance3D] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>`
			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`<methods>`
doc: Sync classref with current source 2021-01-28 11:26:37 +01:00			`<method name="inspect_native_shader_code">`
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 15:28:05 +02:00			`<return type="void" />`
doc: Sync classref with current source 2021-01-28 11:26:37 +01:00			`<description>`
			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</methods>`
			`<members>`
doc: Sync classref with current source 2019-07-15 20:42:47 +02:00			`<member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass">`
Finish up docs for materials 2020-01-21 01:28:03 +01:00			`Sets the [Material] to be used for the next pass. This renders the object again using a different material.`
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 09:59:06 +01:00			`[b]Note:[/b] only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0">`
Finish up docs for materials 2020-01-21 01:28:03 +01:00			`Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.`
Fix Material.render_priority doc: no opaque sort Opaque objects are rendered using the depth buffer, so the end result appears sorted, but the opaque objects themselves are not sorted. 2020-06-14 00:26:51 +02:00			`[b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="RENDER_PRIORITY_MAX" value="127">`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00			`Maximum value for the [member render_priority] parameter.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="RENDER_PRIORITY_MIN" value="-128">`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00			`Minimum value for the [member render_priority] parameter.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
			`</constants>`
			`</class>`