godot/doc/classes/Shader.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Shader" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A custom shader program.
	</brief_description>
	<description>
		This class allows you to define a custom shader program that can be used by a [ShaderMaterial]. Shaders allow you to write your own custom behavior for rendering objects or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.
	</description>
	<tutorials>
		<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link>
	</tutorials>
	<methods>
		<method name="get_default_texture_parameter" qualifiers="const">
			<return type="Texture2D" />
			<param index="0" name="name" type="StringName" />
			<param index="1" name="index" type="int" default="0" />
			<description>
				Returns the texture that is set as default for the specified parameter.
				[b]Note:[/b] [param name] must match the name of the uniform in the code exactly.
				[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
			</description>
		</method>
		<method name="get_mode" qualifiers="const">
			<return type="int" enum="Shader.Mode" />
			<description>
				Returns the shader mode for the shader, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES].
			</description>
		</method>
		<method name="get_shader_uniform_list">
			<return type="Array" />
			<param index="0" name="get_groups" type="bool" default="false" />
			<description>
				Get the list of shader uniforms that can be assigned to a [ShaderMaterial], for use with [method ShaderMaterial.set_shader_parameter] and [method ShaderMaterial.get_shader_parameter]. The parameters returned are contained in dictionaries in a similar format to the ones returned by [method Object.get_property_list].
				If argument [param get_groups] is true, parameter grouping hints will be provided.
			</description>
		</method>
		<method name="set_default_texture_parameter">
			<return type="void" />
			<param index="0" name="name" type="StringName" />
			<param index="1" name="texture" type="Texture2D" />
			<param index="2" name="index" type="int" default="0" />
			<description>
				Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial].
				[b]Note:[/b] [param name] must match the name of the uniform in the code exactly.
				[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
			</description>
		</method>
	</methods>
	<members>
		<member name="code" type="String" setter="set_code" getter="get_code" default="&quot;&quot;">
			Returns the shader's code as the user has written it, not the full generated code used internally.
		</member>
	</members>
	<constants>
		<constant name="MODE_SPATIAL" value="0" enum="Mode">
			Mode used to draw all 3D objects.
		</constant>
		<constant name="MODE_CANVAS_ITEM" value="1" enum="Mode">
			Mode used to draw all 2D objects.
		</constant>
		<constant name="MODE_PARTICLES" value="2" enum="Mode">
			Mode used to calculate particle information on a per-particle basis. Not used for drawing.
		</constant>
		<constant name="MODE_SKY" value="3" enum="Mode">
			Mode used for drawing skies. Only works with shaders attached to [Sky] objects.
		</constant>
		<constant name="MODE_FOG" value="4" enum="Mode">
			Mode used for setting the color and density of volumetric fog effect.
		</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-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 08:44:37 +08:00			`<class name="Shader" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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-13 04:42:36 +08:00			`<brief_description>`
Added some quick info on shaders to the docs 2018-05-26 10:08:34 +08:00			`A custom shader program.`
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-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`This class allows you to define a custom shader program that can be used by a [ShaderMaterial]. Shaders allow you to write your own custom behavior for rendering objects or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.`
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-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08:00			`<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</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-13 04:42:36 +08:00			`</tutorials>`
			`<methods>`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`<method name="get_default_texture_parameter" 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 21:28:05 +08:00			`<return type="Texture2D" />`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`<param index="0" name="name" type="StringName" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="1" name="index" type="int" default="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-13 04:42:36 +08:00			`<description>`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Returns the texture that is set as default for the specified parameter.`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`[b]Note:[/b] [param name] must match the name of the uniform in the code exactly.`
[doc] Use "param" instead of "code" to refer to parameters #3 2022-08-10 10:00:19 +08:00			`[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.`
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-13 04:42:36 +08:00			`</description>`
			`</method>`
			`<method name="get_mode" 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 21:28:05 +08:00			`<return type="int" enum="Shader.Mode" />`
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-13 04:42:36 +08:00			`<description>`
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`. 2020-01-23 18:14:14 +08:00			`Returns the shader mode for the shader, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES].`
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-13 04:42:36 +08:00			`</description>`
			`</method>`
Clean up shader parameter remap This PR is a follow up to #64092, which fixed important issues but it was implemented in an overly complex and inefficient way (because it forced the default code path to always go through string operations). This cleans up all the shader parameter code. This fixes #54336. Also fixes #56219 because, as the new code never queries the RenderingServer on load, potential deadlocks are avoided. NOTE: materials saved between #62972 and #64092 will no longer work and will need to be resaved in an earlier version. 2023-01-21 17:24:45 +08:00			`<method name="get_shader_uniform_list">`
			`<return type="Array" />`
			`<param index="0" name="get_groups" type="bool" default="false" />`
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-13 04:42:36 +08:00			`<description>`
Clean up shader parameter remap This PR is a follow up to #64092, which fixed important issues but it was implemented in an overly complex and inefficient way (because it forced the default code path to always go through string operations). This cleans up all the shader parameter code. This fixes #54336. Also fixes #56219 because, as the new code never queries the RenderingServer on load, potential deadlocks are avoided. NOTE: materials saved between #62972 and #64092 will no longer work and will need to be resaved in an earlier version. 2023-01-21 17:24:45 +08:00			`Get the list of shader uniforms that can be assigned to a [ShaderMaterial], for use with [method ShaderMaterial.set_shader_parameter] and [method ShaderMaterial.get_shader_parameter]. The parameters returned are contained in dictionaries in a similar format to the ones returned by [method Object.get_property_list].`
			`If argument [param get_groups] is true, parameter grouping hints will be provided.`
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-13 04:42:36 +08:00			`</description>`
			`</method>`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`<method name="set_default_texture_parameter">`
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 21:28:05 +08:00			`<return type="void" />`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`<param index="0" name="name" type="StringName" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="1" name="texture" type="Texture2D" />`
			`<param index="2" name="index" type="int" default="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-13 04:42:36 +08:00			`<description>`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial].`
Rename `uniform` to `parameter` across the engine 2022-08-27 17:22:43 +08:00			`[b]Note:[/b] [param name] must match the name of the uniform in the code exactly.`
[doc] Use "param" instead of "code" to refer to parameters #3 2022-08-10 10:00:19 +08:00			`[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.`
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-13 04:42:36 +08:00			`</description>`
			`</method>`
			`</methods>`
Update docs [ci skip] 2018-01-12 06:38:35 +08:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="code" type="String" setter="set_code" getter="get_code" default="""">`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Returns the shader's code as the user has written it, not the full generated code used internally.`
Update docs [ci skip] 2018-01-12 06:38:35 +08:00			`</member>`
			`</members>`
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-13 04:42:36 +08:00			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_SPATIAL" value="0" enum="Mode">`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Mode used to draw all 3D objects.`
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-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_CANVAS_ITEM" value="1" enum="Mode">`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Mode used to draw all 2D objects.`
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-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MODE_PARTICLES" value="2" enum="Mode">`
Finish up docs for materials 2020-01-21 08:28:03 +08:00			`Mode used to calculate particle information on a per-particle basis. Not used for drawing.`
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-13 04:42:36 +08:00			`</constant>`
Working sky shader implementation 2020-03-20 08:32:19 +08:00			`<constant name="MODE_SKY" value="3" enum="Mode">`
			`Mode used for drawing skies. Only works with shaders attached to [Sky] objects.`
			`</constant>`
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com> 2021-10-03 19:28:55 +08:00			`<constant name="MODE_FOG" value="4" enum="Mode">`
			`Mode used for setting the color and density of volumetric fog effect.`
			`</constant>`
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-13 04:42:36 +08:00			`</constants>`
			`</class>`