Skip to content

Commit

Permalink
Mention Multimesh custom data will be compressed to half in Compatibi…
Browse files Browse the repository at this point in the history
…lity
  • Loading branch information
jsjtxietian committed Aug 5, 2024
1 parent 3978628 commit 7dab1a8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/classes/MultiMesh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
<param index="1" name="color" type="Color" />
<description>
Sets the color of a specific instance by [i]multiplying[/i] the mesh's existing vertex colors. This allows for different color tinting per instance.
[b]Note:[/b] Each component is stored in 32 bits in the Forward+ and Mobile rendering methods, but is packed into 16 bits in the Compatibility rendering method.
For the color to take effect, ensure that [member use_colors] is [code]true[/code] on the [MultiMesh] and [member BaseMaterial3D.vertex_color_use_as_albedo] is [code]true[/code] on the material. If you intend to set an absolute color instead of tinting, make sure the material's albedo color is set to pure white ([code]Color(1, 1, 1)[/code]).
</description>
</method>
Expand All @@ -66,6 +67,7 @@
<param index="1" name="custom_data" type="Color" />
<description>
Sets custom data for a specific instance. [param custom_data] is a [Color] type only to contain 4 floating-point numbers.
[b]Note:[/b] Each number is stored in 32 bits in the Forward+ and Mobile rendering methods, but is packed into 16 bits in the Compatibility rendering method.
For the custom data to be used, ensure that [member use_custom_data] is [code]true[/code].
This custom instance data has to be manually accessed in your custom shader using [code]INSTANCE_CUSTOM[/code].
</description>
Expand Down

0 comments on commit 7dab1a8

Please sign in to comment.