summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/texture.h
blob: 0398abc3905e0765992cb8631cc185f0797f2e17 (plain)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*************************************************************************
 * Copyright (C) 2009-2010 Tavian Barnes <tavianator@gmail.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
 * Object textures.
 */

#ifndef DIMENSION_TEXTURE_H
#define DIMENSION_TEXTURE_H

/*
 * Pigments
 */

/* Forward-declare dmnsn_pigment */
typedef struct dmnsn_pigment dmnsn_pigment;

/**
 * Pigment callback.
 * @param[in] pigment  The pigment itself.
 * @param[in] v        The point to color.
 * @return The color of the pigment at \p v.
 */
typedef dmnsn_color dmnsn_pigment_fn(const dmnsn_pigment *pigment,
                                     dmnsn_vector v);

/**
 * Pigment initializer callback.
 * @param[in,out] pigment  The pigment to initialize.
 */
typedef void dmnsn_pigment_initialize_fn(dmnsn_pigment *pigment);

/** A pigment. */
struct dmnsn_pigment {
  dmnsn_pigment_fn *pigment_fn;               /**< The pigment callback. */
  dmnsn_pigment_initialize_fn *initialize_fn; /**< The initializer callback. */
  dmnsn_free_fn *free_fn;                     /**< The destructor callback. */

  dmnsn_matrix trans;     /**< Transformation matrix. */
  dmnsn_matrix trans_inv; /**< The inverse of the transformation matrix. */

  /** Quick color -- used for low-quality renders. */
  dmnsn_color quick_color;

  /** Generic pointer. */
  void *ptr;
};

/**
 * Allocate a new dummy pigment.
 * @return The allocated pigment.
 */
dmnsn_pigment *dmnsn_new_pigment(void);

/**
 * Delete a pigment.
 * @param[in,out] pigment  The pigment to delete.
 */
void dmnsn_delete_pigment(dmnsn_pigment *pigment);

/**
 * Initialize a pigment.  Pigments should not be used before being initialized,
 * but should not be modified after being initialized.  Pigments are generally
 * initialized for you.
 * @param[in,out] pigment  The pigment to initialize.
 */
void dmnsn_initialize_pigment(dmnsn_pigment *pigment);

/*
 * Finishes
 */

/* Forward-declare dmnsn_finish */
typedef struct dmnsn_finish dmnsn_finish;

/**
 * Diffuse reflection callback.
 * @param[in] finish  The finish itself.
 * @param[in] light   The color of the light illuminating the object.
 * @param[in] color   The pigment of the object.
 * @param[in] ray     The direction of the light source.
 * @param[in] normal  The normal vector of the surface.
 * @return The diffuse reflection component of the object's color.
 */
typedef dmnsn_color dmnsn_diffuse_fn(const dmnsn_finish *finish,
                                     dmnsn_color light, dmnsn_color color,
                                     dmnsn_vector ray, dmnsn_vector normal);
/**
 * Specular highlight callback.
 * @param[in] finish  The finish itself.
 * @param[in] light   The color of the light illuminating the object.
 * @param[in] color   The pigment of the object.
 * @param[in] ray     The direction of the light source.
 * @param[in] normal  The normal vector of the surface.
 * @param[in] viewer  The direction of the viewer.
 * @return The specular reflection component of the object's color.
 */
typedef dmnsn_color dmnsn_specular_fn(const dmnsn_finish *finish,
                                      dmnsn_color light, dmnsn_color color,
                                      dmnsn_vector ray, dmnsn_vector normal,
                                      dmnsn_vector viewer);
/**
 * Ambient light callback.
 * @param[in] finish   The finish itself.
 * @param[in] pigment  The pigment of the object.
 * @return The ambient contribution to the object's color.
 */
typedef dmnsn_color dmnsn_ambient_fn(const dmnsn_finish *finish,
                                     dmnsn_color pigment);
/**
 * Reflected light callback.
 * @param[in] finish   The finish itself.
 * @param[in] reflect  The color of the reflected ray.
 * @param[in] color    The pigment of the object.
 * @param[in] ray      The direction of the reflected ray.
 * @param[in] normal   The normal vector of the surface.
 * @return The contribution of the reflected ray to the object's color.
 */
typedef dmnsn_color dmnsn_reflection_fn(const dmnsn_finish *finish,
                                        dmnsn_color reflect, dmnsn_color color,
                                        dmnsn_vector ray, dmnsn_vector normal);

/** A finish. */
struct dmnsn_finish {
  dmnsn_diffuse_fn    *diffuse_fn;    /**< The diffuse callback. */
  dmnsn_specular_fn   *specular_fn;   /**< The specular callback. */
  dmnsn_ambient_fn    *ambient_fn;    /**< The ambient callback. */
  dmnsn_reflection_fn *reflection_fn; /**< The reflection callback. */
  dmnsn_free_fn       *free_fn;       /**< The destruction callback. */

  /** Generic pointer. */
  void *ptr;
};

/**
 * Allocate a new dummy finish.
 * @return The allocated finish.
 */
dmnsn_finish *dmnsn_new_finish(void);

/**
 * Delete a finish.
 * @param[in,out] finish  The finish to delete.
 */
void dmnsn_delete_finish(dmnsn_finish *finish);

/*
 * Textures
 */

/** A complete texture. */
typedef struct {
  dmnsn_pigment *pigment; /**< Pigment. */
  dmnsn_finish  *finish;  /**< Finish. */

  dmnsn_matrix trans;     /**< Transformation matrix. */
  dmnsn_matrix trans_inv; /**< The inverse of the transformation matrix. */

  unsigned int *refcount; /**< @internal Reference count. */
  bool should_init;       /**< @internal Whether to initialize the texture. */
} dmnsn_texture;

/**
 * Create a blank texture.
 * @return The new texture.
 */
dmnsn_texture *dmnsn_new_texture(void);

/**
 * Delete a texture.
 * @param[in,out] texture  The texture to delete.
 */
void dmnsn_delete_texture(dmnsn_texture *texture);

/**
 * Initialize a texture.  Textures should not be used before being initialized,
 * but should not be modified after being initialized.  Textures are generally
 * initialized for you.
 * @param[in,out] texture  The texture to initialize.
 */
void dmnsn_initialize_texture(dmnsn_texture *texture);

#endif /* DIMENSION_TEXTURE_H */