mosra / magnum-integration

Integration libraries for the Magnum C++11 graphics engine
https://magnum.graphics/
Other
99 stars 44 forks source link

Add usage hints to vector-math integrations. #66

Closed JacksonCampolattaro closed 4 years ago

JacksonCampolattaro commented 4 years ago

This PR request adds short explanations of the functionality included in GlmIntegration and EigenIntegration. This should make it more obvious that both allow for casting to and from Magnum's native vector types. It should also make it more clear which headers must be included to take advantage of this functionality.

Short examples of the syntax are adapted from the blog post that explained the integration features when they were first introduced.

codecov-io commented 4 years ago

Codecov Report

Merging #66 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #66   +/-   ##
======================================
  Coverage    74.5%   74.5%           
======================================
  Files          21      21           
  Lines         914     914           
======================================
  Hits          681     681           
  Misses        233     233

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 8ab81bf...d0fdcb1. Read the comment docs.

mosra commented 4 years ago

Thank you! :) Merged as a4e3263754b5b2eadb35834b529ceced3767abe7, I just converted the code snippets to be checked for compile errors (which uncovered an accidentally reversed order of arguments in rotation(), yay!).