isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-25 04:22:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: make cogl.h matrix stack documentation consistent

Browse Source 
This updates the cogl.h matrix stack documentation consistent with the
corresponding documentation in cogl-framebuffer.h for the framebuffer
matrix stack methods.

Reviewed-by: Neil Roberts <neil@linux.intel.com>
This commit is contained in:
Robert Bragg 2011-11-20 18:56:44 +00:00
parent ccde191191
commit a81458f5b9
1 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
cogl/cogl.h
View File

@ -367,13 +367,18 @@ cogl_get_bitmasks (int *red,
/** /**
* cogl_perspective: * cogl_perspective:
* @fovy: Vertical of view angle in degrees. * @fovy: Vertical field of view angle in degrees.
* @aspect: Aspect ratio of diesplay * @aspect: The (width over height) aspect ratio for display
* @z_near: Nearest visible point * @z_near: The distance to the near clipping plane (Must be positive)
* @z_far: Furthest visible point along the z-axis * @z_far: The distance to the far clipping plane (Must be positive)
* *
* Replaces the current projection matrix with a perspective matrix * Replaces the current projection matrix with a perspective matrix
* based on the provided values. * based on the provided values.
*
* <note>You should be careful not to have to great a @z_far / @z_near
* ratio since that will reduce the effectiveness of depth testing
* since there wont be enough precision to identify the depth of
* objects near to each other.</note>
*/ */
void void
cogl_perspective (float fovy, cogl_perspective (float fovy,
@ -383,15 +388,20 @@ cogl_perspective (float fovy,
/** /**
* cogl_frustum: * cogl_frustum:
* @left: Left clipping plane * @left: X position of the left clipping plane where it
* @right: Right clipping plane * intersects the near clipping plane
* @bottom: Bottom clipping plane * @right: X position of the right clipping plane where it
* @top: Top clipping plane * intersects the near clipping plane
* @z_near: Nearest visible point * @bottom: Y position of the bottom clipping plane where it
* @z_far: Furthest visible point along the z-axis * intersects the near clipping plane
* @top: Y position of the top clipping plane where it intersects
* the near clipping plane
* @z_near: The distance to the near clipping plane (Must be positive)
* @z_far: The distance to the far clipping plane (Must be positive)
* *
* Replaces the current projection matrix with a perspective matrix * Replaces the current projection matrix with a perspective matrix
* for the given viewing frustum. * for a given viewing frustum defined by 4 side clip planes that
* all cross through the origin and 2 near and far clip planes.
* *
* Since: 0.8.2 * Since: 0.8.2
*/ */