dd.h revision 5c1e7fa6ee72f4403d9ec9d12830dd689b966e71
1/* $Id: dd.h,v 1.49 2001/01/29 20:47:39 keithw Exp $ */ 2 3/* 4 * Mesa 3-D graphics library 5 * Version: 3.5 6 * 7 * Copyright (C) 1999-2000 Brian Paul All Rights Reserved. 8 * 9 * Permission is hereby granted, free of charge, to any person obtaining a 10 * copy of this software and associated documentation files (the "Software"), 11 * to deal in the Software without restriction, including without limitation 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 13 * and/or sell copies of the Software, and to permit persons to whom the 14 * Software is furnished to do so, subject to the following conditions: 15 * 16 * The above copyright notice and this permission notice shall be included 17 * in all copies or substantial portions of the Software. 18 * 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 22 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN 23 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 24 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 */ 26 27 28 29#ifndef DD_INCLUDED 30#define DD_INCLUDED 31 32/* THIS FILE ONLY INCLUDED BY mtypes.h !!!!! */ 33 34struct gl_pixelstore_attrib; 35 36 37/* 38 * Device Driver (DD) interface 39 * 40 * 41 * All device driver functions are accessed through pointers in the 42 * dd_function_table struct (defined below) which is stored in the GLcontext 43 * struct. Since the device driver is strictly accessed trough a table of 44 * function pointers we can: 45 * 1. switch between a number of different device drivers at runtime. 46 * 2. use optimized functions dependant on current rendering state or 47 * frame buffer configuration. 48 * 49 * The function pointers in the dd_function_table struct are divided into 50 * two groups: mandatory and optional. 51 * Mandatory functions have to be implemented by every device driver. 52 * Optional functions may or may not be implemented by the device driver. 53 * The optional functions provide ways to take advantage of special hardware 54 * or optimized algorithms. 55 * 56 * The function pointers in the dd_function_table struct should first be 57 * initialized in the driver's "MakeCurrent" function. The "MakeCurrent" 58 * function is a little different in each device driver. See the X/Mesa, 59 * GLX, or OS/Mesa drivers for examples. 60 * 61 * Later, Mesa may call the dd_function_table's UpdateState() function. 62 * This function should initialize the dd_function_table's pointers again. 63 * The UpdateState() function is called whenever the core (GL) rendering 64 * state is changed in a way which may effect rasterization. For example, 65 * the TriangleFunc() pointer may have to point to different functions 66 * depending on whether smooth or flat shading is enabled. 67 * 68 * Note that the first argument to every device driver function is a 69 * GLcontext *. In turn, the GLcontext->DriverCtx pointer points to 70 * the driver-specific context struct. See the X/Mesa or OS/Mesa interface 71 * for an example. 72 * 73 * For more information about writing a device driver see the ddsample.c 74 * file and other device drivers (X/xmesa[1234].c, OSMesa/osmesa.c, etc) 75 * for examples. 76 * 77 * 78 * Look below in the dd_function_table struct definition for descriptions 79 * of each device driver function. 80 * 81 * 82 * In the future more function pointers may be added for glReadPixels 83 * glCopyPixels, etc. 84 * 85 * 86 * Notes: 87 * ------ 88 * RGBA = red/green/blue/alpha 89 * CI = color index (color mapped mode) 90 * mono = all pixels have the same color or index 91 * 92 * The write_ functions all take an array of mask flags which indicate 93 * whether or not the pixel should be written. One special case exists 94 * in the write_color_span function: if the mask array is NULL, then 95 * draw all pixels. This is an optimization used for glDrawPixels(). 96 * 97 * IN ALL CASES: 98 * X coordinates start at 0 at the left and increase to the right 99 * Y coordinates start at 0 at the bottom and increase upward 100 * 101 */ 102 103 104 105 106 107 108/* Mask bits sent to the driver Clear() function */ 109#define DD_FRONT_LEFT_BIT FRONT_LEFT_BIT /* 1 */ 110#define DD_FRONT_RIGHT_BIT FRONT_RIGHT_BIT /* 2 */ 111#define DD_BACK_LEFT_BIT BACK_LEFT_BIT /* 4 */ 112#define DD_BACK_RIGHT_BIT BACK_RIGHT_BIT /* 8 */ 113#define DD_DEPTH_BIT GL_DEPTH_BUFFER_BIT /* 0x00000100 */ 114#define DD_STENCIL_BIT GL_STENCIL_BUFFER_BIT /* 0x00000400 */ 115#define DD_ACCUM_BIT GL_ACCUM_BUFFER_BIT /* 0x00000200 */ 116 117 118 119 120 121 122 123/* Point, line, triangle, quadrilateral and rectangle rasterizer 124 * functions. These are specific to the tnl module and will shortly 125 * move to a driver interface specific to that module. 126 */ 127typedef void (*points_func)( GLcontext *ctx, GLuint first, GLuint last ); 128 129typedef void (*line_func)( GLcontext *ctx, GLuint v1, GLuint v2 ); 130 131typedef void (*triangle_func)( GLcontext *ctx, 132 GLuint v1, GLuint v2, GLuint v3 ); 133 134typedef void (*quad_func)( GLcontext *ctx, GLuint v1, GLuint v2, 135 GLuint v3, GLuint v4 ); 136 137typedef void (*render_func)( GLcontext *ctx, GLuint start, GLuint count, 138 GLuint flags ); 139 140typedef void (*interp_func)( GLcontext *ctx, 141 GLfloat t, GLuint dst, GLuint in, GLuint out, 142 GLboolean force_boundary ); 143 144typedef void (*copy_pv_func)( GLcontext *ctx, GLuint dst, GLuint src ); 145 146 147/* 148 * Device Driver function table. 149 */ 150struct dd_function_table { 151 152 /********************************************************************** 153 *** Mandatory functions: these functions must be implemented by *** 154 *** every device driver. *** 155 **********************************************************************/ 156 157 const GLubyte * (*GetString)( GLcontext *ctx, GLenum name ); 158 /* Return a string as needed by glGetString(). 159 * Only the GL_RENDERER token must be implemented. Otherwise, 160 * NULL can be returned. 161 */ 162 163 void (*UpdateState)( GLcontext *ctx, GLuint new_state ); 164 /* 165 * UpdateState() is called whenver Mesa thinks the device driver should 166 * update its state and/or the other pointers (such as PointsFunc, 167 * LineFunc, or TriangleFunc). 168 */ 169 170 void (*Clear)( GLcontext *ctx, GLbitfield mask, GLboolean all, 171 GLint x, GLint y, GLint width, GLint height ); 172 /* Clear the color/depth/stencil/accum buffer(s). 173 * 'mask' is a bitmask of the DD_*_BIT values defined above that indicates 174 * which buffers need to be cleared. 175 * If 'all' is true then the clear the whole buffer, else clear only the 176 * region defined by (x,y,width,height). 177 * This function must obey the glColorMask, glIndexMask and glStencilMask 178 * settings! Software Mesa can do masked clears if the device driver can't. 179 */ 180 181 GLboolean (*SetDrawBuffer)( GLcontext *ctx, GLenum buffer ); 182 /* 183 * Specifies the current buffer for writing. 184 * The following values must be accepted when applicable: 185 * GL_FRONT_LEFT - this buffer always exists 186 * GL_BACK_LEFT - when double buffering 187 * GL_FRONT_RIGHT - when using stereo 188 * GL_BACK_RIGHT - when using stereo and double buffering 189 * The folowing values may optionally be accepted. Return GL_TRUE 190 * if accepted, GL_FALSE if not accepted. In practice, only drivers 191 * which can write to multiple color buffers at once should accept 192 * these values. 193 * GL_FRONT - write to front left and front right if it exists 194 * GL_BACK - write to back left and back right if it exists 195 * GL_LEFT - write to front left and back left if it exists 196 * GL_RIGHT - write to right left and back right if they exist 197 * GL_FRONT_AND_BACK - write to all four buffers if they exist 198 * GL_NONE - disable buffer write in device driver. 199 */ 200 201 void (*SetReadBuffer)( GLcontext *ctx, GLframebuffer *colorBuffer, 202 GLenum buffer ); 203 /* 204 * Specifies the current buffer for reading. 205 * colorBuffer will be one of: 206 * GL_FRONT_LEFT - this buffer always exists 207 * GL_BACK_LEFT - when double buffering 208 * GL_FRONT_RIGHT - when using stereo 209 * GL_BACK_RIGHT - when using stereo and double buffering 210 */ 211 212 void (*GetBufferSize)( GLcontext *ctx, GLuint *width, GLuint *height ); 213 /* 214 * Returns the width and height of the current color buffer. 215 */ 216 217 218 /*** 219 *** Functions for writing pixels to the frame buffer: 220 ***/ 221 222 void (*WriteRGBASpan)( const GLcontext *ctx, 223 GLuint n, GLint x, GLint y, 224 CONST GLchan rgba[][4], const GLubyte mask[] ); 225 void (*WriteRGBSpan)( const GLcontext *ctx, 226 GLuint n, GLint x, GLint y, 227 CONST GLchan rgb[][3], const GLubyte mask[] ); 228 /* Write a horizontal run of RGBA or RGB pixels. 229 * If mask is NULL, draw all pixels. 230 * If mask is not null, only draw pixel [i] when mask [i] is true. 231 */ 232 233 void (*WriteMonoRGBASpan)( const GLcontext *ctx, GLuint n, GLint x, GLint y, 234 const GLchan color[4], const GLubyte mask[] ); 235 /* Write a horizontal run of RGBA pixels all with the same color. 236 */ 237 238 void (*WriteRGBAPixels)( const GLcontext *ctx, 239 GLuint n, const GLint x[], const GLint y[], 240 CONST GLchan rgba[][4], const GLubyte mask[] ); 241 /* Write array of RGBA pixels at random locations. 242 */ 243 244 void (*WriteMonoRGBAPixels)( const GLcontext *ctx, 245 GLuint n, const GLint x[], const GLint y[], 246 const GLchan color[4], const GLubyte mask[] ); 247 /* Write an array of mono-RGBA pixels at random locations. 248 */ 249 250 void (*WriteCI32Span)( const GLcontext *ctx, GLuint n, GLint x, GLint y, 251 const GLuint index[], const GLubyte mask[] ); 252 void (*WriteCI8Span)( const GLcontext *ctx, GLuint n, GLint x, GLint y, 253 const GLubyte index[], const GLubyte mask[] ); 254 /* Write a horizontal run of CI pixels. One function is for 32bpp 255 * indexes and the other for 8bpp pixels (the common case). You mus 256 * implement both for color index mode. 257 */ 258 259 void (*WriteMonoCISpan)( const GLcontext *ctx, GLuint n, GLint x, GLint y, 260 GLuint colorIndex, const GLubyte mask[] ); 261 /* Write a horizontal run of color index pixels using the color index 262 * last specified by the Index() function. 263 */ 264 265 void (*WriteCI32Pixels)( const GLcontext *ctx, 266 GLuint n, const GLint x[], const GLint y[], 267 const GLuint index[], const GLubyte mask[] ); 268 /* 269 * Write a random array of CI pixels. 270 */ 271 272 void (*WriteMonoCIPixels)( const GLcontext *ctx, 273 GLuint n, const GLint x[], const GLint y[], 274 GLuint colorIndex, const GLubyte mask[] ); 275 /* Write a random array of color index pixels using the color index 276 * last specified by the Index() function. 277 */ 278 279 280 /*** 281 *** Functions to read pixels from frame buffer: 282 ***/ 283 284 void (*ReadCI32Span)( const GLcontext *ctx, 285 GLuint n, GLint x, GLint y, GLuint index[] ); 286 /* Read a horizontal run of color index pixels. 287 */ 288 289 void (*ReadRGBASpan)( const GLcontext *ctx, GLuint n, GLint x, GLint y, 290 GLchan rgba[][4] ); 291 /* Read a horizontal run of RGBA pixels. 292 */ 293 294 void (*ReadCI32Pixels)( const GLcontext *ctx, 295 GLuint n, const GLint x[], const GLint y[], 296 GLuint indx[], const GLubyte mask[] ); 297 /* Read a random array of CI pixels. 298 */ 299 300 void (*ReadRGBAPixels)( const GLcontext *ctx, 301 GLuint n, const GLint x[], const GLint y[], 302 GLchan rgba[][4], const GLubyte mask[] ); 303 /* Read a random array of RGBA pixels. 304 */ 305 306 307 /********************************************************************** 308 *** Optional functions: these functions may or may not be *** 309 *** implemented by the device driver. If the device driver *** 310 *** doesn't implement them it should never touch these pointers *** 311 *** since Mesa will either set them to NULL or point them at a *** 312 *** fall-back function. *** 313 **********************************************************************/ 314 315 void (*Finish)( GLcontext *ctx ); 316 /* 317 * This is called whenever glFinish() is called. 318 */ 319 320 void (*Flush)( GLcontext *ctx ); 321 /* 322 * This is called whenever glFlush() is called. 323 */ 324 325 void (*Error)( GLcontext *ctx ); 326 /* 327 * Called whenever an error is generated. ctx->ErrorValue contains 328 * the error value. 329 */ 330 331 332 /*** 333 *** For supporting hardware Z buffers: 334 *** Either ALL or NONE of these functions must be implemented! 335 *** NOTE that Each depth value is a 32-bit GLuint. If the depth 336 *** buffer is less than 32 bits deep then the extra upperbits are zero. 337 ***/ 338 339 void (*WriteDepthSpan)( GLcontext *ctx, GLuint n, GLint x, GLint y, 340 const GLdepth depth[], const GLubyte mask[] ); 341 /* Write a horizontal span of values into the depth buffer. Only write 342 * depth[i] value if mask[i] is nonzero. 343 */ 344 345 void (*ReadDepthSpan)( GLcontext *ctx, GLuint n, GLint x, GLint y, 346 GLdepth depth[] ); 347 /* Read a horizontal span of values from the depth buffer. 348 */ 349 350 351 void (*WriteDepthPixels)( GLcontext *ctx, GLuint n, 352 const GLint x[], const GLint y[], 353 const GLdepth depth[], const GLubyte mask[] ); 354 /* Write an array of randomly positioned depth values into the 355 * depth buffer. Only write depth[i] value if mask[i] is nonzero. 356 */ 357 358 void (*ReadDepthPixels)( GLcontext *ctx, GLuint n, 359 const GLint x[], const GLint y[], 360 GLdepth depth[] ); 361 /* Read an array of randomly positioned depth values from the depth buffer. 362 */ 363 364 365 366 /*** 367 *** For supporting hardware stencil buffers: 368 *** Either ALL or NONE of these functions must be implemented! 369 ***/ 370 371 void (*WriteStencilSpan)( GLcontext *ctx, GLuint n, GLint x, GLint y, 372 const GLstencil stencil[], const GLubyte mask[] ); 373 /* Write a horizontal span of stencil values into the stencil buffer. 374 * If mask is NULL, write all stencil values. 375 * Else, only write stencil[i] if mask[i] is non-zero. 376 */ 377 378 void (*ReadStencilSpan)( GLcontext *ctx, GLuint n, GLint x, GLint y, 379 GLstencil stencil[] ); 380 /* Read a horizontal span of stencil values from the stencil buffer. 381 */ 382 383 void (*WriteStencilPixels)( GLcontext *ctx, GLuint n, 384 const GLint x[], const GLint y[], 385 const GLstencil stencil[], 386 const GLubyte mask[] ); 387 /* Write an array of stencil values into the stencil buffer. 388 * If mask is NULL, write all stencil values. 389 * Else, only write stencil[i] if mask[i] is non-zero. 390 */ 391 392 void (*ReadStencilPixels)( GLcontext *ctx, GLuint n, 393 const GLint x[], const GLint y[], 394 GLstencil stencil[] ); 395 /* Read an array of stencil values from the stencil buffer. 396 */ 397 398 399 /*** 400 *** For hardware accumulation buffer: 401 ***/ 402 void (*Accum)( GLcontext *ctx, GLenum op, GLfloat value, 403 GLint xpos, GLint ypos, GLint width, GLint height ); 404 /* Execute glAccum command within the given scissor region. 405 */ 406 407 408 /*** 409 *** glDraw/Read/CopyPixels and glBitmap functions: 410 ***/ 411 412 void (*DrawPixels)( GLcontext *ctx, 413 GLint x, GLint y, GLsizei width, GLsizei height, 414 GLenum format, GLenum type, 415 const struct gl_pixelstore_attrib *unpack, 416 const GLvoid *pixels ); 417 /* This is called by glDrawPixels. 418 * 'unpack' describes how to unpack the source image data. 419 */ 420 421 void (*ReadPixels)( GLcontext *ctx, 422 GLint x, GLint y, GLsizei width, GLsizei height, 423 GLenum format, GLenum type, 424 const struct gl_pixelstore_attrib *unpack, 425 GLvoid *dest ); 426 /* Called by glReadPixels. 427 */ 428 429 void (*CopyPixels)( GLcontext *ctx, 430 GLint srcx, GLint srcy, 431 GLsizei width, GLsizei height, 432 GLint dstx, GLint dsty, GLenum type ); 433 /* Do a glCopyPixels. This function must respect all rasterization 434 * state, glPixelTransfer, glPixelZoom, etc. 435 */ 436 437 void (*Bitmap)( GLcontext *ctx, 438 GLint x, GLint y, GLsizei width, GLsizei height, 439 const struct gl_pixelstore_attrib *unpack, 440 const GLubyte *bitmap ); 441 /* This is called by glBitmap. Works the same as DrawPixels, above. 442 */ 443 444 void (*ResizeBuffersMESA)( GLcontext *ctx ); 445 446 447 /*** 448 *** Texture image functions: 449 ***/ 450 GLboolean (*TexImage1D)( GLcontext *ctx, GLenum target, GLint level, 451 GLenum format, GLenum type, const GLvoid *pixels, 452 const struct gl_pixelstore_attrib *packing, 453 struct gl_texture_object *texObj, 454 struct gl_texture_image *texImage, 455 GLboolean *retainInternalCopy ); 456 GLboolean (*TexImage2D)( GLcontext *ctx, GLenum target, GLint level, 457 GLenum format, GLenum type, const GLvoid *pixels, 458 const struct gl_pixelstore_attrib *packing, 459 struct gl_texture_object *texObj, 460 struct gl_texture_image *texImage, 461 GLboolean *retainInternalCopy ); 462 GLboolean (*TexImage3D)( GLcontext *ctx, GLenum target, GLint level, 463 GLenum format, GLenum type, const GLvoid *pixels, 464 const struct gl_pixelstore_attrib *packing, 465 struct gl_texture_object *texObj, 466 struct gl_texture_image *texImage, 467 GLboolean *retainInternalCopy ); 468 /* Called by glTexImage1/2/3D. 469 * Will not be called if any glPixelTransfer operations are enabled. 470 * Arguments: 471 * <target>, <level>, <format>, <type> and <pixels> are user specified. 472 * <packing> indicates the image packing of pixels. 473 * <texObj> is the target texture object. 474 * <texImage> is the target texture image. It will have the texture 475 * width, height, depth, border and internalFormat information. 476 * <retainInternalCopy> is returned by this function and indicates whether 477 * core Mesa should keep an internal copy of the texture image. 478 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 479 * should do the job. If GL_FALSE is returned, this function will be 480 * called a second time after the texture image has been unpacked into 481 * GLubytes. It may be easier for the driver to handle then. 482 */ 483 484 GLboolean (*TexSubImage1D)( GLcontext *ctx, GLenum target, GLint level, 485 GLint xoffset, GLsizei width, 486 GLenum format, GLenum type, 487 const GLvoid *pixels, 488 const struct gl_pixelstore_attrib *packing, 489 struct gl_texture_object *texObj, 490 struct gl_texture_image *texImage ); 491 GLboolean (*TexSubImage2D)( GLcontext *ctx, GLenum target, GLint level, 492 GLint xoffset, GLint yoffset, 493 GLsizei width, GLsizei height, 494 GLenum format, GLenum type, 495 const GLvoid *pixels, 496 const struct gl_pixelstore_attrib *packing, 497 struct gl_texture_object *texObj, 498 struct gl_texture_image *texImage ); 499 GLboolean (*TexSubImage3D)( GLcontext *ctx, GLenum target, GLint level, 500 GLint xoffset, GLint yoffset, GLint zoffset, 501 GLsizei width, GLsizei height, GLint depth, 502 GLenum format, GLenum type, 503 const GLvoid *pixels, 504 const struct gl_pixelstore_attrib *packing, 505 struct gl_texture_object *texObj, 506 struct gl_texture_image *texImage ); 507 /* Called by glTexSubImage1/2/3D. 508 * Will not be called if any glPixelTransfer operations are enabled. 509 * Arguments: 510 * <target>, <level>, <xoffset>, <yoffset>, <zoffset>, <width>, <height>, 511 * <depth>, <format>, <type> and <pixels> are user specified. 512 * <packing> indicates the image packing of pixels. 513 * <texObj> is the target texture object. 514 * <texImage> is the target texture image. It will have the texture 515 * width, height, border and internalFormat information. 516 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 517 * should do the job. If GL_FALSE is returned, then TexImage1/2/3D will 518 * be called with the complete texture image. 519 */ 520 521 GLboolean (*CopyTexImage1D)( GLcontext *ctx, GLenum target, GLint level, 522 GLenum internalFormat, GLint x, GLint y, 523 GLsizei width, GLint border ); 524 GLboolean (*CopyTexImage2D)( GLcontext *ctx, GLenum target, GLint level, 525 GLenum internalFormat, GLint x, GLint y, 526 GLsizei width, GLsizei height, GLint border ); 527 /* Called by glCopyTexImage1D and glCopyTexImage2D. 528 * Will not be called if any glPixelTransfer operations are enabled. 529 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 530 * should do the job. 531 */ 532 533 GLboolean (*CopyTexSubImage1D)( GLcontext *ctx, GLenum target, GLint level, 534 GLint xoffset, 535 GLint x, GLint y, GLsizei width ); 536 GLboolean (*CopyTexSubImage2D)( GLcontext *ctx, GLenum target, GLint level, 537 GLint xoffset, GLint yoffset, 538 GLint x, GLint y, 539 GLsizei width, GLsizei height ); 540 GLboolean (*CopyTexSubImage3D)( GLcontext *ctx, GLenum target, GLint level, 541 GLint xoffset, GLint yoffset, GLint zoffset, 542 GLint x, GLint y, 543 GLsizei width, GLsizei height ); 544 /* Called by glCopyTexSubImage1/2/3D. 545 * Will not be called if any glPixelTransfer operations are enabled. 546 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 547 * should do the job. 548 */ 549 550 GLvoid *(*GetTexImage)( GLcontext *ctx, GLenum target, GLint level, 551 const struct gl_texture_object *texObj, 552 GLenum *formatOut, GLenum *typeOut, 553 GLboolean *freeImageOut ); 554 /* Called by glGetTexImage or by core Mesa when a texture image 555 * is needed for software fallback rendering. 556 * Return the address of the texture image or NULL if failure. 557 * The image must be tightly packed (i.e. row stride = image width) 558 * Return the image's format and type in formatOut and typeOut. 559 * The format and type must be values which are accepted by glTexImage. 560 * Set the freeImageOut flag if the returned image should be deallocated 561 * with FREE() when finished. 562 * The size of the image can be deduced from the target and level. 563 * Core Mesa will perform any image format/type conversions that are needed. 564 */ 565 566 GLboolean (*TestProxyTexImage)(GLcontext *ctx, GLenum target, 567 GLint level, GLint internalFormat, 568 GLenum format, GLenum type, 569 GLint width, GLint height, 570 GLint depth, GLint border); 571 /* Called by glTexImage[123]D when user specifies a proxy texture 572 * target. Return GL_TRUE if the proxy test passes, return GL_FALSE 573 * if the test fails. 574 */ 575 576 /*** 577 *** Compressed texture functions: 578 ***/ 579 580 GLboolean (*CompressedTexImage1D)( GLcontext *ctx, GLenum target, 581 GLint level, GLsizei imageSize, 582 const GLvoid *data, 583 struct gl_texture_object *texObj, 584 struct gl_texture_image *texImage, 585 GLboolean *retainInternalCopy); 586 GLboolean (*CompressedTexImage2D)( GLcontext *ctx, GLenum target, 587 GLint level, GLsizei imageSize, 588 const GLvoid *data, 589 struct gl_texture_object *texObj, 590 struct gl_texture_image *texImage, 591 GLboolean *retainInternalCopy); 592 GLboolean (*CompressedTexImage3D)( GLcontext *ctx, GLenum target, 593 GLint level, GLsizei imageSize, 594 const GLvoid *data, 595 struct gl_texture_object *texObj, 596 struct gl_texture_image *texImage, 597 GLboolean *retainInternalCopy); 598 /* Called by glCompressedTexImage1/2/3D. 599 * Arguments: 600 * <target>, <level>, <internalFormat>, <data> are user specified. 601 * <texObj> is the target texture object. 602 * <texImage> is the target texture image. It will have the texture 603 * width, height, depth, border and internalFormat information. 604 * <retainInternalCopy> is returned by this function and indicates whether 605 * core Mesa should keep an internal copy of the texture image. 606 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 607 * should do the job. 608 */ 609 610 GLboolean (*CompressedTexSubImage1D)( GLcontext *ctx, GLenum target, 611 GLint level, GLint xoffset, 612 GLsizei width, GLenum format, 613 GLsizei imageSize, const GLvoid *data, 614 struct gl_texture_object *texObj, 615 struct gl_texture_image *texImage ); 616 GLboolean (*CompressedTexSubImage2D)( GLcontext *ctx, GLenum target, 617 GLint level, GLint xoffset, 618 GLint yoffset, GLsizei width, 619 GLint height, GLenum format, 620 GLsizei imageSize, const GLvoid *data, 621 struct gl_texture_object *texObj, 622 struct gl_texture_image *texImage ); 623 GLboolean (*CompressedTexSubImage3D)( GLcontext *ctx, GLenum target, 624 GLint level, GLint xoffset, 625 GLint yoffset, GLint zoffset, 626 GLsizei width, GLint height, 627 GLint depth, GLenum format, 628 GLsizei imageSize, const GLvoid *data, 629 struct gl_texture_object *texObj, 630 struct gl_texture_image *texImage ); 631 /* Called by glCompressedTexSubImage1/2/3D. 632 * Arguments: 633 * <target>, <level>, <x/z/zoffset>, <width>, <height>, <depth>, 634 * <imageSize>, and <data> are user specified. 635 * <texObj> is the target texture object. 636 * <texImage> is the target texture image. It will have the texture 637 * width, height, depth, border and internalFormat information. 638 * Return GL_TRUE if operation completed, return GL_FALSE if core Mesa 639 * should do the job. 640 */ 641 642 GLint (*BaseCompressedTexFormat)(GLcontext *ctx, 643 GLint internalFormat); 644 /* Called to compute the base format for a specific compressed 645 * format. Return -1 if the internalFormat is not a specific 646 * compressed format that the driver recognizes. Note the 647 * return value differences between this function and 648 * SpecificCompressedTexFormat below. 649 */ 650 651 GLint (*SpecificCompressedTexFormat)(GLcontext *ctx, 652 GLint internalFormat, 653 GLint numDimensions, 654 GLint *levelp, 655 GLsizei *widthp, 656 GLsizei *heightp, 657 GLsizei *depthp, 658 GLint *borderp, 659 GLenum *formatp, 660 GLenum *typep); 661 /* Called to turn a generic texture format into a specific 662 * texture format. For example, if a driver implements 663 * GL_3DFX_texture_compression_FXT1, this would map 664 * GL_COMPRESSED_RGBA_ARB to GL_COMPRESSED_RGBA_FXT1_3DFX. 665 * 666 * If the driver does not know how to handle the compressed 667 * format, then just return the generic format, and Mesa will 668 * do the right thing with it. 669 */ 670 671 GLboolean (*IsCompressedFormat)(GLcontext *ctx, GLint internalFormat); 672 /* Called to tell if a format is a compressed format. 673 */ 674 675 GLsizei (*CompressedImageSize)(GLcontext *ctx, 676 GLenum internalFormat, 677 GLuint numDimensions, 678 GLuint width, 679 GLuint height, 680 GLuint depth); 681 /* Calculate the size of a compressed image, given the image's 682 * format and dimensions. 683 */ 684 685 void (*GetCompressedTexImage)( GLcontext *ctx, GLenum target, 686 GLint lod, void *image, 687 const struct gl_texture_object *texObj, 688 struct gl_texture_image *texImage ); 689 /* Called by glGetCompressedTexImageARB. 690 * <target>, <lod>, <image> are specified by user. 691 * <texObj> is the source texture object. 692 * <texImage> is the source texture image. 693 */ 694 695 /*** 696 *** Texture object functions: 697 ***/ 698 699 void (*BindTexture)( GLcontext *ctx, GLenum target, 700 struct gl_texture_object *tObj ); 701 /* Called by glBindTexture(). 702 */ 703 704 void (*CreateTexture)( GLcontext *ctx, struct gl_texture_object *tObj ); 705 /* Called when a texture object is created. 706 */ 707 708 void (*DeleteTexture)( GLcontext *ctx, struct gl_texture_object *tObj ); 709 /* Called when a texture object is about to be deallocated. Driver 710 * should free anything attached to the DriverData pointers. 711 */ 712 713 GLboolean (*IsTextureResident)( GLcontext *ctx, 714 struct gl_texture_object *t ); 715 /* Called by glAreTextureResident(). 716 */ 717 718 void (*PrioritizeTexture)( GLcontext *ctx, struct gl_texture_object *t, 719 GLclampf priority ); 720 /* Called by glPrioritizeTextures(). 721 */ 722 723 void (*ActiveTexture)( GLcontext *ctx, GLuint texUnitNumber ); 724 /* Called by glActiveTextureARB to set current texture unit. 725 */ 726 727 void (*UpdateTexturePalette)( GLcontext *ctx, 728 struct gl_texture_object *tObj ); 729 /* Called when the texture's color lookup table is changed. 730 * If tObj is NULL then the shared texture palette ctx->Texture.Palette 731 * is to be updated. 732 */ 733 734 735 /*** 736 *** State-changing functions (drawing functions are above) 737 *** 738 *** These functions are called by their corresponding OpenGL API functions. 739 *** They're ALSO called by the gl_PopAttrib() function!!! 740 *** May add more functions like these to the device driver in the future. 741 ***/ 742 void (*AlphaFunc)(GLcontext *ctx, GLenum func, GLclampf ref); 743 void (*BlendEquation)(GLcontext *ctx, GLenum mode); 744 void (*BlendFunc)(GLcontext *ctx, GLenum sfactor, GLenum dfactor); 745 void (*BlendFuncSeparate)(GLcontext *ctx, 746 GLenum sfactorRGB, GLenum dfactorRGB, 747 GLenum sfactorA, GLenum dfactorA); 748 void (*ClearColor)(GLcontext *ctx, const GLchan color[4]); 749 void (*ClearDepth)(GLcontext *ctx, GLclampd d); 750 void (*ClearIndex)(GLcontext *ctx, GLuint index); 751 void (*ClearStencil)(GLcontext *ctx, GLint s); 752 void (*ColorMask)(GLcontext *ctx, GLboolean rmask, GLboolean gmask, 753 GLboolean bmask, GLboolean amask ); 754 void (*CullFace)(GLcontext *ctx, GLenum mode); 755 void (*ClipPlane)(GLcontext *ctx, GLenum plane, const GLfloat *equation ); 756 void (*FrontFace)(GLcontext *ctx, GLenum mode); 757 void (*DepthFunc)(GLcontext *ctx, GLenum func); 758 void (*DepthMask)(GLcontext *ctx, GLboolean flag); 759 void (*DepthRange)(GLcontext *ctx, GLclampd nearval, GLclampd farval); 760 void (*Enable)(GLcontext* ctx, GLenum cap, GLboolean state); 761 void (*Fogfv)(GLcontext *ctx, GLenum pname, const GLfloat *params); 762 void (*Hint)(GLcontext *ctx, GLenum target, GLenum mode); 763 void (*IndexMask)(GLcontext *ctx, GLuint mask); 764 void (*Lightfv)(GLcontext *ctx, GLenum light, 765 GLenum pname, const GLfloat *params ); 766 void (*LightModelfv)(GLcontext *ctx, GLenum pname, const GLfloat *params); 767 void (*LineStipple)(GLcontext *ctx, GLint factor, GLushort pattern ); 768 void (*LineWidth)(GLcontext *ctx, GLfloat width); 769 void (*LogicOpcode)(GLcontext *ctx, GLenum opcode); 770 void (*PointParameterfv)(GLcontext *ctx, GLenum pname, 771 const GLfloat *params); 772 void (*PointSize)(GLcontext *ctx, GLfloat size); 773 void (*PolygonMode)(GLcontext *ctx, GLenum face, GLenum mode); 774 void (*PolygonStipple)(GLcontext *ctx, const GLubyte *mask ); 775 void (*RenderMode)(GLcontext *ctx, GLenum mode ); 776 void (*Scissor)(GLcontext *ctx, GLint x, GLint y, GLsizei w, GLsizei h); 777 void (*ShadeModel)(GLcontext *ctx, GLenum mode); 778 void (*StencilFunc)(GLcontext *ctx, GLenum func, GLint ref, GLuint mask); 779 void (*StencilMask)(GLcontext *ctx, GLuint mask); 780 void (*StencilOp)(GLcontext *ctx, GLenum fail, GLenum zfail, GLenum zpass); 781 void (*TexGen)(GLcontext *ctx, GLenum coord, GLenum pname, 782 const GLfloat *params); 783 void (*TexEnv)(GLcontext *ctx, GLenum target, GLenum pname, 784 const GLfloat *param); 785 void (*TexParameter)(GLcontext *ctx, GLenum target, 786 struct gl_texture_object *texObj, 787 GLenum pname, const GLfloat *params); 788 void (*TextureMatrix)(GLcontext *ctx, GLuint unit, const GLmatrix *mat); 789 void (*Viewport)(GLcontext *ctx, GLint x, GLint y, GLsizei w, GLsizei h); 790 791 792 /*** State-query functions 793 *** 794 *** Return GL_TRUE if query was completed, GL_FALSE otherwise. 795 ***/ 796 GLboolean (*GetBooleanv)(GLcontext *ctx, GLenum pname, GLboolean *result); 797 GLboolean (*GetDoublev)(GLcontext *ctx, GLenum pname, GLdouble *result); 798 GLboolean (*GetFloatv)(GLcontext *ctx, GLenum pname, GLfloat *result); 799 GLboolean (*GetIntegerv)(GLcontext *ctx, GLenum pname, GLint *result); 800 GLboolean (*GetPointerv)(GLcontext *ctx, GLenum pname, GLvoid **result); 801 802 803 /*** 804 *** Vertex array functions 805 *** 806 *** Called by the corresponding OpenGL functions. 807 ***/ 808 void (*VertexPointer)(GLcontext *ctx, GLint size, GLenum type, 809 GLsizei stride, const GLvoid *ptr); 810 void (*NormalPointer)(GLcontext *ctx, GLenum type, 811 GLsizei stride, const GLvoid *ptr); 812 void (*ColorPointer)(GLcontext *ctx, GLint size, GLenum type, 813 GLsizei stride, const GLvoid *ptr); 814 void (*FogCoordPointer)(GLcontext *ctx, GLenum type, 815 GLsizei stride, const GLvoid *ptr); 816 void (*IndexPointer)(GLcontext *ctx, GLenum type, 817 GLsizei stride, const GLvoid *ptr); 818 void (*SecondaryColorPointer)(GLcontext *ctx, GLint size, GLenum type, 819 GLsizei stride, const GLvoid *ptr); 820 void (*TexCoordPointer)(GLcontext *ctx, GLint size, GLenum type, 821 GLsizei stride, const GLvoid *ptr); 822 void (*EdgeFlagPointer)(GLcontext *ctx, GLsizei stride, const GLvoid *ptr); 823 824 825 826 /*** 827 *** Rendering 828 ***/ 829 830 void (*RenderStart)(GLcontext *ctx); 831 void (*RenderFinish)(GLcontext *ctx); 832 /* Called before and after all rendering operations, including DrawPixels, 833 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands. 834 * These are a suitable place for grabbing/releasing hardware locks. 835 */ 836 837 void (*RenderPrimitive)(GLcontext *ctx, GLenum mode); 838 /* Called between RednerStart() and RenderFinish() to indicate the 839 * type of primitive we're about to draw. Mode will be one of the 840 * modes accepted by glBegin(). 841 */ 842 843 interp_func RenderInterp; 844 copy_pv_func RenderCopyPV; 845 void (*RenderClippedPolygon)( GLcontext *ctx, const GLuint *elts, GLuint n ); 846 void (*RenderClippedLine)( GLcontext *ctx, GLuint v0, GLuint v1 ); 847 /* Functions to interpolate between prebuilt vertices, copy flat-shade 848 * provoking color, and to render clipped primitives. 849 */ 850 851 /*** 852 *** Parameters for _tnl_render_stage 853 ***/ 854 points_func PointsFunc; /* must now respect vb->elts */ 855 line_func LineFunc; 856 triangle_func TriangleFunc; 857 quad_func QuadFunc; 858 /* These functions are called in order to render points, lines, 859 * triangles and quads. These are only called via the T&L module. 860 */ 861 862 render_func *RenderTabVerts; 863 render_func *RenderTabElts; 864 /* XXX Description??? 865 */ 866 867 void (*ResetLineStipple)( GLcontext *ctx ); 868 /* Reset the hardware's line stipple counter. 869 */ 870 871 void (*BuildProjectedVertices)( GLcontext *ctx, 872 GLuint start, GLuint end, 873 GLuint new_inputs); 874 /* This function is called whenever new vertices are required for 875 * rendering. The vertices in question are those n such that start 876 * <= n < end. The new_inputs parameter indicates those fields of 877 * the vertex which need to be updated, if only a partial repair of 878 * the vertex is required. 879 * 880 * This function is called only from _tnl_render_stage in tnl/t_render.c. 881 */ 882 883 884 GLboolean (*MultipassFunc)( GLcontext *ctx, GLuint passno ); 885 /* Driver may request additional render passes by returning GL_TRUE 886 * when this function is called. This function will be called 887 * after the first pass, and passes will be made until the function 888 * returns GL_FALSE. If no function is registered, only one pass 889 * is made. 890 * 891 * This function will be first invoked with passno == 1. 892 */ 893 894 895 /*** 896 *** Support for multiple t&l engines 897 ***/ 898#define PRIM_OUTSIDE_BEGIN_END GL_POLYGON+1 899#define PRIM_INSIDE_UNKNOWN_PRIM GL_POLYGON+2 900#define PRIM_UNKNOWN GL_POLYGON+3 901 902 GLuint CurrentExecPrimitive; 903 /* Set by the driver-supplied t&l engine. Set to GL_POLYGON+1 when 904 * outside begin/end. 905 */ 906 907 GLuint CurrentSavePrimitive; 908 /* Current state of an inprogress compilation. 909 */ 910 911 912 913#define FLUSH_STORED_VERTICES 0x1 914#define FLUSH_UPDATE_CURRENT 0x2 915 GLuint NeedFlush; 916 /* Set by the driver-supplied t&l engine whenever vertices are 917 * buffered between begin/end objects or ctx->Current is not uptodate. 918 * 919 * The FlushVertices() call below may be used to resolve 920 * these conditions. 921 */ 922 923 void (*FlushVertices)( GLcontext *ctx, GLuint flags ); 924 /* If inside begin/end, ASSERT(0). 925 * Otherwise, 926 * if (flags & FLUSH_STORED_VERTICES) flushes any buffered vertices, 927 * if (flags & FLUSH_UPDATE_CURRENT) updates ctx->Current 928 * and ctx->Light.Material 929 * returns GL_TRUE. 930 * 931 * Note that the default t&l engine never clears the 932 * FLUSH_UPDATE_CURRENT bit, even after performing the update. 933 */ 934 935 void (*LightingSpaceChange)( GLcontext *ctx ); 936 /* Notify driver that the special derived value _NeedEyeCoords has 937 * changed. 938 */ 939 940 void (*NewList)( GLcontext *ctx, GLuint list, GLenum mode ); 941 void (*EndList)( GLcontext *ctx ); 942 /* Let the t&l component know what is going on with display lists 943 * in time to make changes to dispatch tables, etc. 944 * Called by glNewList() and glEndList(), respectively. 945 */ 946 947 void (*BeginCallList)( GLcontext *ctx, GLuint list ); 948 void (*EndCallList)( GLcontext *ctx ); 949 /* Notify the t&l component before and after calling a display list. 950 * Called by glCallList(s), but not recursively. 951 */ 952 953 void (*MakeCurrent)( GLcontext *ctx, GLframebuffer *drawBuffer, 954 GLframebuffer *readBuffer ); 955 /* Let the t&l component know when the context becomes current. 956 */ 957 958 959 void (*LockArraysEXT)( GLcontext *ctx, GLint first, GLsizei count ); 960 void (*UnlockArraysEXT)( GLcontext *ctx ); 961 /* Called by glLockArraysEXT() and glUnlockArraysEXT(), respectively. 962 */ 963 964}; 965 966 967 968/* 969 * Transform/Clip/Lighting interface 970 */ 971typedef struct { 972 void (*ArrayElement)( GLint ); /* NOTE */ 973 void (*Color3f)( GLfloat, GLfloat, GLfloat ); 974 void (*Color3fv)( const GLfloat * ); 975 void (*Color3ub)( GLubyte, GLubyte, GLubyte ); 976 void (*Color3ubv)( const GLubyte * ); 977 void (*Color4f)( GLfloat, GLfloat, GLfloat, GLfloat ); 978 void (*Color4fv)( const GLfloat * ); 979 void (*Color4ub)( GLubyte, GLubyte, GLubyte, GLubyte ); 980 void (*Color4ubv)( const GLubyte * ); 981 void (*EdgeFlag)( GLboolean ); 982 void (*EdgeFlagv)( const GLboolean * ); 983 void (*EvalCoord1f)( GLfloat ); /* NOTE */ 984 void (*EvalCoord1fv)( const GLfloat * ); /* NOTE */ 985 void (*EvalCoord2f)( GLfloat, GLfloat ); /* NOTE */ 986 void (*EvalCoord2fv)( const GLfloat * ); /* NOTE */ 987 void (*EvalPoint1)( GLint ); /* NOTE */ 988 void (*EvalPoint2)( GLint, GLint ); /* NOTE */ 989 void (*FogCoordfEXT)( GLfloat ); 990 void (*FogCoordfvEXT)( const GLfloat * ); 991 void (*Indexi)( GLint ); 992 void (*Indexiv)( const GLint * ); 993 void (*Materialfv)( GLenum face, GLenum pname, const GLfloat * ); /* NOTE */ 994 void (*MultiTexCoord1fARB)( GLenum, GLfloat ); 995 void (*MultiTexCoord1fvARB)( GLenum, const GLfloat * ); 996 void (*MultiTexCoord2fARB)( GLenum, GLfloat, GLfloat ); 997 void (*MultiTexCoord2fvARB)( GLenum, const GLfloat * ); 998 void (*MultiTexCoord3fARB)( GLenum, GLfloat, GLfloat, GLfloat ); 999 void (*MultiTexCoord3fvARB)( GLenum, const GLfloat * ); 1000 void (*MultiTexCoord4fARB)( GLenum, GLfloat, GLfloat, GLfloat, GLfloat ); 1001 void (*MultiTexCoord4fvARB)( GLenum, const GLfloat * ); 1002 void (*Normal3f)( GLfloat, GLfloat, GLfloat ); 1003 void (*Normal3fv)( const GLfloat * ); 1004 void (*SecondaryColor3fEXT)( GLfloat, GLfloat, GLfloat ); 1005 void (*SecondaryColor3fvEXT)( const GLfloat * ); 1006 void (*SecondaryColor3ubEXT)( GLubyte, GLubyte, GLubyte ); 1007 void (*SecondaryColor3ubvEXT)( const GLubyte * ); 1008 void (*TexCoord1f)( GLfloat ); 1009 void (*TexCoord1fv)( const GLfloat * ); 1010 void (*TexCoord2f)( GLfloat, GLfloat ); 1011 void (*TexCoord2fv)( const GLfloat * ); 1012 void (*TexCoord3f)( GLfloat, GLfloat, GLfloat ); 1013 void (*TexCoord3fv)( const GLfloat * ); 1014 void (*TexCoord4f)( GLfloat, GLfloat, GLfloat, GLfloat ); 1015 void (*TexCoord4fv)( const GLfloat * ); 1016 void (*Vertex2f)( GLfloat, GLfloat ); 1017 void (*Vertex2fv)( const GLfloat * ); 1018 void (*Vertex3f)( GLfloat, GLfloat, GLfloat ); 1019 void (*Vertex3fv)( const GLfloat * ); 1020 void (*Vertex4f)( GLfloat, GLfloat, GLfloat, GLfloat ); 1021 void (*Vertex4fv)( const GLfloat * ); 1022 void (*CallList)( GLuint ); /* NOTE */ 1023 void (*Begin)( GLenum ); 1024 void (*End)( void ); 1025 /* Drivers present a reduced set of the functions possible in 1026 * begin/end objects. Core mesa provides translation stubs for the 1027 * remaining functions to map down to these entrypoints. 1028 * 1029 * These are the initial values to be installed into dispatch by 1030 * mesa. If the t&l driver wants to modify the dispatch table 1031 * while installed, it must do so itself. It would be possible for 1032 * the vertexformat to install it's own initial values for these 1033 * functions, but this way there is an obvious list of what is 1034 * expected of the driver. 1035 * 1036 * If the driver wants to hook in entrypoints other than those 1037 * listed above, it must restore them to their original values in 1038 * the disable() callback, below. 1039 */ 1040 1041 void (*Rectf)( GLfloat, GLfloat, GLfloat, GLfloat ); 1042 /* 1043 */ 1044 1045 1046 void (*DrawArrays)( GLenum mode, GLint start, GLsizei count ); 1047 void (*DrawElements)( GLenum mode, GLsizei count, GLenum type, 1048 const GLvoid *indices ); 1049 void (*DrawRangeElements)(GLenum mode, GLuint start, 1050 GLuint end, GLsizei count, 1051 GLenum type, const GLvoid *indices); 1052 /* These may or may not belong here. Heuristic: If an array is 1053 * enabled, the installed vertex format should support that array and 1054 * it's current size natively. 1055 */ 1056 1057 void (*EvalMesh1)( GLenum mode, GLint i1, GLint i2 ); 1058 void (*EvalMesh2)( GLenum mode, GLint i1, GLint i2, GLint j1, GLint j2 ); 1059 /* If you don't support eval, fallback to the default vertex format 1060 * on receiving an eval call and use the pipeline mechanism to 1061 * provide partial t&l acceleration. 1062 * 1063 * Mesa will provide a set of helper functions to do eval within 1064 * accelerated vertex formats, eventually... 1065 * 1066 * Update: There seem to be issues re. maintaining correct values 1067 * for 'ctx->Current' in the face of Eval and T&L fallbacks... 1068 */ 1069 1070 GLboolean prefer_float_colors; 1071 /* Should core send non-standard colors to glColor4f or glColor4ub 1072 */ 1073 1074 1075} GLvertexformat; 1076 1077 1078#endif 1079 1080