Improve documentation for the Mat4
projection functions
#570
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.
Like I mentioned in #569, this PR adds more detailed documentation to the
Mat4::perspective_*
andMat4::orthographic_*
family of functions, as well as addingMat4::perspective_rh_vk
andMat4::orthographic_rh_vk
.I initially wrote a very detailed doc explaining what world-view coordinates get mapped to what normalized-device-coordinates, but they look very out-of-place and are probably too much. Instead, I added a small subtext among the lines of
Useful to map the standard right-handed coordinate system into what OpenGL expects.
.I haven't implemented the
*_rh_vk
functions or their tests yet. I would like to receive confirmation that this PR is ok before doing so.