diff options
Diffstat (limited to 'include')
-rw-r--r-- | include/common/error.h | 2 | ||||
-rw-r--r-- | include/morpher/matrix.h | 6 | ||||
-rw-r--r-- | include/morpher/morphing.h | 7 | ||||
-rw-r--r-- | include/morpher/trianglemap.h | 10 | ||||
-rw-r--r-- | include/painter/canvas.h | 6 | ||||
-rw-r--r-- | include/painter/color.h | 23 | ||||
-rw-r--r-- | include/painter/rasterizer.h | 2 |
7 files changed, 26 insertions, 30 deletions
diff --git a/include/common/error.h b/include/common/error.h index 22c2630..69104cb 100644 --- a/include/common/error.h +++ b/include/common/error.h | |||
@@ -13,7 +13,7 @@ | |||
13 | #define OUT_OF_MEMORY_ERROR "Out of memory" | 13 | #define OUT_OF_MEMORY_ERROR "Out of memory" |
14 | 14 | ||
15 | /** | 15 | /** |
16 | * Function: rage quit | 16 | * Function: rage_quit |
17 | * Logs the supplied error message to stderr before exiting the program with an error status code. | 17 | * Logs the supplied error message to stderr before exiting the program with an error status code. |
18 | * | 18 | * |
19 | * Parameters: | 19 | * Parameters: |
diff --git a/include/morpher/matrix.h b/include/morpher/matrix.h index 8118727..e3d5517 100644 --- a/include/morpher/matrix.h +++ b/include/morpher/matrix.h | |||
@@ -3,10 +3,8 @@ | |||
3 | 3 | ||
4 | /** | 4 | /** |
5 | * File: matrix.h | 5 | * File: matrix.h |
6 | * Determinant operations. | 6 | * > The matrix is a system Neo, that system is our enemy. |
7 | * | 7 | * -- Morpheus |
8 | * See also: | ||
9 | * The film | ||
10 | */ | 8 | */ |
11 | 9 | ||
12 | #include "common/geom.h" | 10 | #include "common/geom.h" |
diff --git a/include/morpher/morphing.h b/include/morpher/morphing.h index 028cd87..48c33b4 100644 --- a/include/morpher/morphing.h +++ b/include/morpher/morphing.h | |||
@@ -26,17 +26,20 @@ typedef struct { | |||
26 | } Morphing; | 26 | } Morphing; |
27 | 27 | ||
28 | /** | 28 | /** |
29 | * Function: morphing_init | 29 | * Function: morphing_create |
30 | * Initialises a morphing. | 30 | * Initialises a morphing. |
31 | * | 31 | * |
32 | * Parameters: | 32 | * Parameters: |
33 | * width - coordinate matrix width in pixels | 33 | * width - coordinate matrix width in pixels |
34 | * height - coordinate matrix height in pixels | 34 | * height - coordinate matrix height in pixels |
35 | * | ||
36 | * Returns: | ||
37 | * The created morphing, dynamically allocated | ||
35 | */ | 38 | */ |
36 | Morphing *morphing_create(IntVector width, IntVector height); | 39 | Morphing *morphing_create(IntVector width, IntVector height); |
37 | 40 | ||
38 | /** | 41 | /** |
39 | * Function: morphing_free | 42 | * Function: morphing_destroy |
40 | * Frees any resources allocated to a morphing. | 43 | * Frees any resources allocated to a morphing. |
41 | * | 44 | * |
42 | * Parameters: | 45 | * Parameters: |
diff --git a/include/morpher/trianglemap.h b/include/morpher/trianglemap.h index 3dc5f96..735be2f 100644 --- a/include/morpher/trianglemap.h +++ b/include/morpher/trianglemap.h | |||
@@ -29,12 +29,10 @@ typedef struct _TriangleMap { | |||
29 | * Creates a TriangleMap, instantiating it on the heap. | 29 | * Creates a TriangleMap, instantiating it on the heap. |
30 | * | 30 | * |
31 | * Parameters: | 31 | * Parameters: |
32 | * vertex1 - first vertex | 32 | * vi - the vertices, positively oriented |
33 | * vertex2 - second vertex | ||
34 | * vertex3 - third vertex | ||
35 | * | 33 | * |
36 | * Returns: | 34 | * Returns: |
37 | * A pointer to the newly created triangle | 35 | * A pointer to the newly created triangle, dynamically allocated |
38 | */ | 36 | */ |
39 | TriangleMap *trianglemap_create(CartesianMapping v1, CartesianMapping v2, CartesianMapping v3); | 37 | TriangleMap *trianglemap_create(CartesianMapping v1, CartesianMapping v2, CartesianMapping v3); |
40 | 38 | ||
@@ -87,9 +85,7 @@ int trianglemap_find_common_edge(TriangleMap *t, TriangleMap *neighbor); | |||
87 | * | 85 | * |
88 | * Parameters: | 86 | * Parameters: |
89 | * *t - the triangle to modify | 87 | * *t - the triangle to modify |
90 | * *n1 - first neighbour | 88 | * *ni - the neighbours |
91 | * *n2 - second neighbour | ||
92 | * *n3 - third neighbour | ||
93 | * *next - linear neighbour | 89 | * *next - linear neighbour |
94 | */ | 90 | */ |
95 | void trianglemap_set_neighbors(TriangleMap *t, TriangleMap *n1, TriangleMap *n2, TriangleMap *n3, TriangleMap *next); | 91 | void trianglemap_set_neighbors(TriangleMap *t, TriangleMap *n1, TriangleMap *n2, TriangleMap *n3, TriangleMap *next); |
diff --git a/include/painter/canvas.h b/include/painter/canvas.h index 928121a..51a7dc9 100644 --- a/include/painter/canvas.h +++ b/include/painter/canvas.h | |||
@@ -3,8 +3,6 @@ | |||
3 | 3 | ||
4 | /** | 4 | /** |
5 | * File: canvas.h | 5 | * File: canvas.h |
6 | * > Everyday is a good day when you paint. | ||
7 | * -- Bob Ross | ||
8 | */ | 6 | */ |
9 | 7 | ||
10 | #include <MLV/MLV_image.h> | 8 | #include <MLV/MLV_image.h> |
@@ -28,7 +26,7 @@ typedef struct { | |||
28 | * height - the height in pixels | 26 | * height - the height in pixels |
29 | * | 27 | * |
30 | * Returns: | 28 | * Returns: |
31 | * The initialised canvas | 29 | * The initialised canvas, dynamically allocated |
32 | */ | 30 | */ |
33 | Canvas *canvas_create(IntVector width, IntVector height); | 31 | Canvas *canvas_create(IntVector width, IntVector height); |
34 | 32 | ||
@@ -40,7 +38,7 @@ Canvas *canvas_create(IntVector width, IntVector height); | |||
40 | * *fpath - path to the base image file | 38 | * *fpath - path to the base image file |
41 | * | 39 | * |
42 | * Returns: | 40 | * Returns: |
43 | * The initialised canvas | 41 | * The initialised canvas, dynamically allocated |
44 | */ | 42 | */ |
45 | Canvas *canvas_create_from_image(const char *fpath); | 43 | Canvas *canvas_create_from_image(const char *fpath); |
46 | 44 | ||
diff --git a/include/painter/color.h b/include/painter/color.h index 2aeee3e..4a97f50 100644 --- a/include/painter/color.h +++ b/include/painter/color.h | |||
@@ -3,9 +3,8 @@ | |||
3 | 3 | ||
4 | /** | 4 | /** |
5 | * File: color.h | 5 | * File: color.h |
6 | * | 6 | * > Coming, colors in the air! Oh, everywhere! |
7 | * See also: | 7 | * -- The Rolling Stones |
8 | * A rainbow | ||
9 | */ | 8 | */ |
10 | 9 | ||
11 | #include <MLV/MLV_color.h> | 10 | #include <MLV/MLV_color.h> |
@@ -33,28 +32,28 @@ typedef union { | |||
33 | 32 | ||
34 | /** | 33 | /** |
35 | * Function: color_equals | 34 | * Function: color_equals |
36 | * Compares the supplied colors. | 35 | * Compares the supplied colours. |
37 | * | 36 | * |
38 | * Parameters: | 37 | * Parameters: |
39 | * c1 - the first color | 38 | * c1 - the first colour |
40 | * c2 - the second color | 39 | * c2 - the second colour |
41 | * | 40 | * |
42 | * Returns: | 41 | * Returns: |
43 | * T(c1 is the same color as c2) | 42 | * T(c1 is the same colour as c2) |
44 | */ | 43 | */ |
45 | bool color_equals(Color c1, Color c2); | 44 | bool color_equals(Color c1, Color c2); |
46 | 45 | ||
47 | /** | 46 | /** |
48 | * Function: color_blend | 47 | * Function: color_blend |
49 | * Blends two colors. | 48 | * Blends two colours. |
50 | * | 49 | * |
51 | * Parameters: | 50 | * Parameters: |
52 | * origin - the first color | 51 | * origin - the first colour |
53 | * target - the second color | 52 | * target - the second colour |
54 | * distance - the distance from the first color | 53 | * distance - the distance from the first colour |
55 | * | 54 | * |
56 | * Returns: | 55 | * Returns: |
57 | * The blended color | 56 | * The blended colour |
58 | */ | 57 | */ |
59 | Color color_blend(Color origin, Color target, TimeVector distance); | 58 | Color color_blend(Color origin, Color target, TimeVector distance); |
60 | 59 | ||
diff --git a/include/painter/rasterizer.h b/include/painter/rasterizer.h index 204d616..6859cb5 100644 --- a/include/painter/rasterizer.h +++ b/include/painter/rasterizer.h | |||
@@ -3,6 +3,8 @@ | |||
3 | 3 | ||
4 | /** | 4 | /** |
5 | * File: rasterizer.h | 5 | * File: rasterizer.h |
6 | * > Everyday is a good day when you paint. | ||
7 | * -- Bob Ross | ||
6 | */ | 8 | */ |
7 | 9 | ||
8 | #include "painter/canvas.h" | 10 | #include "painter/canvas.h" |