mesa: more comments, clean-ups
[mesa.git] / src / mesa / main / image.h
1 /*
2 * Mesa 3-D graphics library
3 * Version: 7.1
4 *
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26 #ifndef IMAGE_H
27 #define IMAGE_H
28
29
30 #include "mtypes.h"
31
32
33 extern void
34 _mesa_swap2( GLushort *p, GLuint n );
35
36 extern void
37 _mesa_swap4( GLuint *p, GLuint n );
38
39 extern GLboolean
40 _mesa_type_is_packed(GLenum type);
41
42 extern GLint
43 _mesa_sizeof_type( GLenum type );
44
45 extern GLint
46 _mesa_sizeof_packed_type( GLenum type );
47
48 extern GLint
49 _mesa_components_in_format( GLenum format );
50
51 extern GLint
52 _mesa_bytes_per_pixel( GLenum format, GLenum type );
53
54 extern GLboolean
55 _mesa_is_legal_format_and_type( GLcontext *ctx, GLenum format, GLenum type );
56
57 extern GLboolean
58 _mesa_is_color_format(GLenum format);
59
60 extern GLboolean
61 _mesa_is_index_format(GLenum format);
62
63 extern GLboolean
64 _mesa_is_depth_format(GLenum format);
65
66 extern GLboolean
67 _mesa_is_stencil_format(GLenum format);
68
69 extern GLboolean
70 _mesa_is_ycbcr_format(GLenum format);
71
72 extern GLboolean
73 _mesa_is_depthstencil_format(GLenum format);
74
75 extern GLboolean
76 _mesa_is_dudv_format(GLenum format);
77
78
79 extern GLvoid *
80 _mesa_image_address( GLuint dimensions,
81 const struct gl_pixelstore_attrib *packing,
82 const GLvoid *image,
83 GLsizei width, GLsizei height,
84 GLenum format, GLenum type,
85 GLint img, GLint row, GLint column );
86
87 extern GLvoid *
88 _mesa_image_address1d( const struct gl_pixelstore_attrib *packing,
89 const GLvoid *image,
90 GLsizei width,
91 GLenum format, GLenum type,
92 GLint column );
93
94 extern GLvoid *
95 _mesa_image_address2d( const struct gl_pixelstore_attrib *packing,
96 const GLvoid *image,
97 GLsizei width, GLsizei height,
98 GLenum format, GLenum type,
99 GLint row, GLint column );
100
101 extern GLvoid *
102 _mesa_image_address3d( const struct gl_pixelstore_attrib *packing,
103 const GLvoid *image,
104 GLsizei width, GLsizei height,
105 GLenum format, GLenum type,
106 GLint img, GLint row, GLint column );
107
108
109 extern GLint
110 _mesa_image_row_stride( const struct gl_pixelstore_attrib *packing,
111 GLint width, GLenum format, GLenum type );
112
113
114 extern GLint
115 _mesa_image_image_stride( const struct gl_pixelstore_attrib *packing,
116 GLint width, GLint height,
117 GLenum format, GLenum type );
118
119 extern void
120 _mesa_unpack_polygon_stipple( const GLubyte *pattern, GLuint dest[32],
121 const struct gl_pixelstore_attrib *unpacking );
122
123
124 extern void
125 _mesa_pack_polygon_stipple( const GLuint pattern[32], GLubyte *dest,
126 const struct gl_pixelstore_attrib *packing );
127
128
129 extern GLvoid *
130 _mesa_unpack_bitmap( GLint width, GLint height, const GLubyte *pixels,
131 const struct gl_pixelstore_attrib *packing );
132
133 extern void
134 _mesa_pack_bitmap( GLint width, GLint height, const GLubyte *source,
135 GLubyte *dest, const struct gl_pixelstore_attrib *packing );
136
137
138 /** \name Pixel processing functions */
139 /*@{*/
140
141 extern void
142 _mesa_scale_and_bias_rgba(GLuint n, GLfloat rgba[][4],
143 GLfloat rScale, GLfloat gScale,
144 GLfloat bScale, GLfloat aScale,
145 GLfloat rBias, GLfloat gBias,
146 GLfloat bBias, GLfloat aBias);
147
148 extern void
149 _mesa_map_rgba(const GLcontext *ctx, GLuint n, GLfloat rgba[][4]);
150
151
152 extern void
153 _mesa_transform_rgba(const GLcontext *ctx, GLuint n, GLfloat rgba[][4]);
154
155
156 extern void
157 _mesa_lookup_rgba_float(const struct gl_color_table *table,
158 GLuint n, GLfloat rgba[][4]);
159
160 extern void
161 _mesa_lookup_rgba_ubyte(const struct gl_color_table *table,
162 GLuint n, GLubyte rgba[][4]);
163
164
165 extern void
166 _mesa_map_ci_to_rgba(const GLcontext *ctx,
167 GLuint n, const GLuint index[], GLfloat rgba[][4]);
168
169
170 extern void
171 _mesa_map_ci8_to_rgba8(const GLcontext *ctx, GLuint n, const GLubyte index[],
172 GLubyte rgba[][4]);
173
174
175 extern void
176 _mesa_scale_and_bias_depth(const GLcontext *ctx, GLuint n,
177 GLfloat depthValues[]);
178
179 extern void
180 _mesa_scale_and_bias_depth_uint(const GLcontext *ctx, GLuint n,
181 GLuint depthValues[]);
182
183 extern void
184 _mesa_apply_rgba_transfer_ops(GLcontext *ctx, GLbitfield transferOps,
185 GLuint n, GLfloat rgba[][4]);
186
187
188 extern void
189 _mesa_apply_ci_transfer_ops(const GLcontext *ctx, GLbitfield transferOps,
190 GLuint n, GLuint indexes[]);
191
192
193 extern void
194 _mesa_apply_stencil_transfer_ops(const GLcontext *ctx, GLuint n,
195 GLstencil stencil[]);
196
197
198 extern void
199 _mesa_pack_rgba_span_float( GLcontext *ctx, GLuint n, GLfloat rgba[][4],
200 GLenum dstFormat, GLenum dstType, GLvoid *dstAddr,
201 const struct gl_pixelstore_attrib *dstPacking,
202 GLbitfield transferOps );
203
204
205 extern void
206 _mesa_unpack_color_span_chan( GLcontext *ctx,
207 GLuint n, GLenum dstFormat, GLchan dest[],
208 GLenum srcFormat, GLenum srcType,
209 const GLvoid *source,
210 const struct gl_pixelstore_attrib *srcPacking,
211 GLbitfield transferOps );
212
213
214 extern void
215 _mesa_unpack_color_span_float( GLcontext *ctx,
216 GLuint n, GLenum dstFormat, GLfloat dest[],
217 GLenum srcFormat, GLenum srcType,
218 const GLvoid *source,
219 const struct gl_pixelstore_attrib *srcPacking,
220 GLbitfield transferOps );
221
222 extern void
223 _mesa_unpack_dudv_span_byte( GLcontext *ctx,
224 GLuint n, GLenum dstFormat, GLbyte dest[],
225 GLenum srcFormat, GLenum srcType,
226 const GLvoid *source,
227 const struct gl_pixelstore_attrib *srcPacking,
228 GLbitfield transferOps );
229
230 extern void
231 _mesa_unpack_index_span( const GLcontext *ctx, GLuint n,
232 GLenum dstType, GLvoid *dest,
233 GLenum srcType, const GLvoid *source,
234 const struct gl_pixelstore_attrib *srcPacking,
235 GLbitfield transferOps );
236
237
238 extern void
239 _mesa_pack_index_span( const GLcontext *ctx, GLuint n,
240 GLenum dstType, GLvoid *dest, const GLuint *source,
241 const struct gl_pixelstore_attrib *dstPacking,
242 GLbitfield transferOps );
243
244
245 extern void
246 _mesa_unpack_stencil_span( const GLcontext *ctx, GLuint n,
247 GLenum dstType, GLvoid *dest,
248 GLenum srcType, const GLvoid *source,
249 const struct gl_pixelstore_attrib *srcPacking,
250 GLbitfield transferOps );
251
252 extern void
253 _mesa_pack_stencil_span( const GLcontext *ctx, GLuint n,
254 GLenum dstType, GLvoid *dest, const GLstencil *source,
255 const struct gl_pixelstore_attrib *dstPacking );
256
257
258 extern void
259 _mesa_unpack_depth_span( const GLcontext *ctx, GLuint n,
260 GLenum dstType, GLvoid *dest, GLuint depthMax,
261 GLenum srcType, const GLvoid *source,
262 const struct gl_pixelstore_attrib *srcPacking );
263
264 extern void
265 _mesa_pack_depth_span( const GLcontext *ctx, GLuint n, GLvoid *dest,
266 GLenum dstType, const GLfloat *depthSpan,
267 const struct gl_pixelstore_attrib *dstPacking );
268
269
270 extern void
271 _mesa_pack_depth_stencil_span(const GLcontext *ctx, GLuint n, GLuint *dest,
272 const GLfloat *depthVals,
273 const GLstencil *stencilVals,
274 const struct gl_pixelstore_attrib *dstPacking);
275
276
277 extern void *
278 _mesa_unpack_image( GLuint dimensions,
279 GLsizei width, GLsizei height, GLsizei depth,
280 GLenum format, GLenum type, const GLvoid *pixels,
281 const struct gl_pixelstore_attrib *unpack );
282
283
284 extern void
285 _mesa_convert_colors(GLenum srcType, const GLvoid *src,
286 GLenum dstType, GLvoid *dst,
287 GLuint count, const GLubyte mask[]);
288
289
290 extern GLboolean
291 _mesa_clip_drawpixels(const GLcontext *ctx,
292 GLint *destX, GLint *destY,
293 GLsizei *width, GLsizei *height,
294 struct gl_pixelstore_attrib *unpack);
295
296
297 extern GLboolean
298 _mesa_clip_readpixels(const GLcontext *ctx,
299 GLint *destX, GLint *destY,
300 GLsizei *width, GLsizei *height,
301 struct gl_pixelstore_attrib *pack);
302
303 extern GLboolean
304 _mesa_clip_copytexsubimage(const GLcontext *ctx,
305 GLint *destX, GLint *destY,
306 GLint *srcX, GLint *srcY,
307 GLsizei *width, GLsizei *height);
308
309 extern GLboolean
310 _mesa_clip_to_region(GLint xmin, GLint ymin,
311 GLint xmax, GLint ymax,
312 GLint *x, GLint *y,
313 GLsizei *width, GLsizei *height );
314
315 extern GLboolean
316 _mesa_clip_blit(GLcontext *ctx,
317 GLint *srcX0, GLint *srcY0, GLint *srcX1, GLint *srcY1,
318 GLint *dstX0, GLint *dstY0, GLint *dstX1, GLint *dstY1);
319
320
321 #endif