2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
27 * \file swrast/swrast.h
28 * \brief Public interface to the software rasterization functions.
29 * \author Keith Whitwell <keith@tungstengraphics.com>
35 #include "main/mtypes.h"
39 * \brief Data-structure to handle vertices in the software rasterizer.
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
48 * wpos = attr[FRAG_ATTRIB_WPOS] and MUST BE THE FIRST values in the
49 * vertex because of the tnl clipping code.
51 * wpos[0] and [1] are the screen-coords of SWvertex.
52 * wpos[2] is the z-buffer coord (if 16-bit Z buffer, in range [0,65535]).
53 * wpos[3] is 1/w where w is the clip-space W coord. This is the value
54 * that clip{XYZ} were multiplied by to get ndc{XYZ}.
56 * Full software drivers:
57 * - Register the rastersetup and triangle functions from
58 * utils/software_helper.
59 * - On statechange, update the rasterization pointers in that module.
61 * Rasterization hardware drivers:
62 * - Keep native rastersetup.
63 * - Implement native twoside,offset and unfilled triangle setup.
64 * - Implement a translator from native vertices to swrast vertices.
65 * - On partial fallback (mix of accelerated and unaccelerated
66 * prims), call a pass-through function which translates native
67 * vertices to SWvertices and calls the appropriate swrast function.
68 * - On total fallback (vertex format insufficient for state or all
69 * primitives unaccelerated), hook in swrast_setup instead.
72 GLfloat attrib[FRAG_ATTRIB_MAX][4];
73 GLchan color[4]; /** integer color */
78 #define FRAG_ATTRIB_CI FRAG_ATTRIB_COL0
81 struct swrast_device_driver;
84 /* These are the public-access functions exported from swrast.
88 _swrast_CreateContext( struct gl_context *ctx );
91 _swrast_DestroyContext( struct gl_context *ctx );
93 /* Get a (non-const) reference to the device driver struct for swrast.
95 extern struct swrast_device_driver *
96 _swrast_GetDeviceDriverReference( struct gl_context *ctx );
99 _swrast_Bitmap( struct gl_context *ctx,
101 GLsizei width, GLsizei height,
102 const struct gl_pixelstore_attrib *unpack,
103 const GLubyte *bitmap );
106 _swrast_CopyPixels( struct gl_context *ctx,
107 GLint srcx, GLint srcy,
108 GLint destx, GLint desty,
109 GLsizei width, GLsizei height,
113 _swrast_DrawPixels( struct gl_context *ctx,
115 GLsizei width, GLsizei height,
116 GLenum format, GLenum type,
117 const struct gl_pixelstore_attrib *unpack,
118 const GLvoid *pixels );
121 _swrast_ReadPixels( struct gl_context *ctx,
122 GLint x, GLint y, GLsizei width, GLsizei height,
123 GLenum format, GLenum type,
124 const struct gl_pixelstore_attrib *unpack,
128 _swrast_BlitFramebuffer(struct gl_context *ctx,
129 GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
130 GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
131 GLbitfield mask, GLenum filter);
134 _swrast_Clear(struct gl_context *ctx, GLbitfield buffers);
137 _swrast_Accum(struct gl_context *ctx, GLenum op, GLfloat value);
141 /* Reset the stipple counter
144 _swrast_ResetLineStipple( struct gl_context *ctx );
147 * Indicates front/back facing for subsequent points/lines when drawing
148 * unfilled polygons. Needed for two-side stencil.
151 _swrast_SetFacing(struct gl_context *ctx, GLuint facing);
153 /* These will always render the correct point/line/triangle for the
156 * For flatshaded primitives, the provoking vertex is the final one.
159 _swrast_Point( struct gl_context *ctx, const SWvertex *v );
162 _swrast_Line( struct gl_context *ctx, const SWvertex *v0, const SWvertex *v1 );
165 _swrast_Triangle( struct gl_context *ctx, const SWvertex *v0,
166 const SWvertex *v1, const SWvertex *v2 );
169 _swrast_Quad( struct gl_context *ctx,
170 const SWvertex *v0, const SWvertex *v1,
171 const SWvertex *v2, const SWvertex *v3);
174 _swrast_flush( struct gl_context *ctx );
177 _swrast_render_primitive( struct gl_context *ctx, GLenum mode );
180 _swrast_render_start( struct gl_context *ctx );
183 _swrast_render_finish( struct gl_context *ctx );
185 /* Tell the software rasterizer about core state changes.
188 _swrast_InvalidateState( struct gl_context *ctx, GLbitfield new_state );
190 /* Configure software rasterizer to match hardware rasterizer characteristics:
193 _swrast_allow_vertex_fog( struct gl_context *ctx, GLboolean value );
196 _swrast_allow_pixel_fog( struct gl_context *ctx, GLboolean value );
201 _swrast_print_vertex( struct gl_context *ctx, const SWvertex *v );
206 _swrast_eject_texture_images(struct gl_context *ctx);
210 _swrast_render_texture(struct gl_context *ctx,
211 struct gl_framebuffer *fb,
212 struct gl_renderbuffer_attachment *att);
215 _swrast_finish_render_texture(struct gl_context *ctx,
216 struct gl_renderbuffer_attachment *att);
221 * The driver interface for the software rasterizer.
222 * XXX this may go away.
223 * We may move these functions to ctx->Driver.RenderStart, RenderEnd.
225 struct swrast_device_driver {
227 * These are called before and after accessing renderbuffers during
228 * software rasterization.
230 * These are a suitable place for grabbing/releasing hardware locks.
232 * NOTE: The swrast triangle/line/point routines *DO NOT* call
233 * these functions. Locking in that case must be organized by the
234 * driver by other mechanisms.
236 void (*SpanRenderStart)(struct gl_context *ctx);
237 void (*SpanRenderFinish)(struct gl_context *ctx);