Clarify where INSTANCE_CUSTOM can be accessed
#102338
Open
+1
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tetrapod00
commented
Feb 2, 2025
| @@ -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. | |||
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes godotengine/godot-docs#10604.
INSTANCE_CUSTOMis only available in thevertex()function. While this is sufficiently documented by the fact that it is listed in the vertex built-in table and not the fragment built-in table, this is easy to miss (see also #57584).