Skip to content

rename SetShaderConstant to SetShaderParameterValue #2698

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

Open
wants to merge 1 commit into
base: development
Choose a base branch
from

Conversation

kh-huawei
Copy link

Change summary

With the material system refactoring in development, the functions SetShaderConstant were renamed to SetShaderParameterValue

Submission Checklist:

  • Descriptive active voice - Do descriptive sentences have a clear subject and action verb?
  • Answer the question at hand - Does the documentation answer a what, why, how, or where type of question?
  • Consistency - Does the content consistently follow the Style Guide?
  • Help the user - Does the documentation show the user something meaningful?

@kh-huawei kh-huawei requested a review from a team as a code owner July 16, 2025 09:54
* **SetShaderConstant_Matrix4x4**(`string`, `Matrix4x4`)
### SetShaderParameterValue\_

The functions **SetShaderConstant_<type>** were renamed to **SetShaderParameterValue_<type>** to more accurately reflect the underlying implementation. For backwards compatability the **SetShaderConstant_<type>** are still available, but considered deprecated.
Copy link
Contributor

Choose a reason for hiding this comment

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

Your <type> things are being rendered as markup, instead of displaying.

Suggested change
The functions **SetShaderConstant_<type>** were renamed to **SetShaderParameterValue_<type>** to more accurately reflect the underlying implementation. For backwards compatability the **SetShaderConstant_<type>** are still available, but considered deprecated.
The functions **SetShaderConstant_\<type\>** were renamed to **SetShaderParameterValue_\<type\>** to more accurately reflect the underlying implementation. For backwards compatibility the **SetShaderConstant_\<type\>** are still available, but considered deprecated.

Alternatively, just omit the <type> part, making it consistent with the rest of the text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants