swrast.h revision 1eca891dbe39a4aad7a6ed267ce7cd55589073fe 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.5
4 *
5 * Copyright (C) 1999-2005  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} SWvertex;
77
78
79struct swrast_device_driver;
80
81
82/* These are the public-access functions exported from swrast.
83 */
84
85extern GLboolean
86_swrast_CreateContext( GLcontext *ctx );
87
88extern void
89_swrast_DestroyContext( GLcontext *ctx );
90
91/* Get a (non-const) reference to the device driver struct for swrast.
92 */
93extern struct swrast_device_driver *
94_swrast_GetDeviceDriverReference( GLcontext *ctx );
95
96extern void
97_swrast_Bitmap( GLcontext *ctx,
98		GLint px, GLint py,
99		GLsizei width, GLsizei height,
100		const struct gl_pixelstore_attrib *unpack,
101		const GLubyte *bitmap );
102
103extern void
104_swrast_CopyPixels( GLcontext *ctx,
105		    GLint srcx, GLint srcy,
106		    GLint destx, GLint desty,
107		    GLsizei width, GLsizei height,
108		    GLenum type );
109
110extern void
111_swrast_DrawPixels( GLcontext *ctx,
112		    GLint x, GLint y,
113		    GLsizei width, GLsizei height,
114		    GLenum format, GLenum type,
115		    const struct gl_pixelstore_attrib *unpack,
116		    const GLvoid *pixels );
117
118extern void
119_swrast_ReadPixels( GLcontext *ctx,
120		    GLint x, GLint y, GLsizei width, GLsizei height,
121		    GLenum format, GLenum type,
122		    const struct gl_pixelstore_attrib *unpack,
123		    GLvoid *pixels );
124
125extern void
126_swrast_blit_framebuffer(GLcontext *ctx,
127                         GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
128                         GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
129                         GLbitfield mask, GLenum filter);
130
131extern void
132_swrast_Clear( GLcontext *ctx, GLbitfield mask, GLboolean all,
133	       GLint x, GLint y, GLint width, GLint height );
134
135extern void
136_swrast_Accum( GLcontext *ctx, GLenum op,
137	       GLfloat value, GLint xpos, GLint ypos,
138	       GLint width, GLint height );
139
140
141
142/* Reset the stipple counter
143 */
144extern void
145_swrast_ResetLineStipple( GLcontext *ctx );
146
147/* These will always render the correct point/line/triangle for the
148 * current state.
149 *
150 * For flatshaded primitives, the provoking vertex is the final one.
151 */
152extern void
153_swrast_Point( GLcontext *ctx, const SWvertex *v );
154
155extern void
156_swrast_Line( GLcontext *ctx, const SWvertex *v0, const SWvertex *v1 );
157
158extern void
159_swrast_Triangle( GLcontext *ctx, const SWvertex *v0,
160                  const SWvertex *v1, const SWvertex *v2 );
161
162extern void
163_swrast_Quad( GLcontext *ctx,
164              const SWvertex *v0, const SWvertex *v1,
165	      const SWvertex *v2,  const SWvertex *v3);
166
167extern void
168_swrast_flush( GLcontext *ctx );
169
170extern void
171_swrast_render_primitive( GLcontext *ctx, GLenum mode );
172
173extern void
174_swrast_render_start( GLcontext *ctx );
175
176extern void
177_swrast_render_finish( GLcontext *ctx );
178
179/* Tell the software rasterizer about core state changes.
180 */
181extern void
182_swrast_InvalidateState( GLcontext *ctx, GLbitfield new_state );
183
184/* Configure software rasterizer to match hardware rasterizer characteristics:
185 */
186extern void
187_swrast_allow_vertex_fog( GLcontext *ctx, GLboolean value );
188
189extern void
190_swrast_allow_pixel_fog( GLcontext *ctx, GLboolean value );
191
192/* Debug:
193 */
194extern void
195_swrast_print_vertex( GLcontext *ctx, const SWvertex *v );
196
197
198/*
199 * Imaging fallbacks (a better solution should be found, perhaps
200 * moving all the imaging fallback code to a new module)
201 */
202extern void
203_swrast_CopyConvolutionFilter2D(GLcontext *ctx, GLenum target,
204				GLenum internalFormat,
205				GLint x, GLint y, GLsizei width,
206				GLsizei height);
207extern void
208_swrast_CopyConvolutionFilter1D(GLcontext *ctx, GLenum target,
209				GLenum internalFormat,
210				GLint x, GLint y, GLsizei width);
211extern void
212_swrast_CopyColorSubTable( GLcontext *ctx,GLenum target, GLsizei start,
213			   GLint x, GLint y, GLsizei width);
214extern void
215_swrast_CopyColorTable( GLcontext *ctx,
216			GLenum target, GLenum internalformat,
217			GLint x, GLint y, GLsizei width);
218
219
220/*
221 * Texture fallbacks.  Could also live in a new module
222 * with the rest of the texture store fallbacks?
223 */
224extern void
225_swrast_copy_teximage1d(GLcontext *ctx, GLenum target, GLint level,
226                        GLenum internalFormat,
227                        GLint x, GLint y, GLsizei width, GLint border);
228
229extern void
230_swrast_copy_teximage2d(GLcontext *ctx, GLenum target, GLint level,
231                        GLenum internalFormat,
232                        GLint x, GLint y, GLsizei width, GLsizei height,
233                        GLint border);
234
235
236extern void
237_swrast_copy_texsubimage1d(GLcontext *ctx, GLenum target, GLint level,
238                           GLint xoffset, GLint x, GLint y, GLsizei width);
239
240extern void
241_swrast_copy_texsubimage2d(GLcontext *ctx,
242                           GLenum target, GLint level,
243                           GLint xoffset, GLint yoffset,
244                           GLint x, GLint y, GLsizei width, GLsizei height);
245
246extern void
247_swrast_copy_texsubimage3d(GLcontext *ctx,
248                           GLenum target, GLint level,
249                           GLint xoffset, GLint yoffset, GLint zoffset,
250                           GLint x, GLint y, GLsizei width, GLsizei height);
251
252
253/**
254 * The driver interface for the software rasterizer.
255 * XXX this may go away.
256 * We may move these functions to ctx->Driver.RenderStart, RenderEnd.
257 */
258struct swrast_device_driver {
259   /*
260    * These are called before and after accessing renderbuffers during
261    * software rasterization.
262    *
263    * These are a suitable place for grabbing/releasing hardware locks.
264    *
265    * NOTE: The swrast triangle/line/point routines *DO NOT* call
266    * these functions.  Locking in that case must be organized by the
267    * driver by other mechanisms.
268    */
269   void (*SpanRenderStart)(GLcontext *ctx);
270   void (*SpanRenderFinish)(GLcontext *ctx);
271};
272
273
274
275#endif
276