reactos/dll/opengl/mesa/src/mesa/main/dd.h

   1 /**
   2  * \file dd.h
   3  * Device driver interfaces.
   4  */
   5
   6 /*
   7  * Mesa 3-D graphics library
   8  * Version:  6.5.2
   9  *
  10  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a
  13  * copy of this software and associated documentation files (the "Software"),
  14  * to deal in the Software without restriction, including without limitation
  15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  16  * and/or sell copies of the Software, and to permit persons to whom the
  17  * Software is furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included
  20  * in all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  23  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  25  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  26  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  27  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28  */
  29
  30
  31 #ifndef DD_INCLUDED
  32 #define DD_INCLUDED
  33
  34 /* THIS FILE ONLY INCLUDED BY mtypes.h !!!!! */
  35
  36 #include "glheader.h"
  37
  38 struct gl_buffer_object;
  39 struct gl_context;
  40 struct gl_display_list;
  41 struct gl_framebuffer;
  42 struct gl_pixelstore_attrib;
  43 struct gl_program;
  44 struct gl_renderbuffer;
  45 struct gl_renderbuffer_attachment;
  46 struct gl_shader;
  47 struct gl_shader_program;
  48 struct gl_texture_image;
  49 struct gl_texture_object;
  50
  51 /* GL_ARB_vertex_buffer_object */
  52 /* Modifies GL_MAP_UNSYNCHRONIZED_BIT to allow driver to fail (return
  53  * NULL) if buffer is unavailable for immediate mapping.
  54  *
  55  * Does GL_MAP_INVALIDATE_RANGE_BIT do this?  It seems so, but it
  56  * would require more book-keeping in the driver than seems necessary
  57  * at this point.
  58  *
  59  * Does GL_MAP_INVALDIATE_BUFFER_BIT do this?  Not really -- we don't
  60  * want to provoke the driver to throw away the old storage, we will
  61  * respect the contents of already referenced data.
  62  */
  63 #define MESA_MAP_NOWAIT_BIT       0x0040
  64
  65
  66 /**
  67  * Device driver function table.
  68  * Core Mesa uses these function pointers to call into device drivers.
  69  * Most of these functions directly correspond to OpenGL state commands.
  70  * Core Mesa will call these functions after error checking has been done
  71  * so that the drivers don't have to worry about error testing.
  72  *
  73  * Vertex transformation/clipping/lighting is patched into the T&L module.
  74  * Rasterization functions are patched into the swrast module.
  75  *
  76  * Note: when new functions are added here, the drivers/common/driverfuncs.c
  77  * file should be updated too!!!
  78  */
  79 struct dd_function_table {
  80    /**
  81     * Return a string as needed by glGetString().
  82     * Only the GL_RENDERER query must be implemented.  Otherwise, NULL can be
  83     * returned.
  84     */
  85    const GLubyte * (*GetString)( struct gl_context *ctx, GLenum name );
  86
  87    /**
  88     * Notify the driver after Mesa has made some internal state changes.
  89     *
  90     * This is in addition to any state change callbacks Mesa may already have
  91     * made.
  92     */
  93    void (*UpdateState)( struct gl_context *ctx, GLbitfield new_state );
  94
  95    /**
  96     * Get the width and height of the named buffer/window.
  97     *
  98     * Mesa uses this to determine when the driver's window size has changed.
  99     * XXX OBSOLETE: this function will be removed in the future.
 100     */
 101    void (*GetBufferSize)( struct gl_framebuffer *buffer,
 102                           GLuint *width, GLuint *height );
 103
 104    /**
 105     * Resize the given framebuffer to the given size.
 106     * XXX OBSOLETE: this function will be removed in the future.
 107     */
 108    void (*ResizeBuffers)( struct gl_context *ctx, struct gl_framebuffer *fb,
 109                           GLuint width, GLuint height);
 110
 111    /**
 112     * Called whenever an error is generated.
 113     * __struct gl_contextRec::ErrorValue contains the error value.
 114     */
 115    void (*Error)( struct gl_context *ctx );
 116
 117    /**
 118     * This is called whenever glFinish() is called.
 119     */
 120    void (*Finish)( struct gl_context *ctx );
 121
 122    /**
 123     * This is called whenever glFlush() is called.
 124     */
 125    void (*Flush)( struct gl_context *ctx );
 126
 127    /**
 128     * Clear the color/depth/stencil/accum buffer(s).
 129     * \param buffers  a bitmask of BUFFER_BIT_* flags indicating which
 130     *                 renderbuffers need to be cleared.
 131     */
 132    void (*Clear)( struct gl_context *ctx, GLbitfield buffers );
 133
 134    /**
 135     * Execute glAccum command.
 136     */
 137    void (*Accum)( struct gl_context *ctx, GLenum op, GLfloat value );
 138
 139
 140    /**
 141     * Execute glRasterPos, updating the ctx->Current.Raster fields
 142     */
 143    void (*RasterPos)( struct gl_context *ctx, const GLfloat v[4] );
 144
 145    /**
 146     * \name Image-related functions
 147     */
 148    /*@{*/
 149
 150    /**
 151     * Called by glDrawPixels().
 152     * \p unpack describes how to unpack the source image data.
 153     */
 154    void (*DrawPixels)( struct gl_context *ctx,
 155                        GLint x, GLint y, GLsizei width, GLsizei height,
 156                        GLenum format, GLenum type,
 157                        const struct gl_pixelstore_attrib *unpack,
 158                        const GLvoid *pixels );
 159
 160    /**
 161     * Called by glReadPixels().
 162     */
 163    void (*ReadPixels)( struct gl_context *ctx,
 164                        GLint x, GLint y, GLsizei width, GLsizei height,
 165                        GLenum format, GLenum type,
 166                        const struct gl_pixelstore_attrib *unpack,
 167                        GLvoid *dest );
 168
 169    /**
 170     * Called by glCopyPixels().
 171     */
 172    void (*CopyPixels)( struct gl_context *ctx, GLint srcx, GLint srcy,
 173                        GLsizei width, GLsizei height,
 174                        GLint dstx, GLint dsty, GLenum type );
 175
 176    /**
 177     * Called by glBitmap().
 178     */
 179    void (*Bitmap)( struct gl_context *ctx,
 180                    GLint x, GLint y, GLsizei width, GLsizei height,
 181                    const struct gl_pixelstore_attrib *unpack,
 182                    const GLubyte *bitmap );
 183    /*@}*/
 184
 185
 186    /**
 187     * \name Texture image functions
 188     */
 189    /*@{*/
 190
 191    /**
 192     * Choose actual hardware texture format given the user-provided source
 193     * image format and type and the desired internal format.  In some
 194     * cases, srcFormat and srcType can be GL_NONE.
 195     * Called by glTexImage(), etc.
 196     */
 197    gl_format (*ChooseTextureFormat)( struct gl_context *ctx, GLint internalFormat,
 198                                      GLenum srcFormat, GLenum srcType );
 199
 200    /**
 201     * Called by glTexImage1D().  Simply copy the source texture data into the
 202     * destination texture memory.  The gl_texture_image fields, etc. will be
 203     * fully initialized.
 204     * The parameters are the same as glTexImage1D(), plus:
 205     * \param packing describes how to unpack the source data.
 206     * \param texImage is the destination texture image.
 207     */
 208    void (*TexImage1D)(struct gl_context *ctx,
 209                       struct gl_texture_image *texImage,
 210                       GLint internalFormat,
 211                       GLint width, GLint border,
 212                       GLenum format, GLenum type, const GLvoid *pixels,
 213                       const struct gl_pixelstore_attrib *packing);
 214
 215    /**
 216     * Called by glTexImage2D().
 217     *
 218     * \sa dd_function_table::TexImage1D.
 219     */
 220    void (*TexImage2D)(struct gl_context *ctx,
 221                       struct gl_texture_image *texImage,
 222                       GLint internalFormat,
 223                       GLint width, GLint height, GLint border,
 224                       GLenum format, GLenum type, const GLvoid *pixels,
 225                       const struct gl_pixelstore_attrib *packing);
 226
 227    /**
 228     * Called by glTexImage3D().
 229     *
 230     * \sa dd_function_table::TexImage1D.
 231     */
 232    void (*TexImage3D)(struct gl_context *ctx,
 233                       struct gl_texture_image *texImage,
 234                       GLint internalFormat,
 235                       GLint width, GLint height, GLint depth, GLint border,
 236                       GLenum format, GLenum type, const GLvoid *pixels,
 237                       const struct gl_pixelstore_attrib *packing);
 238
 239    /**
 240     * Called by glTexSubImage1D().  Replace a subset of the target texture
 241     * with new texel data.
 242     * \sa dd_function_table::TexImage1D.
 243     */
 244    void (*TexSubImage1D)(struct gl_context *ctx,
 245                          struct gl_texture_image *texImage,
 246                          GLint xoffset, GLsizei width,
 247                          GLenum format, GLenum type,
 248                          const GLvoid *pixels,
 249                          const struct gl_pixelstore_attrib *packing);
 250
 251    /**
 252     * Called by glTexSubImage2D().
 253     *
 254     * \sa dd_function_table::TexSubImage1D.
 255     */
 256    void (*TexSubImage2D)(struct gl_context *ctx,
 257                          struct gl_texture_image *texImage,
 258                          GLint xoffset, GLint yoffset,
 259                          GLsizei width, GLsizei height,
 260                          GLenum format, GLenum type,
 261                          const GLvoid *pixels,
 262                          const struct gl_pixelstore_attrib *packing);
 263
 264    /**
 265     * Called by glTexSubImage3D().
 266     *
 267     * \sa dd_function_table::TexSubImage1D.
 268     */
 269    void (*TexSubImage3D)(struct gl_context *ctx,
 270                          struct gl_texture_image *texImage,
 271                          GLint xoffset, GLint yoffset, GLint zoffset,
 272                          GLsizei width, GLsizei height, GLint depth,
 273                          GLenum format, GLenum type,
 274                          const GLvoid *pixels,
 275                          const struct gl_pixelstore_attrib *packing);
 276
 277
 278    /**
 279     * Called by glGetTexImage().
 280     */
 281    void (*GetTexImage)( struct gl_context *ctx,
 282                         GLenum format, GLenum type, GLvoid *pixels,
 283                         struct gl_texture_image *texImage );
 284
 285    /**
 286     * Called by glCopyTexSubImage1D() and glCopyTexImage1D().
 287     */
 288    void (*CopyTexSubImage1D)(struct gl_context *ctx,
 289                              struct gl_texture_image *texImage,
 290                              GLint xoffset,
 291                              struct gl_renderbuffer *rb,
 292                              GLint x, GLint y, GLsizei width);
 293
 294    /**
 295     * Called by glCopyTexSubImage2D() and glCopyTexImage2D().
 296     */
 297    void (*CopyTexSubImage2D)(struct gl_context *ctx,
 298                              struct gl_texture_image *texImage,
 299                              GLint xoffset, GLint yoffset,
 300                              struct gl_renderbuffer *rb,
 301                              GLint x, GLint y,
 302                              GLsizei width, GLsizei height);
 303
 304    /**
 305     * Called by glCopyTexSubImage3D() and glCopyTexImage3D().
 306     */
 307    void (*CopyTexSubImage3D)(struct gl_context *ctx,
 308                              struct gl_texture_image *texImage,
 309                              GLint xoffset, GLint yoffset, GLint zoffset,
 310                              struct gl_renderbuffer *rb,
 311                              GLint x, GLint y,
 312                              GLsizei width, GLsizei height);
 313
 314    /**
 315     * Called by glGenerateMipmap() or when GL_GENERATE_MIPMAP_SGIS is enabled.
 316     */
 317    void (*GenerateMipmap)(struct gl_context *ctx, GLenum target,
 318                           struct gl_texture_object *texObj);
 319
 320    /**
 321     * Called by glTexImage[123]D when user specifies a proxy texture
 322     * target.
 323     *
 324     * \return GL_TRUE if the proxy test passes, or GL_FALSE if the test fails.
 325     */
 326    GLboolean (*TestProxyTexImage)(struct gl_context *ctx, GLenum target,
 327                                   GLint level, GLint internalFormat,
 328                                   GLenum format, GLenum type,
 329                                   GLint width, GLint height,
 330                                   GLint depth, GLint border);
 331    /*@}*/
 332
 333
 334    /**
 335     * \name Compressed texture functions
 336     */
 337    /*@{*/
 338
 339    /**
 340     * Called by glCompressedTexImage1D().
 341     * The parameters are the same as for glCompressedTexImage1D(), plus a
 342     * pointer to the destination texure image.
 343     */
 344    void (*CompressedTexImage1D)(struct gl_context *ctx,
 345                                 struct gl_texture_image *texImage,
 346                                 GLint internalFormat,
 347                                 GLsizei width, GLint border,
 348                                 GLsizei imageSize, const GLvoid *data);
 349    /**
 350     * Called by glCompressedTexImage2D().
 351     *
 352     * \sa dd_function_table::CompressedTexImage1D.
 353     */
 354    void (*CompressedTexImage2D)(struct gl_context *ctx,
 355                                 struct gl_texture_image *texImage,
 356                                 GLint internalFormat,
 357                                 GLsizei width, GLsizei height, GLint border,
 358                                 GLsizei imageSize, const GLvoid *data);
 359
 360    /**
 361     * Called by glCompressedTexImage3D().
 362     *
 363     * \sa dd_function_table::CompressedTexImage3D.
 364     */
 365    void (*CompressedTexImage3D)(struct gl_context *ctx,
 366                                 struct gl_texture_image *texImage,
 367                                 GLint internalFormat,
 368                                 GLsizei width, GLsizei height, GLsizei depth,
 369                                 GLint border,
 370                                 GLsizei imageSize, const GLvoid *data);
 371
 372    /**
 373     * Called by glCompressedTexSubImage1D().
 374     */
 375    void (*CompressedTexSubImage1D)(struct gl_context *ctx,
 376                                    struct gl_texture_image *texImage,
 377                                    GLint xoffset, GLsizei width,
 378                                    GLenum format,
 379                                    GLsizei imageSize, const GLvoid *data);
 380
 381    /**
 382     * Called by glCompressedTexSubImage2D().
 383     */
 384    void (*CompressedTexSubImage2D)(struct gl_context *ctx,
 385                                    struct gl_texture_image *texImage,
 386                                    GLint xoffset, GLint yoffset,
 387                                    GLsizei width, GLint height,
 388                                    GLenum format,
 389                                    GLsizei imageSize, const GLvoid *data);
 390
 391    /**
 392     * Called by glCompressedTexSubImage3D().
 393     */
 394    void (*CompressedTexSubImage3D)(struct gl_context *ctx,
 395                                    struct gl_texture_image *texImage,
 396                                    GLint xoffset, GLint yoffset, GLint zoffset,
 397                                    GLsizei width, GLint height, GLint depth,
 398                                    GLenum format,
 399                                    GLsizei imageSize, const GLvoid *data);
 400
 401    /**
 402     * Called by glGetCompressedTexImage.
 403     */
 404    void (*GetCompressedTexImage)(struct gl_context *ctx,
 405                                  struct gl_texture_image *texImage,
 406                                  GLvoid *data);
 407    /*@}*/
 408
 409    /**
 410     * \name Texture object / image functions
 411     */
 412    /*@{*/
 413
 414    /**
 415     * Called by glBindTexture().
 416     */
 417    void (*BindTexture)( struct gl_context *ctx, GLenum target,
 418                         struct gl_texture_object *tObj );
 419
 420    /**
 421     * Called to allocate a new texture object.  Drivers will usually
 422     * allocate/return a subclass of gl_texture_object.
 423     */
 424    struct gl_texture_object * (*NewTextureObject)(struct gl_context *ctx,
 425                                                   GLuint name, GLenum target);
 426    /**
 427     * Called to delete/free a texture object.  Drivers should free the
 428     * object and any image data it contains.
 429     */
 430    void (*DeleteTexture)(struct gl_context *ctx,
 431                          struct gl_texture_object *texObj);
 432
 433    /** Called to allocate a new texture image object. */
 434    struct gl_texture_image * (*NewTextureImage)(struct gl_context *ctx);
 435
 436    /** Called to free a texture image object returned by NewTextureImage() */
 437    void (*DeleteTextureImage)(struct gl_context *ctx,
 438                               struct gl_texture_image *);
 439
 440    /** Called to allocate memory for a single texture image */
 441    GLboolean (*AllocTextureImageBuffer)(struct gl_context *ctx,
 442                                         struct gl_texture_image *texImage,
 443                                         gl_format format, GLsizei width,
 444                                         GLsizei height, GLsizei depth);
 445
 446    /** Free the memory for a single texture image */
 447    void (*FreeTextureImageBuffer)(struct gl_context *ctx,
 448                                   struct gl_texture_image *texImage);
 449
 450    /** Map a slice of a texture image into user space.
 451     * Note: for GL_TEXTURE_1D_ARRAY, height must be 1, y must be 0 and slice
 452     * indicates the 1D array index.
 453     * \param texImage  the texture image
 454     * \param slice  the 3D image slice or array texture slice
 455     * \param x, y, w, h  region of interest
 456     * \param mode  bitmask of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT and
 457     *              GL_MAP_INVALIDATE_RANGE_BIT (if writing)
 458     * \param mapOut  returns start of mapping of region of interest
 459     * \param rowStrideOut  returns row stride (in bytes)
 460     */
 461    void (*MapTextureImage)(struct gl_context *ctx,
 462                            struct gl_texture_image *texImage,
 463                            GLuint slice,
 464                            GLuint x, GLuint y, GLuint w, GLuint h,
 465                            GLbitfield mode,
 466                            GLubyte **mapOut, GLint *rowStrideOut);
 467
 468    void (*UnmapTextureImage)(struct gl_context *ctx,
 469                              struct gl_texture_image *texImage,
 470                              GLuint slice);
 471
 472    /** For GL_ARB_texture_storage.  Allocate memory for whole mipmap stack.
 473     * All the gl_texture_images in the texture object will have their
 474     * dimensions, format, etc. initialized already.
 475     */
 476    GLboolean (*AllocTextureStorage)(struct gl_context *ctx,
 477                                     struct gl_texture_object *texObj,
 478                                     GLsizei levels, GLsizei width,
 479                                     GLsizei height, GLsizei depth);
 480
 481    /**
 482     * Map a renderbuffer into user space.
 483     * \param mode  bitmask of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT and
 484     *              GL_MAP_INVALIDATE_RANGE_BIT (if writing)
 485     */
 486    void (*MapRenderbuffer)(struct gl_context *ctx,
 487                            struct gl_renderbuffer *rb,
 488                            GLuint x, GLuint y, GLuint w, GLuint h,
 489                            GLbitfield mode,
 490                            GLubyte **mapOut, GLint *rowStrideOut);
 491
 492    void (*UnmapRenderbuffer)(struct gl_context *ctx,
 493                              struct gl_renderbuffer *rb);
 494
 495    /*@}*/
 496
 497
 498    /**
 499     * \name Vertex/fragment program functions
 500     */
 501    /*@{*/
 502    /** Bind a vertex/fragment program */
 503    void (*BindProgram)(struct gl_context *ctx, GLenum target, struct gl_program *prog);
 504    /** Allocate a new program */
 505    struct gl_program * (*NewProgram)(struct gl_context *ctx, GLenum target, GLuint id);
 506    /** Delete a program */
 507    void (*DeleteProgram)(struct gl_context *ctx, struct gl_program *prog);
 508
 509    /** Query if program can be loaded onto hardware */
 510    GLboolean (*IsProgramNative)(struct gl_context *ctx, GLenum target,
 511                                 struct gl_program *prog);
 512
 513    /*@}*/
 514
 515    /**
 516     * \name GLSL shader/program functions.
 517     */
 518    /*@{*/
 519    /**
 520     * Called when a shader program is linked.
 521     *
 522     * This gives drivers an opportunity to clone the IR and make their
 523     * own transformations on it for the purposes of code generation.
 524     */
 525    GLboolean (*LinkShader)(struct gl_context *ctx, struct gl_shader_program *shader);
 526    /*@}*/
 527
 528    /**
 529     * \name State-changing functions.
 530     *
 531     * \note drawing functions are above.
 532     *
 533     * These functions are called by their corresponding OpenGL API functions.
 534     * They are \e also called by the gl_PopAttrib() function!!!
 535     * May add more functions like these to the device driver in the future.
 536     */
 537    /*@{*/
 538    /** Specify the alpha test function */
 539    void (*AlphaFunc)(struct gl_context *ctx, GLenum func, GLfloat ref);
 540    /** Set the blend color */
 541    void (*BlendColor)(struct gl_context *ctx, const GLfloat color[4]);
 542    /** Set the blend equation */
 543    void (*BlendEquationSeparate)(struct gl_context *ctx, GLenum modeRGB, GLenum modeA);
 544    void (*BlendEquationSeparatei)(struct gl_context *ctx, GLuint buffer,
 545                                   GLenum modeRGB, GLenum modeA);
 546    /** Specify pixel arithmetic */
 547    void (*BlendFuncSeparate)(struct gl_context *ctx,
 548                              GLenum sfactorRGB, GLenum dfactorRGB,
 549                              GLenum sfactorA, GLenum dfactorA);
 550    void (*BlendFuncSeparatei)(struct gl_context *ctx, GLuint buffer,
 551                               GLenum sfactorRGB, GLenum dfactorRGB,
 552                               GLenum sfactorA, GLenum dfactorA);
 553    /** Specify clear values for the color buffers */
 554    void (*ClearColor)(struct gl_context *ctx,
 555                       const union gl_color_union color);
 556    /** Specify the clear value for the depth buffer */
 557    void (*ClearDepth)(struct gl_context *ctx, GLclampd d);
 558    /** Specify the clear value for the stencil buffer */
 559    void (*ClearStencil)(struct gl_context *ctx, GLint s);
 560    /** Specify a plane against which all geometry is clipped */
 561    void (*ClipPlane)(struct gl_context *ctx, GLenum plane, const GLfloat *equation );
 562    /** Enable and disable writing of frame buffer color components */
 563    void (*ColorMask)(struct gl_context *ctx, GLboolean rmask, GLboolean gmask,
 564                      GLboolean bmask, GLboolean amask );
 565    /** Cause a material color to track the current color */
 566    void (*ColorMaterial)(struct gl_context *ctx, GLenum face, GLenum mode);
 567    /** Specify whether front- or back-facing facets can be culled */
 568    void (*CullFace)(struct gl_context *ctx, GLenum mode);
 569    /** Define front- and back-facing polygons */
 570    void (*FrontFace)(struct gl_context *ctx, GLenum mode);
 571    /** Specify the value used for depth buffer comparisons */
 572    void (*DepthFunc)(struct gl_context *ctx, GLenum func);
 573    /** Enable or disable writing into the depth buffer */
 574    void (*DepthMask)(struct gl_context *ctx, GLboolean flag);
 575    /** Specify mapping of depth values from NDC to window coordinates */
 576    void (*DepthRange)(struct gl_context *ctx, GLclampd nearval, GLclampd farval);
 577    /** Specify the current buffer for writing */
 578    void (*DrawBuffer)( struct gl_context *ctx, GLenum buffer );
 579    /** Enable or disable server-side gl capabilities */
 580    void (*Enable)(struct gl_context *ctx, GLenum cap, GLboolean state);
 581    /** Specify fog parameters */
 582    void (*Fogfv)(struct gl_context *ctx, GLenum pname, const GLfloat *params);
 583    /** Specify implementation-specific hints */
 584    void (*Hint)(struct gl_context *ctx, GLenum target, GLenum mode);
 585    /** Set light source parameters.
 586     * Note: for GL_POSITION and GL_SPOT_DIRECTION, params will have already
 587     * been transformed to eye-space.
 588     */
 589    void (*Lightfv)(struct gl_context *ctx, GLenum light,
 590                    GLenum pname, const GLfloat *params );
 591    /** Set the lighting model parameters */
 592    void (*LightModelfv)(struct gl_context *ctx, GLenum pname, const GLfloat *params);
 593    /** Specify the line stipple pattern */
 594    void (*LineStipple)(struct gl_context *ctx, GLint factor, GLushort pattern );
 595    /** Specify the width of rasterized lines */
 596    void (*LineWidth)(struct gl_context *ctx, GLfloat width);
 597    /** Specify a logical pixel operation for color index rendering */
 598    void (*LogicOpcode)(struct gl_context *ctx, GLenum opcode);
 599    void (*PointParameterfv)(struct gl_context *ctx, GLenum pname,
 600                             const GLfloat *params);
 601    /** Specify the diameter of rasterized points */
 602    void (*PointSize)(struct gl_context *ctx, GLfloat size);
 603    /** Select a polygon rasterization mode */
 604    void (*PolygonMode)(struct gl_context *ctx, GLenum face, GLenum mode);
 605    /** Set the scale and units used to calculate depth values */
 606    void (*PolygonOffset)(struct gl_context *ctx, GLfloat factor, GLfloat units);
 607    /** Set the polygon stippling pattern */
 608    void (*PolygonStipple)(struct gl_context *ctx, const GLubyte *mask );
 609    /* Specifies the current buffer for reading */
 610    void (*ReadBuffer)( struct gl_context *ctx, GLenum buffer );
 611    /** Set rasterization mode */
 612    void (*RenderMode)(struct gl_context *ctx, GLenum mode );
 613    /** Define the scissor box */
 614    void (*Scissor)(struct gl_context *ctx, GLint x, GLint y, GLsizei w, GLsizei h);
 615    /** Select flat or smooth shading */
 616    void (*ShadeModel)(struct gl_context *ctx, GLenum mode);
 617    /** OpenGL 2.0 two-sided StencilFunc */
 618    void (*StencilFuncSeparate)(struct gl_context *ctx, GLenum face, GLenum func,
 619                                GLint ref, GLuint mask);
 620    /** OpenGL 2.0 two-sided StencilMask */
 621    void (*StencilMaskSeparate)(struct gl_context *ctx, GLenum face, GLuint mask);
 622    /** OpenGL 2.0 two-sided StencilOp */
 623    void (*StencilOpSeparate)(struct gl_context *ctx, GLenum face, GLenum fail,
 624                              GLenum zfail, GLenum zpass);
 625    /** Control the generation of texture coordinates */
 626    void (*TexGen)(struct gl_context *ctx, GLenum coord, GLenum pname,
 627                   const GLfloat *params);
 628    /** Set texture environment parameters */
 629    void (*TexEnv)(struct gl_context *ctx, GLenum target, GLenum pname,
 630                   const GLfloat *param);
 631    /** Set texture parameters */
 632    void (*TexParameter)(struct gl_context *ctx, GLenum target,
 633                         struct gl_texture_object *texObj,
 634                         GLenum pname, const GLfloat *params);
 635    /** Set the viewport */
 636    void (*Viewport)(struct gl_context *ctx, GLint x, GLint y, GLsizei w, GLsizei h);
 637    /*@}*/
 638
 639
 640    /**
 641     * \name Vertex/pixel buffer object functions
 642     */
 643    /*@{*/
 644    void (*BindBuffer)( struct gl_context *ctx, GLenum target,
 645                        struct gl_buffer_object *obj );
 646
 647    struct gl_buffer_object * (*NewBufferObject)( struct gl_context *ctx, GLuint buffer,
 648                                                  GLenum target );
 649
 650    void (*DeleteBuffer)( struct gl_context *ctx, struct gl_buffer_object *obj );
 651
 652    GLboolean (*BufferData)( struct gl_context *ctx, GLenum target, GLsizeiptrARB size,
 653                             const GLvoid *data, GLenum usage,
 654                             struct gl_buffer_object *obj );
 655
 656    void (*BufferSubData)( struct gl_context *ctx, GLintptrARB offset,
 657                           GLsizeiptrARB size, const GLvoid *data,
 658                           struct gl_buffer_object *obj );
 659
 660    void (*GetBufferSubData)( struct gl_context *ctx,
 661                              GLintptrARB offset, GLsizeiptrARB size,
 662                              GLvoid *data, struct gl_buffer_object *obj );
 663
 664    /* May return NULL if MESA_MAP_NOWAIT_BIT is set in access:
 665     */
 666    void * (*MapBufferRange)( struct gl_context *ctx, GLintptr offset,
 667                              GLsizeiptr length, GLbitfield access,
 668                              struct gl_buffer_object *obj);
 669
 670    void (*FlushMappedBufferRange)(struct gl_context *ctx,
 671                                   GLintptr offset, GLsizeiptr length,
 672                                   struct gl_buffer_object *obj);
 673
 674    GLboolean (*UnmapBuffer)( struct gl_context *ctx,
 675                              struct gl_buffer_object *obj );
 676    /*@}*/
 677
 678    /**
 679     * \name Functions for GL_APPLE_object_purgeable
 680     */
 681    /*@{*/
 682    /* variations on ObjectPurgeable */
 683    GLenum (*BufferObjectPurgeable)( struct gl_context *ctx, struct gl_buffer_object *obj, GLenum option );
 684    GLenum (*RenderObjectPurgeable)( struct gl_context *ctx, struct gl_renderbuffer *obj, GLenum option );
 685    GLenum (*TextureObjectPurgeable)( struct gl_context *ctx, struct gl_texture_object *obj, GLenum option );
 686
 687    /* variations on ObjectUnpurgeable */
 688    GLenum (*BufferObjectUnpurgeable)( struct gl_context *ctx, struct gl_buffer_object *obj, GLenum option );
 689    GLenum (*RenderObjectUnpurgeable)( struct gl_context *ctx, struct gl_renderbuffer *obj, GLenum option );
 690    GLenum (*TextureObjectUnpurgeable)( struct gl_context *ctx, struct gl_texture_object *obj, GLenum option );
 691    /*@}*/
 692
 693    /**
 694     * \name Functions for GL_EXT_framebuffer_{object,blit}.
 695     */
 696    /*@{*/
 697    struct gl_framebuffer * (*NewFramebuffer)(struct gl_context *ctx, GLuint name);
 698    struct gl_renderbuffer * (*NewRenderbuffer)(struct gl_context *ctx, GLuint name);
 699    void (*BindFramebuffer)(struct gl_context *ctx, GLenum target,
 700                            struct gl_framebuffer *drawFb,
 701                            struct gl_framebuffer *readFb);
 702    void (*FramebufferRenderbuffer)(struct gl_context *ctx,
 703                                    struct gl_framebuffer *fb,
 704                                    GLenum attachment,
 705                                    struct gl_renderbuffer *rb);
 706    void (*RenderTexture)(struct gl_context *ctx,
 707                          struct gl_framebuffer *fb,
 708                          struct gl_renderbuffer_attachment *att);
 709    void (*FinishRenderTexture)(struct gl_context *ctx,
 710                                struct gl_renderbuffer_attachment *att);
 711    void (*ValidateFramebuffer)(struct gl_context *ctx,
 712                                struct gl_framebuffer *fb);
 713    /*@}*/
 714    void (*BlitFramebuffer)(struct gl_context *ctx,
 715                            GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
 716                            GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
 717                            GLbitfield mask, GLenum filter);
 718
 719    /**
 720     * \name Query objects
 721     */
 722    /*@{*/
 723    struct gl_query_object * (*NewQueryObject)(struct gl_context *ctx, GLuint id);
 724    void (*DeleteQuery)(struct gl_context *ctx, struct gl_query_object *q);
 725    void (*BeginQuery)(struct gl_context *ctx, struct gl_query_object *q);
 726    void (*EndQuery)(struct gl_context *ctx, struct gl_query_object *q);
 727    void (*CheckQuery)(struct gl_context *ctx, struct gl_query_object *q);
 728    void (*WaitQuery)(struct gl_context *ctx, struct gl_query_object *q);
 729    /*@}*/
 730
 731
 732    /**
 733     * \name Vertex Array objects
 734     */
 735    /*@{*/
 736    struct gl_array_object * (*NewArrayObject)(struct gl_context *ctx, GLuint id);
 737    void (*DeleteArrayObject)(struct gl_context *ctx, struct gl_array_object *obj);
 738    void (*BindArrayObject)(struct gl_context *ctx, struct gl_array_object *obj);
 739    /*@}*/
 740
 741    /**
 742     * \name GLSL-related functions (ARB extensions and OpenGL 2.x)
 743     */
 744    /*@{*/
 745    struct gl_shader *(*NewShader)(struct gl_context *ctx, GLuint name, GLenum type);
 746    void (*DeleteShader)(struct gl_context *ctx, struct gl_shader *shader);
 747    struct gl_shader_program *(*NewShaderProgram)(struct gl_context *ctx, GLuint name);
 748    void (*DeleteShaderProgram)(struct gl_context *ctx,
 749                                struct gl_shader_program *shProg);
 750    void (*UseProgram)(struct gl_context *ctx, struct gl_shader_program *shProg);
 751    /*@}*/
 752
 753
 754    /**
 755     * \name Support for multiple T&L engines
 756     */
 757    /*@{*/
 758
 759    /**
 760     * Set by the driver-supplied T&L engine.
 761     *
 762     * Set to PRIM_OUTSIDE_BEGIN_END when outside glBegin()/glEnd().
 763     */
 764    GLuint CurrentExecPrimitive;
 765
 766    /**
 767     * Current state of an in-progress compilation.
 768     *
 769     * May take on any of the additional values PRIM_OUTSIDE_BEGIN_END,
 770     * PRIM_INSIDE_UNKNOWN_PRIM or PRIM_UNKNOWN defined above.
 771     */
 772    GLuint CurrentSavePrimitive;
 773
 774
 775 #define FLUSH_STORED_VERTICES 0x1
 776 #define FLUSH_UPDATE_CURRENT  0x2
 777    /**
 778     * Set by the driver-supplied T&L engine whenever vertices are buffered
 779     * between glBegin()/glEnd() objects or __struct gl_contextRec::Current is not
 780     * updated.
 781     *
 782     * The dd_function_table::FlushVertices call below may be used to resolve
 783     * these conditions.
 784     */
 785    GLuint NeedFlush;
 786    GLuint SaveNeedFlush;
 787
 788
 789    /* Called prior to any of the GLvertexformat functions being
 790     * called.  Paired with Driver.FlushVertices().
 791     */
 792    void (*BeginVertices)( struct gl_context *ctx );
 793
 794    /**
 795     * If inside glBegin()/glEnd(), it should ASSERT(0).  Otherwise, if
 796     * FLUSH_STORED_VERTICES bit in \p flags is set flushes any buffered
 797     * vertices, if FLUSH_UPDATE_CURRENT bit is set updates
 798     * __struct gl_contextRec::Current and gl_light_attrib::Material
 799     *
 800     * Note that the default T&L engine never clears the
 801     * FLUSH_UPDATE_CURRENT bit, even after performing the update.
 802     */
 803    void (*FlushVertices)( struct gl_context *ctx, GLuint flags );
 804    void (*SaveFlushVertices)( struct gl_context *ctx );
 805
 806    /**
 807     * \brief Hook for drivers to prepare for a glBegin/glEnd block
 808     *
 809     * This hook is called in vbo_exec_Begin() before any action, including
 810     * state updates, occurs.
 811     */
 812    void (*PrepareExecBegin)( struct gl_context *ctx );
 813
 814    /**
 815     * Give the driver the opportunity to hook in its own vtxfmt for
 816     * compiling optimized display lists.  This is called on each valid
 817     * glBegin() during list compilation.
 818     */
 819    GLboolean (*NotifySaveBegin)( struct gl_context *ctx, GLenum mode );
 820
 821    /**
 822     * Notify driver that the special derived value _NeedEyeCoords has
 823     * changed.
 824     */
 825    void (*LightingSpaceChange)( struct gl_context *ctx );
 826
 827    /**
 828     * Called by glNewList().
 829     *
 830     * Let the T&L component know what is going on with display lists
 831     * in time to make changes to dispatch tables, etc.
 832     */
 833    void (*NewList)( struct gl_context *ctx, GLuint list, GLenum mode );
 834    /**
 835     * Called by glEndList().
 836     *
 837     * \sa dd_function_table::NewList.
 838     */
 839    void (*EndList)( struct gl_context *ctx );
 840
 841    /**
 842     * Called by glCallList(s).
 843     *
 844     * Notify the T&L component before and after calling a display list.
 845     */
 846    void (*BeginCallList)( struct gl_context *ctx,
 847                           struct gl_display_list *dlist );
 848    /**
 849     * Called by glEndCallList().
 850     *
 851     * \sa dd_function_table::BeginCallList.
 852     */
 853    void (*EndCallList)( struct gl_context *ctx );
 854
 855    /**@}*/
 856
 857    /**
 858     * \name GL_NV_texture_barrier interface
 859     */
 860    void (*TextureBarrier)(struct gl_context *ctx);
 861 };
 862
 863
 864 /**
 865  * Transform/Clip/Lighting interface
 866  *
 867  * Drivers present a reduced set of the functions possible in
 868  * glBegin()/glEnd() objects.  Core mesa provides translation stubs for the
 869  * remaining functions to map down to these entry points.
 870  *
 871  * These are the initial values to be installed into dispatch by
 872  * mesa.  If the T&L driver wants to modify the dispatch table
 873  * while installed, it must do so itself.  It would be possible for
 874  * the vertexformat to install its own initial values for these
 875  * functions, but this way there is an obvious list of what is
 876  * expected of the driver.
 877  *
 878  * If the driver wants to hook in entry points other than those
 879  * listed, it must restore them to their original values in
 880  * the disable() callback, below.
 881  */
 882 typedef struct {
 883    /**
 884     * \name Vertex
 885     */
 886    /*@{*/
 887    void (GLAPIENTRYP ArrayElement)( GLint );
 888    void (GLAPIENTRYP Color3f)( GLfloat, GLfloat, GLfloat );
 889    void (GLAPIENTRYP Color3fv)( const GLfloat * );
 890    void (GLAPIENTRYP Color4f)( GLfloat, GLfloat, GLfloat, GLfloat );
 891    void (GLAPIENTRYP Color4fv)( const GLfloat * );
 892    void (GLAPIENTRYP EdgeFlag)( GLboolean );
 893    void (GLAPIENTRYP EvalCoord1f)( GLfloat );
 894    void (GLAPIENTRYP EvalCoord1fv)( const GLfloat * );
 895    void (GLAPIENTRYP EvalCoord2f)( GLfloat, GLfloat );
 896    void (GLAPIENTRYP EvalCoord2fv)( const GLfloat * );
 897    void (GLAPIENTRYP EvalPoint1)( GLint );
 898    void (GLAPIENTRYP EvalPoint2)( GLint, GLint );
 899    void (GLAPIENTRYP FogCoordfEXT)( GLfloat );
 900    void (GLAPIENTRYP FogCoordfvEXT)( const GLfloat * );
 901    void (GLAPIENTRYP Indexf)( GLfloat );
 902    void (GLAPIENTRYP Indexfv)( const GLfloat * );
 903    void (GLAPIENTRYP Materialfv)( GLenum face, GLenum pname, const GLfloat * );
 904    void (GLAPIENTRYP MultiTexCoord1fARB)( GLenum, GLfloat );
 905    void (GLAPIENTRYP MultiTexCoord1fvARB)( GLenum, const GLfloat * );
 906    void (GLAPIENTRYP MultiTexCoord2fARB)( GLenum, GLfloat, GLfloat );
 907    void (GLAPIENTRYP MultiTexCoord2fvARB)( GLenum, const GLfloat * );
 908    void (GLAPIENTRYP MultiTexCoord3fARB)( GLenum, GLfloat, GLfloat, GLfloat );
 909    void (GLAPIENTRYP MultiTexCoord3fvARB)( GLenum, const GLfloat * );
 910    void (GLAPIENTRYP MultiTexCoord4fARB)( GLenum, GLfloat, GLfloat, GLfloat, GLfloat );
 911    void (GLAPIENTRYP MultiTexCoord4fvARB)( GLenum, const GLfloat * );
 912    void (GLAPIENTRYP Normal3f)( GLfloat, GLfloat, GLfloat );
 913    void (GLAPIENTRYP Normal3fv)( const GLfloat * );
 914    void (GLAPIENTRYP SecondaryColor3fEXT)( GLfloat, GLfloat, GLfloat );
 915    void (GLAPIENTRYP SecondaryColor3fvEXT)( const GLfloat * );
 916    void (GLAPIENTRYP TexCoord1f)( GLfloat );
 917    void (GLAPIENTRYP TexCoord1fv)( const GLfloat * );
 918    void (GLAPIENTRYP TexCoord2f)( GLfloat, GLfloat );
 919    void (GLAPIENTRYP TexCoord2fv)( const GLfloat * );
 920    void (GLAPIENTRYP TexCoord3f)( GLfloat, GLfloat, GLfloat );
 921    void (GLAPIENTRYP TexCoord3fv)( const GLfloat * );
 922    void (GLAPIENTRYP TexCoord4f)( GLfloat, GLfloat, GLfloat, GLfloat );
 923    void (GLAPIENTRYP TexCoord4fv)( const GLfloat * );
 924    void (GLAPIENTRYP Vertex2f)( GLfloat, GLfloat );
 925    void (GLAPIENTRYP Vertex2fv)( const GLfloat * );
 926    void (GLAPIENTRYP Vertex3f)( GLfloat, GLfloat, GLfloat );
 927    void (GLAPIENTRYP Vertex3fv)( const GLfloat * );
 928    void (GLAPIENTRYP Vertex4f)( GLfloat, GLfloat, GLfloat, GLfloat );
 929    void (GLAPIENTRYP Vertex4fv)( const GLfloat * );
 930    void (GLAPIENTRYP CallList)( GLuint );
 931    void (GLAPIENTRYP CallLists)( GLsizei, GLenum, const GLvoid * );
 932    void (GLAPIENTRYP Begin)( GLenum );
 933    void (GLAPIENTRYP End)( void );
 934    /* GL_NV_vertex_program */
 935    void (GLAPIENTRYP VertexAttrib1fNV)( GLuint index, GLfloat x );
 936    void (GLAPIENTRYP VertexAttrib1fvNV)( GLuint index, const GLfloat *v );
 937    void (GLAPIENTRYP VertexAttrib2fNV)( GLuint index, GLfloat x, GLfloat y );
 938    void (GLAPIENTRYP VertexAttrib2fvNV)( GLuint index, const GLfloat *v );
 939    void (GLAPIENTRYP VertexAttrib3fNV)( GLuint index, GLfloat x, GLfloat y, GLfloat z );
 940    void (GLAPIENTRYP VertexAttrib3fvNV)( GLuint index, const GLfloat *v );
 941    void (GLAPIENTRYP VertexAttrib4fNV)( GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w );
 942    void (GLAPIENTRYP VertexAttrib4fvNV)( GLuint index, const GLfloat *v );
 943    /* GL_ARB_vertex_program */
 944    void (GLAPIENTRYP VertexAttrib1fARB)( GLuint index, GLfloat x );
 945    void (GLAPIENTRYP VertexAttrib1fvARB)( GLuint index, const GLfloat *v );
 946    void (GLAPIENTRYP VertexAttrib2fARB)( GLuint index, GLfloat x, GLfloat y );
 947    void (GLAPIENTRYP VertexAttrib2fvARB)( GLuint index, const GLfloat *v );
 948    void (GLAPIENTRYP VertexAttrib3fARB)( GLuint index, GLfloat x, GLfloat y, GLfloat z );
 949    void (GLAPIENTRYP VertexAttrib3fvARB)( GLuint index, const GLfloat *v );
 950    void (GLAPIENTRYP VertexAttrib4fARB)( GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w );
 951    void (GLAPIENTRYP VertexAttrib4fvARB)( GLuint index, const GLfloat *v );
 952
 953    /* GL_EXT_gpu_shader4 / GL 3.0 */
 954    void (GLAPIENTRYP VertexAttribI1i)( GLuint index, GLint x);
 955    void (GLAPIENTRYP VertexAttribI2i)( GLuint index, GLint x, GLint y);
 956    void (GLAPIENTRYP VertexAttribI3i)( GLuint index, GLint x, GLint y, GLint z);
 957    void (GLAPIENTRYP VertexAttribI4i)( GLuint index, GLint x, GLint y, GLint z, GLint w);
 958    void (GLAPIENTRYP VertexAttribI2iv)( GLuint index, const GLint *v);
 959    void (GLAPIENTRYP VertexAttribI3iv)( GLuint index, const GLint *v);
 960    void (GLAPIENTRYP VertexAttribI4iv)( GLuint index, const GLint *v);
 961
 962    void (GLAPIENTRYP VertexAttribI1ui)( GLuint index, GLuint x);
 963    void (GLAPIENTRYP VertexAttribI2ui)( GLuint index, GLuint x, GLuint y);
 964    void (GLAPIENTRYP VertexAttribI3ui)( GLuint index, GLuint x, GLuint y, GLuint z);
 965    void (GLAPIENTRYP VertexAttribI4ui)( GLuint index, GLuint x, GLuint y, GLuint z, GLuint w);
 966    void (GLAPIENTRYP VertexAttribI2uiv)( GLuint index, const GLuint *v);
 967    void (GLAPIENTRYP VertexAttribI3uiv)( GLuint index, const GLuint *v);
 968    void (GLAPIENTRYP VertexAttribI4uiv)( GLuint index, const GLuint *v);
 969
 970    /*@}*/
 971
 972    void (GLAPIENTRYP Rectf)( GLfloat, GLfloat, GLfloat, GLfloat );
 973
 974    /**
 975     * \name Array
 976     */
 977    /*@{*/
 978    void (GLAPIENTRYP DrawArrays)( GLenum mode, GLint start, GLsizei count );
 979    void (GLAPIENTRYP DrawElements)( GLenum mode, GLsizei count, GLenum type,
 980                          const GLvoid *indices );
 981    void (GLAPIENTRYP DrawRangeElements)( GLenum mode, GLuint start,
 982                               GLuint end, GLsizei count,
 983                               GLenum type, const GLvoid *indices );
 984    void (GLAPIENTRYP MultiDrawElementsEXT)( GLenum mode, const GLsizei *count,
 985                                             GLenum type,
 986                                             const GLvoid **indices,
 987                                             GLsizei primcount);
 988    /*@}*/
 989
 990    /**
 991     * \name Eval
 992     *
 993     * If you don't support eval, fallback to the default vertex format
 994     * on receiving an eval call and use the pipeline mechanism to
 995     * provide partial T&L acceleration.
 996     *
 997     * Mesa will provide a set of helper functions to do eval within
 998     * accelerated vertex formats, eventually...
 999     */
1000    /*@{*/
1001    void (GLAPIENTRYP EvalMesh1)( GLenum mode, GLint i1, GLint i2 );
1002    void (GLAPIENTRYP EvalMesh2)( GLenum mode, GLint i1, GLint i2, GLint j1, GLint j2 );
1003    /*@}*/
1004
1005 } GLvertexformat;
1006
1007
1008 #endif /* DD_INCLUDED */