summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-11-15 00:48:53 -0500
committerTavian Barnes <tavianator@gmail.com>2010-11-15 00:48:53 -0500
commit1256cab54b5248b9885196f474fbb50304a0e45a (patch)
tree2af2a8f4e552b04f38ee6240f7494eae1d87c61f /libdimension/dimension
parent8fe33a340b8979a73fa84f201c15519a9b5d0266 (diff)
downloaddimension-1256cab54b5248b9885196f474fbb50304a0e45a.tar.xz
End sentences with periods.
Diffstat (limited to 'libdimension/dimension')
-rw-r--r--libdimension/dimension/array.h10
-rw-r--r--libdimension/dimension/camera.h2
-rw-r--r--libdimension/dimension/canvas.h12
-rw-r--r--libdimension/dimension/color.h34
-rw-r--r--libdimension/dimension/error.h8
-rw-r--r--libdimension/dimension/geometry.h30
-rw-r--r--libdimension/dimension/interior.h2
-rw-r--r--libdimension/dimension/light.h4
-rw-r--r--libdimension/dimension/list.h18
-rw-r--r--libdimension/dimension/object.h23
-rw-r--r--libdimension/dimension/pattern.h6
-rw-r--r--libdimension/dimension/progress.h2
-rw-r--r--libdimension/dimension/scene.h2
-rw-r--r--libdimension/dimension/texture.h6
14 files changed, 81 insertions, 78 deletions
diff --git a/libdimension/dimension/array.h b/libdimension/dimension/array.h
index 514e13e..09746dd 100644
--- a/libdimension/dimension/array.h
+++ b/libdimension/dimension/array.h
@@ -29,12 +29,12 @@
#include <stddef.h> /* For size_t */
#include <string.h> /* For memcpy */
-/** Dynamic array type */
+/** Dynamic array type. */
typedef struct dmnsn_array {
- void *ptr; /**< @internal The actual memory */
- size_t obj_size; /**< @internal The size of each object */
- size_t length; /**< @internal The current size of the array */
- size_t capacity; /**< @internal The size of the allocated space */
+ void *ptr; /**< @internal The actual memory. */
+ size_t obj_size; /**< @internal The size of each object. */
+ size_t length; /**< @internal The current size of the array. */
+ size_t capacity; /**< @internal The size of the allocated space. */
} dmnsn_array;
/**
diff --git a/libdimension/dimension/camera.h b/libdimension/dimension/camera.h
index e63cd80..11235f7 100644
--- a/libdimension/dimension/camera.h
+++ b/libdimension/dimension/camera.h
@@ -47,7 +47,7 @@ struct dmnsn_camera {
dmnsn_matrix trans; /**< Transformation matrix. */
- /** Generic pointer for camera info */
+ /** Generic pointer for camera info. */
void *ptr;
};
diff --git a/libdimension/dimension/canvas.h b/libdimension/dimension/canvas.h
index bc98e71..722f546 100644
--- a/libdimension/dimension/canvas.h
+++ b/libdimension/dimension/canvas.h
@@ -30,10 +30,10 @@
/** A canvas, or image. */
typedef struct {
- size_t width; /**< Canvas width */
- size_t height; /**< Canvas height */
+ size_t width; /**< Canvas width. */
+ size_t height; /**< Canvas height. */
- /** An array of <tt>dmnsn_canvas_optimizer</tt>s */
+ /** An array of <tt>dmnsn_canvas_optimizer</tt>s. */
dmnsn_array *optimizers;
/**
@@ -58,10 +58,10 @@ typedef void dmnsn_canvas_optimizer_fn(const dmnsn_canvas *canvas,
dmnsn_canvas_optimizer optimizer,
size_t x, size_t y);
-/** Canvas optimizer */
+/** Canvas optimizer. */
struct dmnsn_canvas_optimizer {
- dmnsn_canvas_optimizer_fn *optimizer_fn; /**< Optimizer callback */
- dmnsn_free_fn *free_fn; /**< Destructor callback */
+ dmnsn_canvas_optimizer_fn *optimizer_fn; /**< Optimizer callback. */
+ dmnsn_free_fn *free_fn; /**< Destructor callback. */
void *ptr; /**< Generic pointer. */
};
diff --git a/libdimension/dimension/color.h b/libdimension/dimension/color.h
index 393778d..26ab4bb 100644
--- a/libdimension/dimension/color.h
+++ b/libdimension/dimension/color.h
@@ -57,8 +57,8 @@ typedef struct {
/** CIE xyY color. */
typedef struct {
- double x; /**< x chromaticity coordinate (in [0, 1]) */
- double y; /**< y chromaticity coordinate (in [0, 1]) */
+ double x; /**< x chromaticity coordinate (in [0, 1]). */
+ double y; /**< y chromaticity coordinate (in [0, 1]). */
double Y; /**< Luminance, unbounded >= 0; 1 is diffuse white. */
} dmnsn_CIE_xyY;
@@ -71,7 +71,7 @@ typedef struct {
/** CIE 1976 (L*, u*, v*) color. */
typedef struct {
- double L; /**< Luminance (same L* as CIE L*, a*, b*) */
+ double L; /**< Luminance (same L* as CIE L*, a*, b*). */
double u; /**< u* coordinate. */
double v; /**< v* coordinate. */
} dmnsn_CIE_Luv;
@@ -91,40 +91,40 @@ extern const dmnsn_color dmnsn_cyan; /**< Cyan. */
CIE XYZ */
extern const dmnsn_CIE_XYZ dmnsn_whitepoint;
-/** Is this color black? */
+/** Is this color black?. */
bool dmnsn_color_is_black(dmnsn_color color);
/* Color conversions */
-/** Convert an sRGB color to a Dimension color */
+/** Convert an sRGB color to a Dimension color. */
dmnsn_color dmnsn_color_from_sRGB(dmnsn_sRGB sRGB);
-/** Convert a CIE XYZ color to a Dimension color */
+/** Convert a CIE XYZ color to a Dimension color. */
dmnsn_color dmnsn_color_from_XYZ(dmnsn_CIE_XYZ XYZ);
-/** Convert a CIE xyY color to a Dimension color */
+/** Convert a CIE xyY color to a Dimension color. */
dmnsn_color dmnsn_color_from_xyY(dmnsn_CIE_xyY xyY);
-/** Convert a CIE L*, a*, b* color to a Dimension color */
+/** Convert a CIE L*, a*, b* color to a Dimension color. */
dmnsn_color dmnsn_color_from_Lab(dmnsn_CIE_Lab Lab, dmnsn_CIE_XYZ white);
-/** Convert a CIE L*, u*, v* color to a Dimension color */
+/** Convert a CIE L*, u*, v* color to a Dimension color. */
dmnsn_color dmnsn_color_from_Luv(dmnsn_CIE_Luv Luv, dmnsn_CIE_XYZ white);
-/** Convert a Dimension color to sRGB */
+/** Convert a Dimension color to sRGB. */
dmnsn_sRGB dmnsn_sRGB_from_color(dmnsn_color color);
-/** Convert a Dimension color to CIE XYZ */
+/** Convert a Dimension color to CIE XYZ. */
dmnsn_CIE_XYZ dmnsn_XYZ_from_color(dmnsn_color color);
-/** Convert a Dimension color to CIE xyY */
+/** Convert a Dimension color to CIE xyY. */
dmnsn_CIE_xyY dmnsn_xyY_from_color(dmnsn_color color);
-/** Convert a Dimension color to CIE L*, a*, b* */
+/** Convert a Dimension color to CIE L*, a*, b*. */
dmnsn_CIE_Lab dmnsn_Lab_from_color(dmnsn_color color, dmnsn_CIE_XYZ white);
-/** Convert a Dimension color to CIE L*, u*, v* */
+/** Convert a Dimension color to CIE L*, u*, v*. */
dmnsn_CIE_Luv dmnsn_Luv_from_color(dmnsn_color color, dmnsn_CIE_XYZ white);
/* Perceptual color manipulation */
-/** Add two colors together */
+/** Add two colors together. */
dmnsn_color dmnsn_color_add(dmnsn_color color1, dmnsn_color color2);
-/** Multiply a color's intensity by \p n */
+/** Multiply a color's intensity by \p n. */
dmnsn_color dmnsn_color_mul(double n, dmnsn_color color);
-/** Return the color at \p n on a gradient from \p c1 at 0 to \p c2 at 1 */
+/** Return the color at \p n on a gradient from \p c1 at 0 to \p c2 at 1. */
dmnsn_color dmnsn_color_gradient(dmnsn_color c1, dmnsn_color c2, double n);
/** Filter \p color through \p filter. */
dmnsn_color dmnsn_color_filter(dmnsn_color color, dmnsn_color filter);
diff --git a/libdimension/dimension/error.h b/libdimension/dimension/error.h
index 8482266..fd78115 100644
--- a/libdimension/dimension/error.h
+++ b/libdimension/dimension/error.h
@@ -29,11 +29,11 @@
#ifndef DIMENSION_ERROR_H
#define DIMENSION_ERROR_H
-/** Error severity codes */
+/** Error severity codes. */
typedef enum dmnsn_severity {
- DMNSN_SEVERITY_LOW, /**< Only die on low resilience */
- DMNSN_SEVERITY_MEDIUM, /**< Die on low or medium resilience */
- DMNSN_SEVERITY_HIGH /**< Always die */
+ DMNSN_SEVERITY_LOW, /**< Only die on low resilience. */
+ DMNSN_SEVERITY_MEDIUM, /**< Die on low or medium resilience. */
+ DMNSN_SEVERITY_HIGH /**< Always die. */
} dmnsn_severity;
/**
diff --git a/libdimension/dimension/geometry.h b/libdimension/dimension/geometry.h
index a62fb75..831f48c 100644
--- a/libdimension/dimension/geometry.h
+++ b/libdimension/dimension/geometry.h
@@ -73,8 +73,8 @@ typedef struct dmnsn_line {
/** An axis-aligned bounding box (AABB). */
typedef struct dmnsn_bounding_box {
- dmnsn_vector min; /**< The coordinate-wise minimum extent of the box */
- dmnsn_vector max; /**< The coordinate-wise maximum extent of the box */
+ dmnsn_vector min; /**< The coordinate-wise minimum extent of the box. */
+ dmnsn_vector max; /**< The coordinate-wise maximum extent of the box. */
} dmnsn_bounding_box;
/** A standard format string for bounding boxes. */
@@ -85,10 +85,10 @@ typedef struct dmnsn_bounding_box {
/* Constants */
-/** The smallest value considered non-zero by some numerical algorithms */
+/** The smallest value considered non-zero by some numerical algorithms. */
#define dmnsn_epsilon 1.0e-10
-/** The zero vector */
+/** The zero vector. */
static const dmnsn_vector dmnsn_zero = { 0.0, 0.0, 0.0 };
/** The x vector. */
static const dmnsn_vector dmnsn_x = { 1.0, 0.0, 0.0 };
@@ -113,14 +113,14 @@ dmnsn_max(double a, double b)
return a > b ? a : b;
}
-/** Convert degrees to radians */
+/** Convert degrees to radians. */
DMNSN_INLINE double
dmnsn_radians(double degrees)
{
return degrees*atan(1.0)/45.0;
}
-/** Convert radians to degrees */
+/** Convert radians to degrees. */
DMNSN_INLINE double
dmnsn_degrees(double radians)
{
@@ -137,7 +137,7 @@ dmnsn_signbit(double n)
/* Shorthand for vector/matrix construction */
-/** Construct a new vector */
+/** Construct a new vector. */
DMNSN_INLINE dmnsn_vector
dmnsn_new_vector(double x, double y, double z)
{
@@ -145,7 +145,7 @@ dmnsn_new_vector(double x, double y, double z)
return v;
}
-/** Construct a new matrix */
+/** Construct a new matrix. */
DMNSN_INLINE dmnsn_matrix
dmnsn_new_matrix(double a0, double a1, double a2, double a3,
double b0, double b1, double b2, double b3,
@@ -159,7 +159,7 @@ dmnsn_new_matrix(double a0, double a1, double a2, double a3,
return m;
}
-/** Return the identity matrix */
+/** Return the identity matrix. */
dmnsn_matrix dmnsn_identity_matrix(void);
/**
@@ -254,7 +254,7 @@ dmnsn_vector_element(dmnsn_vector n, int elem)
/* Vector and matrix arithmetic */
-/** Negate a vector */
+/** Negate a vector. */
DMNSN_INLINE dmnsn_vector
dmnsn_vector_negate(dmnsn_vector rhs)
{
@@ -263,7 +263,7 @@ dmnsn_vector_negate(dmnsn_vector rhs)
return v;
}
-/** Add two vectors */
+/** Add two vectors. */
DMNSN_INLINE dmnsn_vector
dmnsn_vector_add(dmnsn_vector lhs, dmnsn_vector rhs)
{
@@ -272,7 +272,7 @@ dmnsn_vector_add(dmnsn_vector lhs, dmnsn_vector rhs)
return v;
}
-/** Subtract two vectors */
+/** Subtract two vectors. */
DMNSN_INLINE dmnsn_vector
dmnsn_vector_sub(dmnsn_vector lhs, dmnsn_vector rhs)
{
@@ -422,7 +422,7 @@ dmnsn_line_point(dmnsn_line l, double t)
return dmnsn_vector_add(l.x0, dmnsn_vector_mul(t, l.n));
}
-/** Add epsilon*l.n to l.x0, to avoid self-intersections */
+/** Add epsilon*l.n to l.x0, to avoid self-intersections. */
DMNSN_INLINE dmnsn_line
dmnsn_line_add_epsilon(dmnsn_line l)
{
@@ -435,7 +435,7 @@ dmnsn_line_add_epsilon(dmnsn_line l)
);
}
-/** Return whether \p p is within the axis-aligned bounding box */
+/** Return whether \p p is within the axis-aligned bounding box. */
DMNSN_INLINE bool
dmnsn_bounding_box_contains(dmnsn_bounding_box box, dmnsn_vector p)
{
@@ -443,7 +443,7 @@ dmnsn_bounding_box_contains(dmnsn_bounding_box box, dmnsn_vector p)
&& (p.x <= box.max.x && p.y <= box.max.y && p.z <= box.max.z);
}
-/** Return whether a bounding box is infinite */
+/** Return whether a bounding box is infinite. */
DMNSN_INLINE bool
dmnsn_bounding_box_is_infinite(dmnsn_bounding_box box)
{
diff --git a/libdimension/dimension/interior.h b/libdimension/dimension/interior.h
index 7302426..56b5e5a 100644
--- a/libdimension/dimension/interior.h
+++ b/libdimension/dimension/interior.h
@@ -26,7 +26,7 @@
#ifndef DIMENSION_INTERIOR_H
#define DIMENSION_INTERIOR_H
-/** An interior */
+/** An interior. */
typedef struct dmnsn_interior {
double ior; /**< Refractive index. */
diff --git a/libdimension/dimension/light.h b/libdimension/dimension/light.h
index dfda157..876a5df 100644
--- a/libdimension/dimension/light.h
+++ b/libdimension/dimension/light.h
@@ -39,13 +39,13 @@ typedef dmnsn_color dmnsn_light_fn(const dmnsn_light *light, dmnsn_vector v);
/** A light. */
struct dmnsn_light {
- dmnsn_vector x0; /**< Origin of light rays */
+ dmnsn_vector x0; /**< Origin of light rays. */
/* Callbacks */
dmnsn_light_fn *light_fn; /**< Light callback. */
dmnsn_free_fn *free_fn; /**< Desctructor callback. */
- /** Generic pointer for light info */
+ /** Generic pointer for light info. */
void *ptr;
};
diff --git a/libdimension/dimension/list.h b/libdimension/dimension/list.h
index 9046583..9d99c9f 100644
--- a/libdimension/dimension/list.h
+++ b/libdimension/dimension/list.h
@@ -34,10 +34,10 @@
* A list iterator.
*/
typedef struct dmnsn_list_iterator {
- void *ptr; /**< @internal The stored object */
- size_t obj_size; /**< @internal The object size */
- struct dmnsn_list_iterator *prev; /**< @internal The previous iterator */
- struct dmnsn_list_iterator *next; /**< @internal The next iterator */
+ void *ptr; /**< @internal The stored object. */
+ size_t obj_size; /**< @internal The object size. */
+ struct dmnsn_list_iterator *prev; /**< @internal The previous iterator. */
+ struct dmnsn_list_iterator *next; /**< @internal The next iterator. */
} dmnsn_list_iterator;
/**
@@ -75,10 +75,10 @@ dmnsn_delete_list_iterator(dmnsn_list_iterator *i)
/** A doubly-linked list. */
typedef struct dmnsn_list {
- dmnsn_list_iterator *first; /**< @internal The first iterator in the list */
- dmnsn_list_iterator *last; /**< @internal The last iterator in the list */
- size_t length; /**< @internal The size of the list */
- size_t obj_size; /**< @internal The size of list objects */
+ dmnsn_list_iterator *first; /**< @internal The first iterator in the list. */
+ dmnsn_list_iterator *last; /**< @internal The last iterator in the list. */
+ size_t length; /**< @internal The size of the list. */
+ size_t obj_size; /**< @internal The size of list objects. */
} dmnsn_list;
/**
@@ -331,7 +331,7 @@ dmnsn_list_pop(dmnsn_list *list, void *obj)
*/
dmnsn_list *dmnsn_list_split(dmnsn_list *list);
-/** List object comparator function type */
+/** List object comparator function type. */
typedef bool dmnsn_list_comparator_fn(dmnsn_list_iterator *l,
dmnsn_list_iterator *r);
diff --git a/libdimension/dimension/object.h b/libdimension/dimension/object.h
index 28682a2..2ee4b67 100644
--- a/libdimension/dimension/object.h
+++ b/libdimension/dimension/object.h
@@ -31,12 +31,15 @@
/** A type to represent a ray-object intersection. */
typedef struct dmnsn_intersection {
dmnsn_line ray; /**< The ray that intersected. */
- double t; /**< The line index that intersected */
+ double t; /**< The line index that intersected. */
- dmnsn_vector normal; /**< The surface normal at the intersection point */
+ /** The surface normal at the intersection point. */
+ dmnsn_vector normal;
- const dmnsn_texture *texture; /**< The texture at the intersection point */
- const dmnsn_interior *interior; /**< The interior at the intersection point */
+ /** The texture at the intersection point. */
+ const dmnsn_texture *texture;
+ /** The interior at the intersection point. */
+ const dmnsn_interior *interior;
} dmnsn_intersection;
/* Forward-declare dmnsn_object */
@@ -71,13 +74,13 @@ typedef bool dmnsn_object_inside_fn(const dmnsn_object *object,
/** An object. */
struct dmnsn_object {
- dmnsn_texture *texture; /**< Surface properties */
- dmnsn_interior *interior; /**< Interior properties */
+ dmnsn_texture *texture; /**< Surface properties. */
+ dmnsn_interior *interior; /**< Interior properties. */
- dmnsn_matrix trans; /**< Transformation matrix */
- dmnsn_matrix trans_inv; /**< Inverse of the transformation matrix */
+ dmnsn_matrix trans; /**< Transformation matrix. */
+ dmnsn_matrix trans_inv; /**< Inverse of the transformation matrix. */
- dmnsn_bounding_box bounding_box; /**< Object bounding box */
+ dmnsn_bounding_box bounding_box; /**< Object bounding box. */
/** Child objects. This array lists objects that can be split into
sub-objects for bounding purposes (for unions and meshes, for example). */
@@ -88,7 +91,7 @@ struct dmnsn_object {
dmnsn_object_inside_fn *inside_fn; /**< Inside callback. */
dmnsn_free_fn *free_fn; /**< Destruction callback. */
- /** Generic pointer for object info */
+ /** Generic pointer for object info. */
void *ptr;
};
diff --git a/libdimension/dimension/pattern.h b/libdimension/dimension/pattern.h
index 9636155..a696f7a 100644
--- a/libdimension/dimension/pattern.h
+++ b/libdimension/dimension/pattern.h
@@ -43,10 +43,10 @@ struct dmnsn_pattern {
dmnsn_pattern_fn *pattern_fn; /**< The pattern callback. */
dmnsn_free_fn *free_fn; /**< The destructor callback. */
- dmnsn_matrix trans; /**< The transformation matrix of the pattern */
- dmnsn_matrix trans_inv; /**< The inverse of the transformation matrix */
+ dmnsn_matrix trans; /**< The transformation matrix of the pattern. */
+ dmnsn_matrix trans_inv; /**< The inverse of the transformation matrix. */
- void *ptr; /**< Generic pointer */
+ void *ptr; /**< Generic pointer. */
};
/**
diff --git a/libdimension/dimension/progress.h b/libdimension/dimension/progress.h
index 89d0d25..605ec83 100644
--- a/libdimension/dimension/progress.h
+++ b/libdimension/dimension/progress.h
@@ -29,7 +29,7 @@
#ifndef DIMENSION_PROGRESS_H
#define DIMENSION_PROGRESS_H
-/** A progress object */
+/** A progress object. */
typedef struct dmnsn_progress dmnsn_progress;
/**
diff --git a/libdimension/dimension/scene.h b/libdimension/dimension/scene.h
index 36fe74e..57ef32b 100644
--- a/libdimension/dimension/scene.h
+++ b/libdimension/dimension/scene.h
@@ -67,7 +67,7 @@ typedef struct dmnsn_scene {
/** Number of parallel threads. */
unsigned int nthreads;
- /** Timers */
+ /** Timers. */
dmnsn_timer *bounding_timer;
dmnsn_timer *render_timer;
} dmnsn_scene;
diff --git a/libdimension/dimension/texture.h b/libdimension/dimension/texture.h
index f582351..646f4b1 100644
--- a/libdimension/dimension/texture.h
+++ b/libdimension/dimension/texture.h
@@ -48,7 +48,7 @@ typedef dmnsn_color dmnsn_pigment_fn(const dmnsn_pigment *pigment,
*/
typedef void dmnsn_pigment_init_fn(dmnsn_pigment *pigment);
-/** A pigment */
+/** A pigment. */
struct dmnsn_pigment {
dmnsn_pigment_fn *pigment_fn; /**< The pigment callback. */
dmnsn_pigment_init_fn *init_fn; /**< The initializer callback. */
@@ -60,7 +60,7 @@ struct dmnsn_pigment {
/** Quick color -- used for low-quality renders. */
dmnsn_color quick_color;
- /** Generic pointer */
+ /** Generic pointer. */
void *ptr;
};
@@ -146,7 +146,7 @@ struct dmnsn_finish {
dmnsn_reflection_fn *reflection_fn; /**< The reflection callback. */
dmnsn_free_fn *free_fn; /**< The destruction callback. */
- /** Generic pointer */
+ /** Generic pointer. */
void *ptr;
};