External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-10-04 01:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

add a note to clarify up vector restriction for glm_lookat and glm_look

Browse Source
This commit is contained in:
Recep Aslantas
2018-05-29 11:30:38 +03:00
parent 059bdfdd4b
commit af812e86eb
2 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/cam.rst
View File

@@ -167,11 +167,13 @@ Functions documentation
| set up view matrix | set up view matrix
**NOTE:** The UP vector must not be parallel to the line of sight from the eye point to the reference point.
Parameters: Parameters:
| *[in]* **eye** eye vector | *[in]* **eye** eye vector
| *[in]* **center** center vector | *[in]* **center** center vector
| *[in]* **up** up vector | *[in]* **up** up vector
| *[out]* **dest** result matrix | *[out]* **dest** result matrix
.. c:function:: void glm_look(vec3 eye, vec3 dir, vec3 up, mat4 dest) .. c:function:: void glm_look(vec3 eye, vec3 dir, vec3 up, mat4 dest)
@@ -181,6 +183,8 @@ Functions documentation
target self then this might be useful. Because you need to get target target self then this might be useful. Because you need to get target
from direction. from direction.
**NOTE:** The UP vector must not be parallel to the line of sight from the eye point to the reference point.
Parameters: Parameters:
| *[in]* **eye** eye vector | *[in]* **eye** eye vector
| *[in]* **center** direction vector | *[in]* **center** direction vector

6
include/cglm/cam.h
View File

@@ -321,6 +321,9 @@ glm_perspective_resize(float aspect,
/*! /*!
* @brief set up view matrix * @brief set up view matrix
* *
* NOTE: The UP vector must not be parallel to the line of sight from
* the eye point to the reference point
*
* @param[in] eye eye vector * @param[in] eye eye vector
* @param[in] center center vector * @param[in] center center vector
* @param[in] up up vector * @param[in] up up vector
@@ -364,6 +367,9 @@ glm_lookat(vec3 eye,
* convenient wrapper for lookat: if you only have direction not target self * convenient wrapper for lookat: if you only have direction not target self
* then this might be useful. Because you need to get target from direction. * then this might be useful. Because you need to get target from direction.
* *
* NOTE: The UP vector must not be parallel to the line of sight from
* the eye point to the reference point
*
* @param[in] eye eye vector * @param[in] eye eye vector
* @param[in] dir direction vector * @param[in] dir direction vector
* @param[in] up up vector * @param[in] up up vector