[DOCS] add typedef ShaderDefinition and document Shader.definition#8088
Open
aidinabedi wants to merge 1 commit intoplaycanvas:mainfrom
Open
[DOCS] add typedef ShaderDefinition and document Shader.definition#8088aidinabedi wants to merge 1 commit intoplaycanvas:mainfrom
aidinabedi wants to merge 1 commit intoplaycanvas:mainfrom
Conversation
mvaligursky
reviewed
Nov 4, 2025
Contributor
mvaligursky
left a comment
There was a problem hiding this comment.
It'm not sure about exposing definition as the public API. Two concerns:
- It seems the user can modify it's content, but in reality it cannot.
- The content of it is not the same as what the user passed in. As an example we process shaders and replace the originally supplied shaders. And so we cannot provide guarantees as of what it contains.
What's the reason you need definition exposed?
This file contains hidden or 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
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.
Description
This PR takes the type info from the parameter
definitioninShader's constructor, and makes it into its own typedef calledShaderDefinition, so that it can be used to also document the propertyShader.definitionChecklist