[SYCL][Doc] Clarify that uniform is immutable #4246
Merged
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.
We received feedback from the oneAPI TAB that it was not immediately
obvious that the uniform class is immutable. The changes here are an
attempt to clarify this:
The implicit conversion operator returns "const T", reflecting that
the user is not getting a reference to the underlying data.
The assignment operator is deleted, preventing the user from
accidentally assigning one uniform object to another.
Other operators that users might accidentally call on a uniform
of a fundamental type (e.g. += on a uniform) are explicitly
deleted; the intent here is to give a simplified error message (rather
than a complex C++ diagnostic) that signals the operator is
deliberately not supported (rather than accidentally missing or
unimplemented).
Signed-off-by: John Pennycook [email protected]