diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-02-13 17:23:19 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-02-13 17:23:19 +0100 |
| commit | cc623af6cb4234e7e454e71a665ae3000f806019 (patch) | |
| tree | f7e07c4ba218790025dd8936c0e2adb2865a7412 /doc/classes | |
| parent | f5cfc7f203cee05405d0ffa7142beb9fec08084e (diff) | |
| parent | 8ca47c981d0d737db24b91c96899f4831147c931 (diff) | |
| download | redot-engine-cc623af6cb4234e7e454e71a665ae3000f806019.tar.gz | |
Merge pull request #86872 from Mickeon/documentation-sprite-3d-notes
Add a few notes to Sprite3D's documentation
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/SpriteBase3D.xml | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 601340ca91..4488351212 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -76,7 +76,8 @@ If [code]true[/code], texture is flipped vertically. </member> <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)"> - A color value used to [i]multiply[/i] the texture's colors. Can be used for mood-coloring or to simulate the color of light. + A color value used to [i]multiply[/i] the texture's colors. Can be used for mood-coloring or to simulate the color of ambient light. + [b]Note:[/b] Unlike [member CanvasItem.modulate] for 2D, colors with values above [code]1.0[/code] (overbright) are not supported. [b]Note:[/b] If a [member GeometryInstance3D.material_override] is defined on the [SpriteBase3D], the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in [member modulate] will be ignored. For a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] must be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. </member> <member name="no_depth_test" type="bool" setter="set_draw_flag" getter="get_draw_flag" default="false"> @@ -98,6 +99,7 @@ </member> <member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="BaseMaterial3D.TextureFilter" default="3"> Filter flags for the texture. See [enum BaseMaterial3D.TextureFilter] for options. + [b]Note:[/b] Linear filtering may cause artifacts around the edges, which are especially noticeable on opaque textures. To prevent this, use textures with transparent or identical colors around the edges. </member> <member name="transparent" type="bool" setter="set_draw_flag" getter="get_draw_flag" default="true"> If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible. |