summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/cameras.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
committerTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
commit8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch)
tree12cdbb1c1b9a48f533ab36980602785be1e1deeb /libdimension/dimension/cameras.h
parent20a55aa78050d94b187d4edfaac91ea00efea505 (diff)
downloaddimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz
Document libdimension with Doxygen.
Diffstat (limited to 'libdimension/dimension/cameras.h')
-rw-r--r--libdimension/dimension/cameras.h19
1 files changed, 10 insertions, 9 deletions
diff --git a/libdimension/dimension/cameras.h b/libdimension/dimension/cameras.h
index 7f4d549..077aebc 100644
--- a/libdimension/dimension/cameras.h
+++ b/libdimension/dimension/cameras.h
@@ -18,20 +18,21 @@
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
-/*
- * Types of cameras.
+/**
+ * @file
+ * Pre-defined camera types.
*/
#ifndef DIMENSION_CAMERAS_H
#define DIMENSION_CAMERAS_H
-/* A perspective camera, at the origin, looking at (0, 0, 1). The feild of view
- is the section of the plane z = 1 from (-0.5, -0.5) to (0.5, 0.5). Rays are
- transformed by the camera's transformation matrix. */
+/**
+ * A perspective camera. The camera is located at the origin, looking at
+ * (0, 0, 1). The feild of view is the section of the plane z = 1 from
+ * (-0.5, -0.5) to (0.5, 0.5). Rays are transformed by the camera's
+ * transformation matrix.
+ * @return A perspective camera.
+ */
dmnsn_camera *dmnsn_new_perspective_camera(void);
-/* Get or set the transformation matrix */
-dmnsn_matrix dmnsn_get_perspective_camera_trans(const dmnsn_camera *camera);
-void dmnsn_set_perspective_camera_trans(dmnsn_camera *camera, dmnsn_matrix T);
-
#endif /* DIMENSION_CAMERAS_H */