swrast.h revision eb2a6d62f9353d90be757fc1617040c7ccddac39 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.5
4 *
5 * Copyright (C) 1999-2006  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/**
27 * \file swrast/swrast.h
28 * \brief Public interface to the software rasterization functions.
29 * \author Keith Whitwell <keith@tungstengraphics.com>
30 */
31
32#ifndef SWRAST_H
33#define SWRAST_H
34
35#include "mtypes.h"
36
37/**
38 * \struct SWvertex
39 * \brief Data-structure to handle vertices in the software rasterizer.
40 *
41 * The software rasterizer now uses this format for vertices.  Thus a
42 * 'RasterSetup' stage or other translation is required between the
43 * tnl module and the swrast rasterization functions.  This serves to
44 * isolate the swrast module from the internals of the tnl module, and
45 * improve its usefulness as a fallback mechanism for hardware
46 * drivers.
47 *
48 * Full software drivers:
49 *   - Register the rastersetup and triangle functions from
50 *     utils/software_helper.
51 *   - On statechange, update the rasterization pointers in that module.
52 *
53 * Rasterization hardware drivers:
54 *   - Keep native rastersetup.
55 *   - Implement native twoside,offset and unfilled triangle setup.
56 *   - Implement a translator from native vertices to swrast vertices.
57 *   - On partial fallback (mix of accelerated and unaccelerated
58 *   prims), call a pass-through function which translates native
59 *   vertices to SWvertices and calls the appropriate swrast function.
60 *   - On total fallback (vertex format insufficient for state or all
61 *     primitives unaccelerated), hook in swrast_setup instead.
62 */
63typedef struct {
64   /** win[0], win[1] are the screen-coords of SWvertex.
65    * win[2] is the z-buffer coord (if 16-bit Z buffer, in range [0,65535]).
66    * win[3] is 1/w where w is the clip-space W coord.  This is the value
67    * that clip{XYZ} were multiplied by to get ndc{XYZ}.
68    */
69   GLfloat win[4];
70   GLfloat texcoord[MAX_TEXTURE_COORD_UNITS][4];
71   GLchan color[4];
72   GLchan specular[4];
73   GLfloat fog;
74   GLfloat index;
75   GLfloat pointSize;
76   GLfloat varying[MAX_VERTEX_ATTRIBS][4];
77} SWvertex;
78
79
80struct swrast_device_driver;
81
82
83/* These are the public-access functions exported from swrast.
84 */
85
86extern GLboolean
87_swrast_CreateContext( GLcontext *ctx );
88
89extern void
90_swrast_DestroyContext( GLcontext *ctx );
91
92/* Get a (non-const) reference to the device driver struct for swrast.
93 */
94extern struct swrast_device_driver *
95_swrast_GetDeviceDriverReference( GLcontext *ctx );
96
97extern void
98_swrast_Bitmap( GLcontext *ctx,
99		GLint px, GLint py,
100		GLsizei width, GLsizei height,
101		const struct gl_pixelstore_attrib *unpack,
102		const GLubyte *bitmap );
103
104extern void
105_swrast_CopyPixels( GLcontext *ctx,
106		    GLint srcx, GLint srcy,
107		    GLint destx, GLint desty,
108		    GLsizei width, GLsizei height,
109		    GLenum type );
110
111extern void
112_swrast_DrawPixels( GLcontext *ctx,
113		    GLint x, GLint y,
114		    GLsizei width, GLsizei height,
115		    GLenum format, GLenum type,
116		    const struct gl_pixelstore_attrib *unpack,
117		    const GLvoid *pixels );
118
119extern void
120_swrast_ReadPixels( GLcontext *ctx,
121		    GLint x, GLint y, GLsizei width, GLsizei height,
122		    GLenum format, GLenum type,
123		    const struct gl_pixelstore_attrib *unpack,
124		    GLvoid *pixels );
125
126extern void
127_swrast_BlitFramebuffer(GLcontext *ctx,
128                        GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
129                        GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
130                        GLbitfield mask, GLenum filter);
131
132extern void
133_swrast_Clear(GLcontext *ctx, GLbitfield buffers);
134
135extern void
136_swrast_Accum(GLcontext *ctx, GLenum op, GLfloat value);
137
138
139
140/* Reset the stipple counter
141 */
142extern void
143_swrast_ResetLineStipple( GLcontext *ctx );
144
145/* These will always render the correct point/line/triangle for the
146 * current state.
147 *
148 * For flatshaded primitives, the provoking vertex is the final one.
149 */
150extern void
151_swrast_Point( GLcontext *ctx, const SWvertex *v );
152
153extern void
154_swrast_Line( GLcontext *ctx, const SWvertex *v0, const SWvertex *v1 );
155
156extern void
157_swrast_Triangle( GLcontext *ctx, const SWvertex *v0,
158                  const SWvertex *v1, const SWvertex *v2 );
159
160extern void
161_swrast_Quad( GLcontext *ctx,
162              const SWvertex *v0, const SWvertex *v1,
163	      const SWvertex *v2,  const SWvertex *v3);
164
165extern void
166_swrast_flush( GLcontext *ctx );
167
168extern void
169_swrast_render_primitive( GLcontext *ctx, GLenum mode );
170
171extern void
172_swrast_render_start( GLcontext *ctx );
173
174extern void
175_swrast_render_finish( GLcontext *ctx );
176
177/* Tell the software rasterizer about core state changes.
178 */
179extern void
180_swrast_InvalidateState( GLcontext *ctx, GLbitfield new_state );
181
182/* Configure software rasterizer to match hardware rasterizer characteristics:
183 */
184extern void
185_swrast_allow_vertex_fog( GLcontext *ctx, GLboolean value );
186
187extern void
188_swrast_allow_pixel_fog( GLcontext *ctx, GLboolean value );
189
190/* Debug:
191 */
192extern void
193_swrast_print_vertex( GLcontext *ctx, const SWvertex *v );
194
195
196/*
197 * Imaging fallbacks (a better solution should be found, perhaps
198 * moving all the imaging fallback code to a new module)
199 */
200extern void
201_swrast_CopyConvolutionFilter2D(GLcontext *ctx, GLenum target,
202				GLenum internalFormat,
203				GLint x, GLint y, GLsizei width,
204				GLsizei height);
205extern void
206_swrast_CopyConvolutionFilter1D(GLcontext *ctx, GLenum target,
207				GLenum internalFormat,
208				GLint x, GLint y, GLsizei width);
209extern void
210_swrast_CopyColorSubTable( GLcontext *ctx,GLenum target, GLsizei start,
211			   GLint x, GLint y, GLsizei width);
212extern void
213_swrast_CopyColorTable( GLcontext *ctx,
214			GLenum target, GLenum internalformat,
215			GLint x, GLint y, GLsizei width);
216
217
218/*
219 * Texture fallbacks.  Could also live in a new module
220 * with the rest of the texture store fallbacks?
221 */
222extern void
223_swrast_copy_teximage1d(GLcontext *ctx, GLenum target, GLint level,
224                        GLenum internalFormat,
225                        GLint x, GLint y, GLsizei width, GLint border);
226
227extern void
228_swrast_copy_teximage2d(GLcontext *ctx, GLenum target, GLint level,
229                        GLenum internalFormat,
230                        GLint x, GLint y, GLsizei width, GLsizei height,
231                        GLint border);
232
233
234extern void
235_swrast_copy_texsubimage1d(GLcontext *ctx, GLenum target, GLint level,
236                           GLint xoffset, GLint x, GLint y, GLsizei width);
237
238extern void
239_swrast_copy_texsubimage2d(GLcontext *ctx,
240                           GLenum target, GLint level,
241                           GLint xoffset, GLint yoffset,
242                           GLint x, GLint y, GLsizei width, GLsizei height);
243
244extern void
245_swrast_copy_texsubimage3d(GLcontext *ctx,
246                           GLenum target, GLint level,
247                           GLint xoffset, GLint yoffset, GLint zoffset,
248                           GLint x, GLint y, GLsizei width, GLsizei height);
249
250
251extern void
252_swrast_eject_texture_images(GLcontext *ctx);
253
254
255#if FEATURE_MESA_program_debug
256extern void
257_swrast_get_program_register(GLcontext *, enum register_file file,
258                             GLuint index, GLfloat val[4]);
259#endif /* FEATURE_MESA_program_debug */
260
261
262/**
263 * The driver interface for the software rasterizer.
264 * XXX this may go away.
265 * We may move these functions to ctx->Driver.RenderStart, RenderEnd.
266 */
267struct swrast_device_driver {
268   /*
269    * These are called before and after accessing renderbuffers during
270    * software rasterization.
271    *
272    * These are a suitable place for grabbing/releasing hardware locks.
273    *
274    * NOTE: The swrast triangle/line/point routines *DO NOT* call
275    * these functions.  Locking in that case must be organized by the
276    * driver by other mechanisms.
277    */
278   void (*SpanRenderStart)(GLcontext *ctx);
279   void (*SpanRenderFinish)(GLcontext *ctx);
280};
281
282
283
284#endif
285