2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2005 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>
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 * 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.
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.
64 /** win[0], win[1] are the screen-coords of SWvertex. win[2] is the
65 * z-coord. what is win[3]? */
67 GLfloat texcoord
[MAX_TEXTURE_COORD_UNITS
][4];
76 struct swrast_device_driver
;
79 /* These are the public-access functions exported from swrast.
82 _swrast_use_read_buffer( GLcontext
*ctx
);
85 _swrast_use_draw_buffer( GLcontext
*ctx
);
88 _swrast_CreateContext( GLcontext
*ctx
);
91 _swrast_DestroyContext( GLcontext
*ctx
);
93 /* Get a (non-const) reference to the device driver struct for swrast.
95 extern struct swrast_device_driver
*
96 _swrast_GetDeviceDriverReference( GLcontext
*ctx
);
99 _swrast_Bitmap( GLcontext
*ctx
,
101 GLsizei width
, GLsizei height
,
102 const struct gl_pixelstore_attrib
*unpack
,
103 const GLubyte
*bitmap
);
106 _swrast_CopyPixels( GLcontext
*ctx
,
107 GLint srcx
, GLint srcy
,
108 GLint destx
, GLint desty
,
109 GLsizei width
, GLsizei height
,
113 _swrast_DrawPixels( GLcontext
*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( GLcontext
*ctx
,
122 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
123 GLenum format
, GLenum type
,
124 const struct gl_pixelstore_attrib
*unpack
,
128 _swrast_Clear( GLcontext
*ctx
, GLbitfield mask
, GLboolean all
,
129 GLint x
, GLint y
, GLint width
, GLint height
);
132 _swrast_Accum( GLcontext
*ctx
, GLenum op
,
133 GLfloat value
, GLint xpos
, GLint ypos
,
134 GLint width
, GLint height
);
138 _swrast_DrawBuffer( GLcontext
*ctx
, GLenum mode
);
142 _swrast_DrawBuffers( GLcontext
*ctx
, GLsizei n
, const GLenum
*buffers
);
145 /* Reset the stipple counter
148 _swrast_ResetLineStipple( GLcontext
*ctx
);
150 /* These will always render the correct point/line/triangle for the
153 * For flatshaded primitives, the provoking vertex is the final one.
156 _swrast_Point( GLcontext
*ctx
, const SWvertex
*v
);
159 _swrast_Line( GLcontext
*ctx
, const SWvertex
*v0
, const SWvertex
*v1
);
162 _swrast_Triangle( GLcontext
*ctx
, const SWvertex
*v0
,
163 const SWvertex
*v1
, const SWvertex
*v2
);
166 _swrast_Quad( GLcontext
*ctx
,
167 const SWvertex
*v0
, const SWvertex
*v1
,
168 const SWvertex
*v2
, const SWvertex
*v3
);
171 _swrast_flush( GLcontext
*ctx
);
174 _swrast_render_primitive( GLcontext
*ctx
, GLenum mode
);
177 _swrast_render_start( GLcontext
*ctx
);
180 _swrast_render_finish( GLcontext
*ctx
);
182 /* Tell the software rasterizer about core state changes.
185 _swrast_InvalidateState( GLcontext
*ctx
, GLuint new_state
);
187 /* Configure software rasterizer to match hardware rasterizer characteristics:
190 _swrast_allow_vertex_fog( GLcontext
*ctx
, GLboolean value
);
193 _swrast_allow_pixel_fog( GLcontext
*ctx
, GLboolean value
);
198 _swrast_print_vertex( GLcontext
*ctx
, const SWvertex
*v
);
202 * Imaging fallbacks (a better solution should be found, perhaps
203 * moving all the imaging fallback code to a new module)
206 _swrast_CopyConvolutionFilter2D(GLcontext
*ctx
, GLenum target
,
207 GLenum internalFormat
,
208 GLint x
, GLint y
, GLsizei width
,
211 _swrast_CopyConvolutionFilter1D(GLcontext
*ctx
, GLenum target
,
212 GLenum internalFormat
,
213 GLint x
, GLint y
, GLsizei width
);
215 _swrast_CopyColorSubTable( GLcontext
*ctx
,GLenum target
, GLsizei start
,
216 GLint x
, GLint y
, GLsizei width
);
218 _swrast_CopyColorTable( GLcontext
*ctx
,
219 GLenum target
, GLenum internalformat
,
220 GLint x
, GLint y
, GLsizei width
);
224 * Texture fallbacks. Could also live in a new module
225 * with the rest of the texture store fallbacks?
228 _swrast_copy_teximage1d(GLcontext
*ctx
, GLenum target
, GLint level
,
229 GLenum internalFormat
,
230 GLint x
, GLint y
, GLsizei width
, GLint border
);
233 _swrast_copy_teximage2d(GLcontext
*ctx
, GLenum target
, GLint level
,
234 GLenum internalFormat
,
235 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
240 _swrast_copy_texsubimage1d(GLcontext
*ctx
, GLenum target
, GLint level
,
241 GLint xoffset
, GLint x
, GLint y
, GLsizei width
);
244 _swrast_copy_texsubimage2d(GLcontext
*ctx
,
245 GLenum target
, GLint level
,
246 GLint xoffset
, GLint yoffset
,
247 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
250 _swrast_copy_texsubimage3d(GLcontext
*ctx
,
251 GLenum target
, GLint level
,
252 GLint xoffset
, GLint yoffset
, GLint zoffset
,
253 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
256 /* The driver interface for the software rasterizer.
257 * Unless otherwise noted, all functions are mandatory.
259 struct swrast_device_driver
{
260 #if OLD_RENDERBUFFER || NEW_RENDERBUFFER
261 void (*SetBuffer
)(GLcontext
*ctx
, GLframebuffer
*buffer
, GLuint bufferBit
);
263 * Specifies the current color buffer for span/pixel writing/reading.
264 * buffer indicates which window to write to / read from. Normally,
265 * this'll be the buffer currently bound to the context, but it doesn't
267 * bufferBit indicates which color buffer, exactly one of:
268 * DD_FRONT_LEFT_BIT - this buffer always exists
269 * DD_BACK_LEFT_BIT - when double buffering
270 * DD_FRONT_RIGHT_BIT - when using stereo
271 * DD_BACK_RIGHT_BIT - when using stereo and double buffering
272 * DD_AUXn_BIT - if aux buffers are implemented
277 *** Functions for synchronizing access to the framebuffer:
280 void (*SpanRenderStart
)(GLcontext
*ctx
);
281 void (*SpanRenderFinish
)(GLcontext
*ctx
);
284 * Called before and after all rendering operations, including DrawPixels,
285 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
286 * These are a suitable place for grabbing/releasing hardware locks.
288 * NOTE: The swrast triangle/line/point routines *DO NOT* call
289 * these functions. Locking in that case must be organized by the
290 * driver by other mechanisms.