godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-23 15:16:17 +00:00
Code Releases Wiki Activity

Merge pull request #48272 from Calinou/doc-standardmaterial3d-rim-unshaded

Browse Source 
Document that clearcoat/rim lighting is not visible on unshaded materials
This commit is contained in:
Rémi Verschelde
2021-04-29 13:36:40 +02:00
committed by GitHub
parent cab5064f20 126ea92a64
commit 28f56e2cbf
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/BaseMaterial3D.xml
View File

@@ -142,6 +142,7 @@
</member> </member>
<member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> <member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
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. 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.
[b]Note:[/b] Clearcoat rendering is not visible if the material's [member shading_mode] is [constant SHADING_MODE_UNSHADED].
</member> </member>
<member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss" default="0.5"> <member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss" default="0.5">
Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat. Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat.
@@ -304,6 +305,7 @@
</member> </member>
<member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> <member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
If [code]true[/code], rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. If [code]true[/code], rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object.
[b]Note:[/b] Rim lighting is not visible if the material's [member shading_mode] is [constant SHADING_MODE_UNSHADED].
</member> </member>
<member name="rim_texture" type="Texture2D" setter="set_texture" getter="get_texture"> <member name="rim_texture" type="Texture2D" setter="set_texture" getter="get_texture">
Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by [member rim]. Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by [member rim].