Material: document disabling depth test disables depth write caveat. #27000
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
When setting the `depthTest` flag of a material to false, this will also implicitly disable the depth write, because `glDisable(GL_DEPTH_TEST)` is called internally. See: https://www.khronos.org/opengl/wiki/Depth_Test > When depth testing is disabled, writes to the depth buffer are also disabled. While the behavior makes sense I think (`depthFunc` can be used to achieve the desired behavior), it caught me off guard, so I thought it would make sense to document it.
This was referenced Oct 22, 2023
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.
When setting the
depthTestflag of a material to false, this will also implicitly disable the depth write, becauseglDisable(GL_DEPTH_TEST)is called internally.See: https://www.khronos.org/opengl/wiki/Depth_Test
While the behavior makes sense I think (after all
depthFunccan be used to achieve the desired behavior), it caught me off guard, so I thought it would make sense to document it.