1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*************************************************************************
* Copyright (C) 2009-2014 Tavian Barnes <tavianator@tavianator.com> *
* *
* This file is part of The Dimension Library. *
* *
* The Dimension Library is free software; you can redistribute it and/ *
* or modify it under the terms of the GNU Lesser General Public License *
* as published by the Free Software Foundation; either version 3 of the *
* License, or (at your option) any later version. *
* *
* The Dimension Library is distributed in the hope that it will be *
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty *
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this program. If not, see *
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
/**
* @file
* A canvas which is rendered to.
*/
#ifndef DMNSN_CANVAS_H
#error "Please include <dimension/canvas.h> instead of this header directly."
#endif
#include <stddef.h>
/** A canvas, or image. */
typedef struct dmnsn_canvas {
size_t width; /**< Canvas width. */
size_t height; /**< Canvas height. */
/** An array of <tt>dmnsn_canvas_optimizer</tt>s. */
dmnsn_array *optimizers;
/**
* @internal
* Stored in first-quadrant representation (origin is bottom-left). The pixel
* at (a,b) is accessible as pixels[b*width + a].
*/
dmnsn_tcolor *pixels;
} dmnsn_canvas;
/* Forward-declare dmnsn_canvas_optimizer. */
typedef struct dmnsn_canvas_optimizer dmnsn_canvas_optimizer;
/**
* Canvas optimizer callback type.
* @param[in] optimizer The canvas optimizer.
* @param[in] canvas The canvas that was just updated.
* @param[in] x The x-coordinate that was just updated.
* @param[in] y The y-coordinate that was just updated.
*/
typedef void dmnsn_canvas_optimizer_fn(dmnsn_canvas_optimizer *optimizer, const dmnsn_canvas *canvas, size_t x, size_t y);
/** Canvas optimizer. */
struct dmnsn_canvas_optimizer {
dmnsn_canvas_optimizer_fn *optimizer_fn; /**< Optimizer callback. */
};
/**
* Allocate a new canvas.
* @param[in] pool The memory pool to allocate from.
* @param[in] width The width of the canvas to allocate (in pixels).
* @param[in] height The height of the canvas to allocate (in pixels).
* @return The allocated canvas.
*/
dmnsn_canvas *dmnsn_new_canvas(dmnsn_pool *pool, size_t width, size_t height);
/**
* Initialize a dmnsn_canvas_optimizer field
* @param[in] optimizer The optimizer to initialize.
*/
void dmnsn_init_canvas_optimizer(dmnsn_canvas_optimizer *optimizer);
/**
* Set a canvas optimizer
* @param[in,out] canvas The canvas to optimize.
* @param[in] optimizer The optimizer to use.
*/
void dmnsn_canvas_optimize(dmnsn_canvas *canvas,
const dmnsn_canvas_optimizer *optimizer);
/**
* Find a canvas optimizer by its callback.
* @param[in] canvas The canvas to check.
* @param[in] optimizer_fn The callback to search for for.
* @return A pointer to the canvas optimizer with the callback \p optimizer_fn,
* or NULL if none is found.
*/
dmnsn_canvas_optimizer *
dmnsn_canvas_find_optimizer(const dmnsn_canvas *canvas,
dmnsn_canvas_optimizer_fn *optimizer_fn);
/* Pixel accessors */
/**
* Get the color of a pixel.
* @param[in] canvas The canvas to access.
* @param[in] x The x coordinate.
* @param[in] y The y coordinate.
* @return The color of the pixel at (\p x, \p y).
*/
DMNSN_INLINE dmnsn_tcolor
dmnsn_canvas_get_pixel(const dmnsn_canvas *canvas, size_t x, size_t y)
{
dmnsn_assert(x < canvas->width && y < canvas->height,
"Canvas access out of bounds.");
return canvas->pixels[y*canvas->width + x];
}
/**
* Set the value of a pixel.
* @param[in,out] canvas The canvas to modify.
* @param[in] x The x coordinate of the pixel.
* @param[in] y The y coordinate of the pixel.
* @param[in] tcolor The value to set the pixel at (\p x, \p y) to.
*/
void dmnsn_canvas_set_pixel(dmnsn_canvas *canvas, size_t x, size_t y,
dmnsn_tcolor tcolor);
/**
* Clear a canvas uniformly with a given color.
* @param[in,out] canvas The canvas to erase.
* @param[in] tcolor The color to paint it with.
*/
void dmnsn_canvas_clear(dmnsn_canvas *canvas, dmnsn_tcolor tcolor);
|
