asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/SpatialMaterial.xml

669 lines
49 KiB
XML
Raw Normal View History

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" ?>
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
<class name="SpatialMaterial" inherits="Material" version="3.6" 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-12 22:42:36 +02:00
<brief_description>
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Default 3D rendering material.
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>
<description>
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details.
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>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:11:20 +01:00
<link>$DOCS_URL/tutorials/3d/spatial_material.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-12 22:42:36 +02:00
</tutorials>
<methods>
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<method name="get_feature" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
doc: Sync classref with current source Fix a few typos.
2020-01-28 10:58:48 +01:00
Returns [code]true[/code], if the specified [enum Feature] is enabled.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name="get_flag" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name="get_texture" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Texture" />
<argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Returns the [Texture] associated with the specified [enum TextureParam].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name="set_feature">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature" />
<argument index="1" name="enable" type="bool" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [SpatialMaterial]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name="set_flag">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags" />
<argument index="1" name="enable" type="bool" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
i18n: Sync classref translations with current 3.x codebase
2022-01-07 13:33:58 +01:00
If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name="set_texture">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam" />
<argument index="1" name="texture" type="Texture" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets the [Texture] to be used by the specified [enum TextureParam]. This function is called when setting members ending in [code]*_texture[/code].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</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: 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="albedo_color" type="Color" setter="set_albedo" getter="get_albedo" default="Color( 1, 1, 1, 1 )">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The material's base color.
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: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="albedo_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture to multiply by [member albedo_color]. Used for basic texturing of 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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy">
Document the expected format of anisotropy flowmaps in SpatialMaterial
2021-12-31 17:27:17 +01:00
The strength of the anisotropy effect. This is multiplied by [member anisotropy_flowmap]'s alpha channel if a texture is defined there and the texture contains an alpha channel.
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="anisotropy_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Document the expected format of anisotropy flowmaps in SpatialMaterial
2021-12-31 17:27:17 +01:00
If [code]true[/code], anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections.
[b]Note:[/b] Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken.
Improve documentation related to anisotropic filtering
2022-08-22 18:40:40 +02:00
[b]Note:[/b] Material anisotropy should not to be confused with anisotropic texture filtering. Anisotropic texture filtering can be enabled by selecting a texture in the FileSystem dock, going to the Import dock, checking the [b]Anisotropic[/b] checkbox then clicking [b]Reimport[/b]. The anisotropic filtering level can be changed by adjusting [member ProjectSettings.rendering/quality/filters/anisotropic_filter_level].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="anisotropy_flowmap" type="Texture" setter="set_texture" getter="get_texture">
Document the expected format of anisotropy flowmaps in SpatialMaterial
2021-12-31 17:27:17 +01:00
Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion.
If present, the texture's alpha channel will be used to multiply the strength of the [member anisotropy] effect. Fully opaque pixels will keep the anisotropy effect's original strength while fully transparent pixels will disable the anisotropy effect entirely. The flowmap texture's blue channel is ignored.
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="ao_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], ambient occlusion is enabled. Ambient occlusion darkens areas based on the [member ao_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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Amount that ambient occlusion affects lighting from lights. If [code]0[/code], ambient occlusion only affects ambient light. If [code]1[/code], ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], use [code]UV2[/code] coordinates to look up from the [member ao_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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="ao_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that defines the amount of ambient occlusion for a given point on the object.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="SpatialMaterial.TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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>
Implement async shader compilation plus caching for GL ES 3 Async. compilation via ubershader is currently available in the scene and particles shaders only. Bonus: - Use `#if defined()` syntax for not true conditionals, so they don't unnecessarily take a bit in the version flagset. - Remove unused `ENABLE_CLIP_ALPHA` from scene shader. - Remove unused `PARTICLES_COPY` from the particles shader. - Remove unused uniform related code. - Shader language/compiler: use ordered hash maps for deterministic code generation (needed for caching).
2021-09-26 21:31:17 +02:00
<member name="async_mode" type="int" setter="set_async_mode" getter="get_async_mode" enum="SpatialMaterial.AsyncMode" default="0">
If [member ProjectSettings.rendering/gles3/shaders/shader_compilation_mode] is [code]Synchronous[/code] (with or without cache), this determines how this material must behave in regards to asynchronous shader compilation.
[constant ASYNC_MODE_VISIBLE] is the default and the best for most cases.
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets the strength of the clearcoat effect. Setting to [code]0[/code] looks the same as disabling the clearcoat effect.
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="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Finish documenting CSG* and *probes
2020-01-23 07:12:52 +01:00
If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough.
Document that clearcoat/rim lighting is not visible on unshaded materials
2021-04-28 17:40:14 +02:00
[b]Note:[/b] Clearcoat rendering is not visible if the material has [member flags_unshaded] set to [code]true[/code].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="clearcoat_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the shader will read depth texture at multiple points along the view ray to determine occlusion and parrallax. This can be very performance demanding, but results in more realistic looking depth mapping.
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="depth_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled].
Document that SpatialMaterial doesn't support depth mapping + triplanar See #44322.
2020-12-12 17:10:48 +01:00
[b]Note:[/b] Depth mapping is not supported if triplanar mapping is used on the same material. The value of [member depth_enabled] will be ignored if [member uv1_triplanar] is enabled.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_flip_binormal" type="bool" setter="set_depth_deep_parallax_flip_binormal" getter="get_depth_deep_parallax_flip_binormal">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], direction of the binormal is flipped before using in the depth effect. This may be necessary if you have encoded your binormals in a way that is conflicting with the depth effect.
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_flip_tangent" type="bool" setter="set_depth_deep_parallax_flip_tangent" getter="get_depth_deep_parallax_flip_tangent">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], direction of the tangent is flipped before using in the depth effect. This may be necessary if you have encoded your tangents in a way that is conflicting with the depth effect.
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_max_layers" type="int" setter="set_depth_deep_parallax_max_layers" getter="get_depth_deep_parallax_max_layers">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Number of layers to use when using [member depth_deep_parallax] and the view direction is perpendicular to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Number of layers to use when using [member depth_deep_parallax] and the view direction is parallel to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_scale" type="float" setter="set_depth_scale" getter="get_depth_scale">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Scales the depth offset effect. A higher number will create a larger depth.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="depth_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to determine depth at a given pixel. Depth is always stored in the red channel.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="detail_albedo" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that specifies the color of the detail overlay.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="SpatialMaterial.BlendMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies how the [member detail_albedo] should blend with the current [code]ALBEDO[/code]. See [enum BlendMode] for options.
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="detail_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on [member detail_mask]. This can be used to add variation to objects, or to blend between two different albedo/normal textures.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="detail_mask" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to specify how the detail textures get blended with the base textures.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="detail_normal" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that specifies the per-pixel normal of the detail overlay.
Fix normal map description (cherry picked from commit d8560744883584f220a20d66879162c902726a27)
2022-01-09 21:03:33 +01:00
[b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies whether to use [code]UV[/code] or [code]UV2[/code] for the detail layer. See [enum DetailUV] for options.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance">
doc: Improve distance_fade documentation Changed the documentation of distance_fade_max_distance and min to be consistent with the behavior of the code as well as the user documentation. Also noted the behavior of swapping max_distance and min_distance (where max_distance < min_distance). Fixes #36051. Co-authored-by: Clay John <claynjohn@gmail.com> (cherry picked from commit 90d1eda90e3b16702c0c2f693af47e7fbaacdae9)
2020-02-10 08:12:49 +01:00
Distance at which the object appears fully opaque.
[b]Note:[/b] If [code]distance_fade_max_distance[/code] is less than [code]distance_fade_min_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
doc: Sync classref with current source [ci skip]
2017-09-23 10:59:35 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance">
doc: Improve distance_fade documentation Changed the documentation of distance_fade_max_distance and min to be consistent with the behavior of the code as well as the user documentation. Also noted the behavior of swapping max_distance and min_distance (where max_distance < min_distance). Fixes #36051. Co-authored-by: Clay John <claynjohn@gmail.com> (cherry picked from commit 90d1eda90e3b16702c0c2f693af47e7fbaacdae9)
2020-02-10 08:12:49 +01:00
Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible.
[b]Note:[/b] If [code]distance_fade_min_distance[/code] is greater than [code]distance_fade_max_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
doc: Sync classref with current source [ci skip]
2017-09-23 10:59:35 +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="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="SpatialMaterial.DistanceFadeMode" default="0">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies which type of fade to use. Can be any of the [enum DistanceFadeMode]s.
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission" type="Color" setter="set_emission" getter="get_emission">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The emitted light's color. See [member emission_enabled].
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="emission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a [GIProbe] or [BakedLightmap] is used and this object is used in baked lighting.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The emitted light's strength. See [member emission_enabled].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use [code]UV2[/code] to read from the [member emission_texture].
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="SpatialMaterial.EmissionOperator">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets how [member emission] interacts with [member emission_texture]. Can either add or multiply. See [enum EmissionOperator] for options.
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that specifies how much surface emits light at a given point.
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="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Forces a conversion of the [member albedo_texture] from sRGB space to linear space.
doc: Sync classref with current source
2017-12-07 08:23:08 +01:00
</member>
Backport Label3D node implementation and Sprite*3D material render priority.
2022-05-21 19:12:12 +02:00
<member name="flags_albedo_tex_msdf" type="bool" setter="set_flag" getter="get_flag" default="false">
Enables signed distance field rendering shader.
</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="flags_disable_ambient_light" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the object receives no ambient light.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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="flags_do_not_receive_shadows" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the object receives no shadow that would otherwise be cast onto it.
Sync classref with current source
2018-05-12 09:38:00 +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="flags_ensure_correct_normals" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the shader will compute extra operations to make sure the normal stays correct when using a non-uniform scale. Only enable if using non-uniform scaling.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the object is rendered at the same size regardless of distance.
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="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], depth testing is disabled and the object will be drawn in render order.
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="flags_transparent" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], transparency is enabled on the body. See also [member params_blend_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-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="flags_unshaded" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the object is unaffected by lighting.
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="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag" default="false">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
If [code]true[/code], render point size can be changed.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs (cherry picked from commit 788b3aa27ac01263b2e70190ace6551504e0c81e)
2021-10-05 14:24:34 +02:00
[b]Note:[/b] This is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size].
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="flags_use_shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR.
doc: Sync classref with current source
2019-05-28 18:08:13 +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="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag" default="false">
Improve documentation related to 3D material vertex lighting
2022-03-31 02:30:54 +02:00
If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices, especially for meshes with a lower polygon count. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled.
See also [member ProjectSettings.rendering/quality/shading/force_vertex_shading] which can globally enable vertex shading on all materials.
[b]Note:[/b] By default, vertex shading is enforced on mobile platforms by [member ProjectSettings.rendering/quality/shading/force_vertex_shading]'s [code]mobile[/code] override.
[b]Note:[/b] [member flags_vertex_lighting] has no effect if [member flags_unshaded] is [code]true[/code].
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="flags_world_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar].
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="metallic" type="float" setter="set_metallic" getter="get_metallic" default="0.0">
updated description of metallic in SpatialMaterial
2020-02-10 23:09:41 +01:00
A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between [code]0[/code] and [code]1[/code] should only be used for blending between metal and non-metal sections. To alter the amount of reflection use [member roughness].
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="metallic_specular" type="float" setter="set_specular" getter="get_specular" default="0.5">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs (cherry picked from commit 788b3aa27ac01263b2e70190ace6551504e0c81e)
2021-10-05 14:24:34 +02:00
[b]Note:[/b] Unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness].
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: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="metallic_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to specify metallic for an object. This is multiplied by [member metallic].
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: Sync classref with current source
2019-07-22 12:24:14 +02:00
<member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="SpatialMaterial.TextureChannel" default="0">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies the channel of the [member metallic_texture] in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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="normal_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], normal mapping is enabled.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The strength of the normal map's effect.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="normal_texture" type="Texture" setter="set_texture" getter="get_texture">
Document that tangents are required for normal mapping in SpatialMaterial
2021-10-01 17:31:13 +02:00
Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh].
[b]Note:[/b] The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with [SurfaceTool], you can use [method SurfaceTool.generate_normals] and [method SurfaceTool.generate_tangents] to automatically generate normals and tangents respectively.
Fix normal map description (cherry picked from commit d8560744883584f220a20d66879162c902726a27)
2022-01-09 21:03:33 +01:00
[b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="params_alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Threshold at which the alpha scissor will discard values.
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="params_billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when [member params_billboard_mode] is [constant BILLBOARD_ENABLED].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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="params_billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode" default="0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Controls how the object faces the camera. See [enum BillboardMode].
Document the BaseMaterial3D billboard mode not being suited for VR See #41567. (cherry picked from commit ecc47ce2358c4ed63a22c025885b7a9ba79db215)
2020-08-28 14:23:22 +02:00
[b]Note:[/b] Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See [url=https://github.com/godotengine/godot/issues/41567]GitHub issue #41567[/url] for details.
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="params_blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="SpatialMaterial.BlendMode" default="0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The material's blend mode.
[b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode].
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="params_cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="SpatialMaterial.CullMode" default="0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Which side of the object is not drawn when backfaces are rendered. See [enum CullMode].
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="params_depth_draw_mode" type="int" setter="set_depth_draw_mode" getter="get_depth_draw_mode" enum="SpatialMaterial.DepthDrawMode" default="0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member flags_transparent].
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="params_diffuse_mode" type="int" setter="set_diffuse_mode" getter="get_diffuse_mode" enum="SpatialMaterial.DiffuseMode" default="0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The algorithm used for diffuse light scattering. See [enum DiffuseMode].
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="params_grow" type="bool" setter="set_grow_enabled" getter="is_grow_enabled" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="params_grow_amount" type="float" setter="set_grow" getter="get_grow">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Grows object vertices in the direction of their normals.
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="params_line_width" type="float" setter="set_line_width" getter="get_line_width" default="1.0">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Currently unimplemented in Godot.
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="params_point_size" type="float" setter="set_point_size" getter="get_point_size" default="1.0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The point size in pixels. See [member flags_use_point_size].
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="params_specular_mode" type="int" setter="set_specular_mode" getter="get_specular_mode" enum="SpatialMaterial.SpecularMode" default="0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The method for rendering the specular blob. See [enum SpecularMode].
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="params_use_alpha_scissor" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the shader will discard all pixels that have an alpha value less than [member params_alpha_scissor_threshold].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_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-12 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade.
doc: Sync classref with current source [ci skip]
2017-09-23 10:59:35 +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="proximity_fade_enable" type="bool" setter="set_proximity_fade" getter="is_proximity_fade_enabled" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object.
doc: Sync classref with current source [ci skip]
2017-09-23 10:59:35 +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="refraction_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Allow clearcoat, anisotropy and refraction in SpatialMaterial in GLES2 These SpatialMaterial features work just fine in GLES2, but they were not exposed in the inspector when GLES2 was used.
2021-08-22 01:43:27 +02:00
If [code]true[/code], the refraction effect is enabled. Refraction distorts transparency based on light from behind the object. When using the GLES3 backend, the material's roughness value will affect the blurriness of the refraction. Higher roughness values will make the refraction look blurrier.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction">
Allow clearcoat, anisotropy and refraction in SpatialMaterial in GLES2 These SpatialMaterial features work just fine in GLES2, but they were not exposed in the inspector when GLES2 was used.
2021-08-22 01:43:27 +02:00
The strength of the refraction effect. Higher values result in a more distorted appearance for the refraction.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="refraction_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture that controls the strength of the refraction per-pixel. Multiplied by [member refraction_scale].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="SpatialMaterial.TextureChannel">
Allow clearcoat, anisotropy and refraction in SpatialMaterial in GLES2 These SpatialMaterial features work just fine in GLES2, but they were not exposed in the inspector when GLES2 was used.
2021-08-22 01:43:27 +02:00
Specifies the channel of the [member refraction_texture] in which the refraction information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="rim" type="float" setter="set_rim" getter="get_rim">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Sets the strength of the rim lighting effect.
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="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object.
Document that clearcoat/rim lighting is not visible on unshaded materials
2021-04-28 17:40:14 +02:00
[b]Note:[/b] Rim lighting is not visible if the material has [member flags_unshaded] set to [code]true[/code].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="rim_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by [member rim].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The amount of to blend light and albedo color when rendering rim effect. If [code]0[/code] the light color is used, while [code]1[/code] means albedo color is used. An intermediate value generally works best.
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="roughness" type="float" setter="set_roughness" getter="get_roughness" default="1.0">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Surface reflection. A value of [code]0[/code] represents a perfect mirror while a value of [code]1[/code] completely blurs the reflection. See also [member metallic].
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: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="roughness_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to control the roughness per-pixel. Multiplied by [member roughness].
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: Sync classref with current source
2019-07-22 12:24:14 +02:00
<member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="SpatialMaterial.TextureChannel" default="0">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The strength of the subsurface scattering effect.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="subsurf_scatter_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by [member subsurf_scatter_strength].
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="transmission" type="Color" setter="set_transmission" getter="get_transmission">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The color used by the transmission effect. Represents the light passing through an object.
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="transmission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the transmission effect is enabled.
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: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="transmission_texture" type="Texture" setter="set_texture" getter="get_texture">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture used to control the transmission effect per-pixel. Added to [member transmission].
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="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" default="Vector3( 0, 0, 0 )">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
How much to offset the [code]UV[/code] coordinates. This amount will be added to [code]UV[/code] in the vertex function. This can be used to offset a 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-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="uv1_scale" type="Vector3" setter="set_uv1_scale" getter="get_uv1_scale" default="Vector3( 1, 1, 1 )">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
How much to scale the [code]UV[/code] coordinates. This is multiplied by [code]UV[/code] in the vertex function.
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="uv1_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], instead of using [code]UV[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
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>
Hide triplanar sharpness when triplanar is disabled in SpatialMaterial The Triplanar Sharpness property has no effect when Triplanar is disabled.
2021-07-17 04:17:57 +02:00
<member name="uv1_triplanar_sharpness" type="float" setter="set_uv1_triplanar_blend_sharpness" getter="get_uv1_triplanar_blend_sharpness">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
A lower number blends the texture more softly while a higher number blends the texture more sharply.
Clamp SpatialMaterial triplanar sharpness to values that never look broken
2022-02-27 18:58:22 +01:00
[b]Note:[/b] [member uv1_triplanar_sharpness] is clamped between [code]0.0[/code] and [code]150.0[/code] (inclusive) as values outside that range can look broken depending on the mesh.
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="uv2_offset" type="Vector3" setter="set_uv2_offset" getter="get_uv2_offset" default="Vector3( 0, 0, 0 )">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
How much to offset the [code]UV2[/code] coordinates. This amount will be added to [code]UV2[/code] in the vertex function. This can be used to offset a 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-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="uv2_scale" type="Vector3" setter="set_uv2_scale" getter="get_uv2_scale" default="Vector3( 1, 1, 1 )">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
How much to scale the [code]UV2[/code] coordinates. This is multiplied by [code]UV2[/code] in the vertex function.
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="uv2_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
If [code]true[/code], instead of using [code]UV2[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
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>
Hide triplanar sharpness when triplanar is disabled in SpatialMaterial The Triplanar Sharpness property has no effect when Triplanar is disabled.
2021-07-17 04:17:57 +02:00
<member name="uv2_triplanar_sharpness" type="float" setter="set_uv2_triplanar_blend_sharpness" getter="get_uv2_triplanar_blend_sharpness">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
A lower number blends the texture more softly while a higher number blends the texture more sharply.
Clamp SpatialMaterial triplanar sharpness to values that never look broken
2022-02-27 18:58:22 +01:00
[b]Note:[/b] [member uv2_triplanar_sharpness] is clamped between [code]0.0[/code] and [code]150.0[/code] (inclusive) as values outside that range can look broken depending on the mesh.
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="vertex_color_is_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the model's vertex colors are processed as sRGB 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-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="vertex_color_use_as_albedo" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], the vertex color is used as albedo color.
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="TEXTURE_ALBEDO" value="0" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel color.
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="TEXTURE_METALLIC" value="1" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel metallic value.
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="TEXTURE_ROUGHNESS" value="2" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel roughness value.
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="TEXTURE_EMISSION" value="3" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel emission color.
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="TEXTURE_NORMAL" value="4" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel normal vector.
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="TEXTURE_RIM" value="5" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel rim value.
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="TEXTURE_CLEARCOAT" value="6" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel clearcoat value.
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="TEXTURE_FLOWMAP" value="7" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel flowmap direction for use with [member anisotropy].
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="TEXTURE_AMBIENT_OCCLUSION" value="8" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel ambient occlusion value.
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="TEXTURE_DEPTH" value="9" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel depth.
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="TEXTURE_SUBSURFACE_SCATTERING" value="10" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel subsurface scattering.
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="TEXTURE_TRANSMISSION" value="11" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel transmission color.
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="TEXTURE_REFRACTION" value="12" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel refraction strength.
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="TEXTURE_DETAIL_MASK" value="13" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel detail mask blending value.
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="TEXTURE_DETAIL_ALBEDO" value="14" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel detail color.
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="TEXTURE_DETAIL_NORMAL" value="15" enum="TextureParam">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Texture specifying per-pixel detail normal.
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="TEXTURE_MAX" value="16" enum="TextureParam">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum TextureParam] enum.
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="DETAIL_UV_1" value="0" enum="DetailUV">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use [code]UV[/code] with the detail 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="DETAIL_UV_2" value="1" enum="DetailUV">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use [code]UV2[/code] with the detail 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="FEATURE_TRANSPARENT" value="0" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member flags_transparent].
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="FEATURE_EMISSION" value="1" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member emission_enabled].
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="FEATURE_NORMAL_MAPPING" value="2" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member normal_enabled].
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="FEATURE_RIM" value="3" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member rim_enabled].
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="FEATURE_CLEARCOAT" value="4" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member clearcoat_enabled].
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="FEATURE_ANISOTROPY" value="5" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member anisotropy_enabled].
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="FEATURE_AMBIENT_OCCLUSION" value="6" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member ao_enabled].
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="FEATURE_DEPTH_MAPPING" value="7" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member depth_enabled].
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="FEATURE_SUBSURACE_SCATTERING" value="8" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member subsurf_scatter_enabled].
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="FEATURE_TRANSMISSION" value="9" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member transmission_enabled].
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="FEATURE_REFRACTION" value="10" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member refraction_enabled].
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="FEATURE_DETAIL" value="11" enum="Feature">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Constant for setting [member detail_enabled].
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="FEATURE_MAX" value="12" enum="Feature">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum Feature] enum.
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="BLEND_MODE_MIX" value="0" enum="BlendMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Default blend mode. The color of the object is blended over the background based on the object's alpha value.
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="BLEND_MODE_ADD" value="1" enum="BlendMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
The color of the object is added to the background.
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="BLEND_MODE_SUB" value="2" enum="BlendMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
The color of the object is subtracted from the background.
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="BLEND_MODE_MUL" value="3" enum="BlendMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
The color of the object is multiplied by the background.
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="DEPTH_DRAW_OPAQUE_ONLY" value="0" enum="DepthDrawMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Default depth draw mode. Depth is drawn only for opaque 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="DEPTH_DRAW_ALWAYS" value="1" enum="DepthDrawMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Depth draw is calculated for both opaque and transparent 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="DEPTH_DRAW_DISABLED" value="2" enum="DepthDrawMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
No depth draw.
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="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3" enum="DepthDrawMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn.
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="CULL_BACK" value="0" enum="CullMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Default cull mode. The back of the object is culled when not visible.
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="CULL_FRONT" value="1" enum="CullMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
The front of the object is culled when not visible.
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="CULL_DISABLED" value="2" enum="CullMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
No culling is performed.
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="FLAG_UNSHADED" value="0" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
No lighting is used on the object. Color comes directly from [code]ALBEDO[/code].
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="FLAG_USE_VERTEX_LIGHTING" value="1" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Lighting is calculated per-vertex rather than per-pixel. This can be used to increase the speed of the shader at the cost of quality.
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="FLAG_DISABLE_DEPTH_TEST" value="2" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
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="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Set [code]ALBEDO[/code] to the per-vertex color specified in the mesh.
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="FLAG_SRGB_VERTEX_COLOR" value="4" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer.
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="FLAG_USE_POINT_SIZE" value="5" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use [code]POINT_COORD[/code] instead of [code]UV[/code].
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="FLAG_FIXED_SIZE" value="6" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Object is scaled by depth so that it always appears the same size on screen.
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: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_BILLBOARD_KEEP_SCALE" value="7" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when [member params_billboard_mode] is [constant BILLBOARD_ENABLED].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="FLAG_UV1_USE_TRIPLANAR" value="8" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV[/code].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="FLAG_UV2_USE_TRIPLANAR" value="9" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV2[/code].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="FLAG_AO_ON_UV2" value="11" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use [code]UV2[/code] coordinates to look up from the [member ao_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-12 22:42:36 +02:00
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_EMISSION_ON_UV2" value="12" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use [code]UV2[/code] coordinates to look up from the [member emission_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-12 22:42:36 +02:00
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_USE_ALPHA_SCISSOR" value="13" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use alpha scissor. Set by [member params_use_alpha_scissor].
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: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_TRIPLANAR_USE_WORLD" value="10" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Use world coordinates in the triplanar texture lookup instead of local coordinates.
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="14" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Forces the shader to convert albedo from sRGB space to linear space.
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: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_DONT_RECEIVE_SHADOWS" value="15" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Disables receiving shadows from other 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-12 22:42:36 +02:00
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_DISABLE_AMBIENT_LIGHT" value="17" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Disables receiving ambient light.
doc: Sync classref with current source
2017-12-07 08:23:08 +01:00
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<constant name="FLAG_ENSURE_CORRECT_NORMALS" value="16" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Ensures that normals appear correct, even with non-uniform scaling.
Sync classref with current source
2018-05-12 09:38:00 +02:00
</constant>
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
<constant name="FLAG_USE_SHADOW_TO_OPACITY" value="18" enum="Flags">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Enables the shadow to opacity feature.
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
</constant>
Backport Label3D node implementation and Sprite*3D material render priority.
2022-05-21 19:12:12 +02:00
<constant name="FLAG_ALBEDO_TEXTURE_SDF" value="19" enum="Flags">
Enables signed distance field rendering shader.
</constant>
<constant name="FLAG_MAX" value="20" enum="Flags">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum Flags] enum.
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="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Default diffuse scattering algorithm.
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="DIFFUSE_LAMBERT" value="1" enum="DiffuseMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Diffuse scattering ignores roughness.
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="DIFFUSE_LAMBERT_WRAP" value="2" enum="DiffuseMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Extends Lambert to cover more than 90 degrees when roughness increases.
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="DIFFUSE_OREN_NAYAR" value="3" enum="DiffuseMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Attempts to use roughness to emulate microsurfacing.
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="DIFFUSE_TOON" value="4" enum="DiffuseMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Uses a hard cut for lighting, with smoothing affected by roughness.
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="SPECULAR_SCHLICK_GGX" value="0" enum="SpecularMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Default specular blob.
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="SPECULAR_BLINN" value="1" enum="SpecularMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Older specular algorithm, included for compatibility.
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="SPECULAR_PHONG" value="2" enum="SpecularMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Older specular algorithm, included for compatibility.
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="SPECULAR_TOON" value="3" enum="SpecularMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
Toon blob which changes size based on roughness.
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="SPECULAR_DISABLED" value="4" enum="SpecularMode">
[DOCS] SpatialMaterial descriptions
2018-10-07 02:39:24 +02:00
No specular blob.
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="BILLBOARD_DISABLED" value="0" enum="BillboardMode">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Billboard mode is disabled.
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="BILLBOARD_ENABLED" value="1" enum="BillboardMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The object's Z axis will always face the camera.
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="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The object's X axis will always face the camera.
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="BILLBOARD_PARTICLES" value="3" enum="BillboardMode">
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 11:14:14 +01:00
Used for particle systems when assigned to [Particles] and [CPUParticles] nodes. Enables [code]particles_anim_*[/code] properties.
The [member ParticlesMaterial.anim_speed] or [member CPUParticles.anim_speed] should also be set to a positive value for the animation to play.
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="TEXTURE_CHANNEL_RED" value="0" enum="TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Used to read from the red channel of a 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_CHANNEL_GREEN" value="1" enum="TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Used to read from the green channel of a 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_CHANNEL_BLUE" value="2" enum="TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Used to read from the blue channel of a 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_CHANNEL_ALPHA" value="3" enum="TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Used to read from the alpha channel of a 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-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4" enum="TextureChannel">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Currently unused.
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="EMISSION_OP_ADD" value="0" enum="EmissionOperator">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Adds the emission color to the color from the emission texture.
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Multiplies the emission color by the color from the emission texture.
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
</constant>
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
<constant name="DISTANCE_FADE_DISABLED" value="0" enum="DistanceFadeMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Do not use distance fade.
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</constant>
<constant name="DISTANCE_FADE_PIXEL_ALPHA" value="1" enum="DistanceFadeMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel.
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</constant>
<constant name="DISTANCE_FADE_PIXEL_DITHER" value="2" enum="DistanceFadeMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Smoothly fades the object out based on each pixel's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</constant>
<constant name="DISTANCE_FADE_OBJECT_DITHER" value="3" enum="DistanceFadeMode">
Finish up docs for materials
2020-01-21 01:28:03 +01:00
Smoothly fades the object out based on the object's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</constant>
Implement async shader compilation plus caching for GL ES 3 Async. compilation via ubershader is currently available in the scene and particles shaders only. Bonus: - Use `#if defined()` syntax for not true conditionals, so they don't unnecessarily take a bit in the version flagset. - Remove unused `ENABLE_CLIP_ALPHA` from scene shader. - Remove unused `PARTICLES_COPY` from the particles shader. - Remove unused uniform related code. - Shader language/compiler: use ordered hash maps for deterministic code generation (needed for caching).
2021-09-26 21:31:17 +02:00
<constant name="ASYNC_MODE_VISIBLE" value="0" enum="AsyncMode">
The real conditioned shader needed on each situation will be sent for background compilation. In the meantime, a very complex shader that adapts to every situation will be used ("ubershader"). This ubershader is much slower to render, but will keep the game running without stalling to compile. Once shader compilation is done, the ubershader is replaced by the traditional optimized shader.
</constant>
<constant name="ASYNC_MODE_HIDDEN" value="1" enum="AsyncMode">
Anything with this material applied won't be rendered while this material's shader is being compiled.
This is useful for optimization, in cases where the visuals won't suffer from having certain non-essential elements missing during the short time their shaders are being compiled.
</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-12 22:42:36 +02:00
</constants>
</class>
Reference in a new issue Copy permalink