Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify where INSTANCE_CUSTOM can be accessed #102338

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/classes/MultiMesh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
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].
This custom instance data has to be manually accessed in your custom shader using [code]INSTANCE_CUSTOM[/code] in the [code]vertex()[/code] function, or in the [code]fragment()[/code] function using a varying.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This custom instance data has to be manually accessed in your custom shader using [code]INSTANCE_CUSTOM[/code] in the [code]vertex()[/code] function, or in the [code]fragment()[/code] function using a varying.
This custom instance data has to be manually accessed in your custom shader using [code]INSTANCE_CUSTOM[/code] in the [code]vertex()[/code] function.

Alternate, if we want to assume that users already know their way around shaders and want to avoid tutorializing in the class reference.

</description>
</method>
<method name="set_instance_transform">
Expand Down