3 * Device driver interfaces.
7 * Mesa 3-D graphics library
10 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
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.
34 /* THIS FILE ONLY INCLUDED BY mtypes.h !!!!! */
36 struct gl_pixelstore_attrib
;
37 struct mesa_display_list
;
40 * Device driver function table.
41 * Core Mesa uses these function pointers to call into device drivers.
42 * Most of these functions directly correspond to OpenGL state commands.
43 * Core Mesa will call these functions after error checking has been done
44 * so that the drivers don't have to worry about error testing.
46 * Vertex transformation/clipping/lighting is patched into the T&L module.
47 * Rasterization functions are patched into the swrast module.
49 * Note: when new functions are added here, the drivers/common/driverfuncs.c
50 * file should be updated too!!!
52 struct dd_function_table
{
54 * Return a string as needed by glGetString().
55 * Only the GL_RENDERER query must be implemented. Otherwise, NULL can be
58 const GLubyte
* (*GetString
)( GLcontext
*ctx
, GLenum name
);
61 * Notify the driver after Mesa has made some internal state changes.
63 * This is in addition to any state change callbacks Mesa may already have
66 void (*UpdateState
)( GLcontext
*ctx
, GLbitfield new_state
);
69 * Get the width and height of the named buffer/window.
71 * Mesa uses this to determine when the driver's window size has changed.
72 * XXX OBSOLETE: this function will be removed in the future.
74 void (*GetBufferSize
)( GLframebuffer
*buffer
,
75 GLuint
*width
, GLuint
*height
);
78 * Resize the given framebuffer to the given size.
79 * XXX OBSOLETE: this function will be removed in the future.
81 void (*ResizeBuffers
)( GLcontext
*ctx
, GLframebuffer
*fb
,
82 GLuint width
, GLuint height
);
85 * Called whenever an error is generated.
86 * __GLcontextRec::ErrorValue contains the error value.
88 void (*Error
)( GLcontext
*ctx
);
91 * This is called whenever glFinish() is called.
93 void (*Finish
)( GLcontext
*ctx
);
96 * This is called whenever glFlush() is called.
98 void (*Flush
)( GLcontext
*ctx
);
101 * Clear the color/depth/stencil/accum buffer(s).
102 * \param buffers a bitmask of BUFFER_BIT_* flags indicating which
103 * renderbuffers need to be cleared.
105 void (*Clear
)( GLcontext
*ctx
, GLbitfield buffers
);
108 * Execute glAccum command.
110 void (*Accum
)( GLcontext
*ctx
, GLenum op
, GLfloat value
);
114 * Execute glRasterPos, updating the ctx->Current.Raster fields
116 void (*RasterPos
)( GLcontext
*ctx
, const GLfloat v
[4] );
119 * \name Image-related functions
124 * Called by glDrawPixels().
125 * \p unpack describes how to unpack the source image data.
127 void (*DrawPixels
)( GLcontext
*ctx
,
128 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
129 GLenum format
, GLenum type
,
130 const struct gl_pixelstore_attrib
*unpack
,
131 const GLvoid
*pixels
);
134 * Called by glReadPixels().
136 void (*ReadPixels
)( GLcontext
*ctx
,
137 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
138 GLenum format
, GLenum type
,
139 const struct gl_pixelstore_attrib
*unpack
,
143 * Called by glCopyPixels().
145 void (*CopyPixels
)( GLcontext
*ctx
, GLint srcx
, GLint srcy
,
146 GLsizei width
, GLsizei height
,
147 GLint dstx
, GLint dsty
, GLenum type
);
150 * Called by glBitmap().
152 void (*Bitmap
)( GLcontext
*ctx
,
153 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
154 const struct gl_pixelstore_attrib
*unpack
,
155 const GLubyte
*bitmap
);
160 * \name Texture image functions
165 * Choose texture format.
167 * This is called by the \c _mesa_store_tex[sub]image[123]d() fallback
168 * functions. The driver should examine \p internalFormat and return a
169 * pointer to an appropriate gl_texture_format.
171 const struct gl_texture_format
*(*ChooseTextureFormat
)( GLcontext
*ctx
,
172 GLint internalFormat
, GLenum srcFormat
, GLenum srcType
);
175 * Called by glTexImage1D().
177 * \param target user specified.
178 * \param format user specified.
179 * \param type user specified.
180 * \param pixels user specified.
181 * \param packing indicates the image packing of pixels.
182 * \param texObj is the target texture object.
183 * \param texImage is the target texture image. It will have the texture \p
184 * width, \p height, \p depth, \p border and \p internalFormat information.
186 * \p retainInternalCopy is returned by this function and indicates whether
187 * core Mesa should keep an internal copy of the texture image.
189 * Drivers should call a fallback routine from texstore.c if needed.
191 void (*TexImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
192 GLint internalFormat
,
193 GLint width
, GLint border
,
194 GLenum format
, GLenum type
, const GLvoid
*pixels
,
195 const struct gl_pixelstore_attrib
*packing
,
196 struct gl_texture_object
*texObj
,
197 struct gl_texture_image
*texImage
);
200 * Called by glTexImage2D().
202 * \sa dd_function_table::TexImage1D.
204 void (*TexImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
205 GLint internalFormat
,
206 GLint width
, GLint height
, GLint border
,
207 GLenum format
, GLenum type
, const GLvoid
*pixels
,
208 const struct gl_pixelstore_attrib
*packing
,
209 struct gl_texture_object
*texObj
,
210 struct gl_texture_image
*texImage
);
213 * Called by glTexImage3D().
215 * \sa dd_function_table::TexImage1D.
217 void (*TexImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
218 GLint internalFormat
,
219 GLint width
, GLint height
, GLint depth
, GLint border
,
220 GLenum format
, GLenum type
, const GLvoid
*pixels
,
221 const struct gl_pixelstore_attrib
*packing
,
222 struct gl_texture_object
*texObj
,
223 struct gl_texture_image
*texImage
);
226 * Called by glTexSubImage1D().
228 * \param target user specified.
229 * \param level user specified.
230 * \param xoffset user specified.
231 * \param yoffset user specified.
232 * \param zoffset user specified.
233 * \param width user specified.
234 * \param height user specified.
235 * \param depth user specified.
236 * \param format user specified.
237 * \param type user specified.
238 * \param pixels user specified.
239 * \param packing indicates the image packing of pixels.
240 * \param texObj is the target texture object.
241 * \param texImage is the target texture image. It will have the texture \p
242 * width, \p height, \p border and \p internalFormat information.
244 * The driver should use a fallback routine from texstore.c if needed.
246 void (*TexSubImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
247 GLint xoffset
, GLsizei width
,
248 GLenum format
, GLenum type
,
249 const GLvoid
*pixels
,
250 const struct gl_pixelstore_attrib
*packing
,
251 struct gl_texture_object
*texObj
,
252 struct gl_texture_image
*texImage
);
255 * Called by glTexSubImage2D().
257 * \sa dd_function_table::TexSubImage1D.
259 void (*TexSubImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
260 GLint xoffset
, GLint yoffset
,
261 GLsizei width
, GLsizei height
,
262 GLenum format
, GLenum type
,
263 const GLvoid
*pixels
,
264 const struct gl_pixelstore_attrib
*packing
,
265 struct gl_texture_object
*texObj
,
266 struct gl_texture_image
*texImage
);
269 * Called by glTexSubImage3D().
271 * \sa dd_function_table::TexSubImage1D.
273 void (*TexSubImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
274 GLint xoffset
, GLint yoffset
, GLint zoffset
,
275 GLsizei width
, GLsizei height
, GLint depth
,
276 GLenum format
, GLenum type
,
277 const GLvoid
*pixels
,
278 const struct gl_pixelstore_attrib
*packing
,
279 struct gl_texture_object
*texObj
,
280 struct gl_texture_image
*texImage
);
283 * Called by glGetTexImage().
285 void (*GetTexImage
)( GLcontext
*ctx
, GLenum target
, GLint level
,
286 GLenum format
, GLenum type
, GLvoid
*pixels
,
287 struct gl_texture_object
*texObj
,
288 struct gl_texture_image
*texImage
);
291 * Called by glCopyTexImage1D().
293 * Drivers should use a fallback routine from texstore.c if needed.
295 void (*CopyTexImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
296 GLenum internalFormat
, GLint x
, GLint y
,
297 GLsizei width
, GLint border
);
300 * Called by glCopyTexImage2D().
302 * Drivers should use a fallback routine from texstore.c if needed.
304 void (*CopyTexImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
305 GLenum internalFormat
, GLint x
, GLint y
,
306 GLsizei width
, GLsizei height
, GLint border
);
309 * Called by glCopyTexSubImage1D().
311 * Drivers should use a fallback routine from texstore.c if needed.
313 void (*CopyTexSubImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
315 GLint x
, GLint y
, GLsizei width
);
317 * Called by glCopyTexSubImage2D().
319 * Drivers should use a fallback routine from texstore.c if needed.
321 void (*CopyTexSubImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
322 GLint xoffset
, GLint yoffset
,
324 GLsizei width
, GLsizei height
);
326 * Called by glCopyTexSubImage3D().
328 * Drivers should use a fallback routine from texstore.c if needed.
330 void (*CopyTexSubImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
331 GLint xoffset
, GLint yoffset
, GLint zoffset
,
333 GLsizei width
, GLsizei height
);
336 * Called by glGenerateMipmap() or when GL_GENERATE_MIPMAP_SGIS is enabled.
338 void (*GenerateMipmap
)(GLcontext
*ctx
, GLenum target
,
339 struct gl_texture_object
*texObj
);
342 * Called by glTexImage[123]D when user specifies a proxy texture
345 * \return GL_TRUE if the proxy test passes, or GL_FALSE if the test fails.
347 GLboolean (*TestProxyTexImage
)(GLcontext
*ctx
, GLenum target
,
348 GLint level
, GLint internalFormat
,
349 GLenum format
, GLenum type
,
350 GLint width
, GLint height
,
351 GLint depth
, GLint border
);
356 * \name Compressed texture functions
361 * Called by glCompressedTexImage1D().
363 * \param target user specified.
364 * \param format user specified.
365 * \param type user specified.
366 * \param pixels user specified.
367 * \param packing indicates the image packing of pixels.
368 * \param texObj is the target texture object.
369 * \param texImage is the target texture image. It will have the texture \p
370 * width, \p height, \p depth, \p border and \p internalFormat information.
372 * \a retainInternalCopy is returned by this function and indicates whether
373 * core Mesa should keep an internal copy of the texture image.
375 void (*CompressedTexImage1D
)( GLcontext
*ctx
, GLenum target
,
376 GLint level
, GLint internalFormat
,
377 GLsizei width
, GLint border
,
378 GLsizei imageSize
, const GLvoid
*data
,
379 struct gl_texture_object
*texObj
,
380 struct gl_texture_image
*texImage
);
382 * Called by glCompressedTexImage2D().
384 * \sa dd_function_table::CompressedTexImage1D.
386 void (*CompressedTexImage2D
)( GLcontext
*ctx
, GLenum target
,
387 GLint level
, GLint internalFormat
,
388 GLsizei width
, GLsizei height
, GLint border
,
389 GLsizei imageSize
, const GLvoid
*data
,
390 struct gl_texture_object
*texObj
,
391 struct gl_texture_image
*texImage
);
393 * Called by glCompressedTexImage3D().
395 * \sa dd_function_table::CompressedTexImage3D.
397 void (*CompressedTexImage3D
)( GLcontext
*ctx
, GLenum target
,
398 GLint level
, GLint internalFormat
,
399 GLsizei width
, GLsizei height
, GLsizei depth
,
401 GLsizei imageSize
, const GLvoid
*data
,
402 struct gl_texture_object
*texObj
,
403 struct gl_texture_image
*texImage
);
406 * Called by glCompressedTexSubImage1D().
408 * \param target user specified.
409 * \param level user specified.
410 * \param xoffset user specified.
411 * \param yoffset user specified.
412 * \param zoffset user specified.
413 * \param width user specified.
414 * \param height user specified.
415 * \param depth user specified.
416 * \param imageSize user specified.
417 * \param data user specified.
418 * \param texObj is the target texture object.
419 * \param texImage is the target texture image. It will have the texture \p
420 * width, \p height, \p depth, \p border and \p internalFormat information.
422 void (*CompressedTexSubImage1D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
423 GLint xoffset
, GLsizei width
,
425 GLsizei imageSize
, const GLvoid
*data
,
426 struct gl_texture_object
*texObj
,
427 struct gl_texture_image
*texImage
);
429 * Called by glCompressedTexSubImage2D().
431 * \sa dd_function_table::CompressedTexImage3D.
433 void (*CompressedTexSubImage2D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
434 GLint xoffset
, GLint yoffset
,
435 GLsizei width
, GLint height
,
437 GLsizei imageSize
, const GLvoid
*data
,
438 struct gl_texture_object
*texObj
,
439 struct gl_texture_image
*texImage
);
441 * Called by glCompressedTexSubImage3D().
443 * \sa dd_function_table::CompressedTexImage3D.
445 void (*CompressedTexSubImage3D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
446 GLint xoffset
, GLint yoffset
, GLint zoffset
,
447 GLsizei width
, GLint height
, GLint depth
,
449 GLsizei imageSize
, const GLvoid
*data
,
450 struct gl_texture_object
*texObj
,
451 struct gl_texture_image
*texImage
);
455 * Called by glGetCompressedTexImage.
457 void (*GetCompressedTexImage
)(GLcontext
*ctx
, GLenum target
, GLint level
,
459 const struct gl_texture_object
*texObj
,
460 const struct gl_texture_image
*texImage
);
463 * Called to query number of bytes of storage needed to store the
464 * specified compressed texture.
466 GLuint (*CompressedTextureSize
)( GLcontext
*ctx
, GLsizei width
,
467 GLsizei height
, GLsizei depth
,
472 * \name Texture object functions
477 * Called by glBindTexture().
479 void (*BindTexture
)( GLcontext
*ctx
, GLenum target
,
480 struct gl_texture_object
*tObj
);
483 * Called to allocate a new texture object.
484 * A new gl_texture_object should be returned. The driver should
485 * attach to it any device-specific info it needs.
487 struct gl_texture_object
* (*NewTextureObject
)( GLcontext
*ctx
, GLuint name
,
490 * Called when a texture object is about to be deallocated.
492 * Driver should delete the gl_texture_object object and anything
495 void (*DeleteTexture
)( GLcontext
*ctx
, struct gl_texture_object
*tObj
);
498 * Called to allocate a new texture image object.
500 struct gl_texture_image
* (*NewTextureImage
)( GLcontext
*ctx
);
503 * Called to free tImage->Data.
505 void (*FreeTexImageData
)( GLcontext
*ctx
, struct gl_texture_image
*tImage
);
508 * Note: no context argument. This function doesn't initially look
509 * like it belongs here, except that the driver is the only entity
510 * that knows for sure how the texture memory is allocated - via
511 * the above callbacks. There is then an argument that the driver
512 * knows what memcpy paths might be fast. Typically this is invoked with
514 * to -- a pointer into texture memory allocated by NewTextureImage() above.
515 * from -- a pointer into client memory or a mesa temporary.
516 * sz -- nr bytes to copy.
518 void* (*TextureMemCpy
)( void *to
, const void *from
, size_t sz
);
521 * Called by glAreTextureResident().
523 GLboolean (*IsTextureResident
)( GLcontext
*ctx
,
524 struct gl_texture_object
*t
);
527 * Called by glPrioritizeTextures().
529 void (*PrioritizeTexture
)( GLcontext
*ctx
, struct gl_texture_object
*t
,
533 * Called by glActiveTextureARB() to set current texture unit.
535 void (*ActiveTexture
)( GLcontext
*ctx
, GLuint texUnitNumber
);
538 * Called when the texture's color lookup table is changed.
540 * If \p tObj is NULL then the shared texture palette
541 * gl_texture_object::Palette is to be updated.
543 void (*UpdateTexturePalette
)( GLcontext
*ctx
,
544 struct gl_texture_object
*tObj
);
549 * \name Imaging functionality
552 void (*CopyColorTable
)( GLcontext
*ctx
,
553 GLenum target
, GLenum internalformat
,
554 GLint x
, GLint y
, GLsizei width
);
556 void (*CopyColorSubTable
)( GLcontext
*ctx
,
557 GLenum target
, GLsizei start
,
558 GLint x
, GLint y
, GLsizei width
);
560 void (*CopyConvolutionFilter1D
)( GLcontext
*ctx
, GLenum target
,
561 GLenum internalFormat
,
562 GLint x
, GLint y
, GLsizei width
);
564 void (*CopyConvolutionFilter2D
)( GLcontext
*ctx
, GLenum target
,
565 GLenum internalFormat
,
567 GLsizei width
, GLsizei height
);
572 * \name Vertex/fragment program functions
575 /** Bind a vertex/fragment program */
576 void (*BindProgram
)(GLcontext
*ctx
, GLenum target
, struct gl_program
*prog
);
577 /** Allocate a new program */
578 struct gl_program
* (*NewProgram
)(GLcontext
*ctx
, GLenum target
, GLuint id
);
579 /** Delete a program */
580 void (*DeleteProgram
)(GLcontext
*ctx
, struct gl_program
*prog
);
581 /** Notify driver that a program string has been specified. */
582 void (*ProgramStringNotify
)(GLcontext
*ctx
, GLenum target
,
583 struct gl_program
*prog
);
584 /** Get value of a program register during program execution. */
585 void (*GetProgramRegister
)(GLcontext
*ctx
, enum register_file file
,
586 GLuint index
, GLfloat val
[4]);
588 /** Query if program can be loaded onto hardware */
589 GLboolean (*IsProgramNative
)(GLcontext
*ctx
, GLenum target
,
590 struct gl_program
*prog
);
596 * \name State-changing functions.
598 * \note drawing functions are above.
600 * These functions are called by their corresponding OpenGL API functions.
601 * They are \e also called by the gl_PopAttrib() function!!!
602 * May add more functions like these to the device driver in the future.
605 /** Specify the alpha test function */
606 void (*AlphaFunc
)(GLcontext
*ctx
, GLenum func
, GLfloat ref
);
607 /** Set the blend color */
608 void (*BlendColor
)(GLcontext
*ctx
, const GLfloat color
[4]);
609 /** Set the blend equation */
610 void (*BlendEquationSeparate
)(GLcontext
*ctx
, GLenum modeRGB
, GLenum modeA
);
611 /** Specify pixel arithmetic */
612 void (*BlendFuncSeparate
)(GLcontext
*ctx
,
613 GLenum sfactorRGB
, GLenum dfactorRGB
,
614 GLenum sfactorA
, GLenum dfactorA
);
615 /** Specify clear values for the color buffers */
616 void (*ClearColor
)(GLcontext
*ctx
, const GLfloat color
[4]);
617 /** Specify the clear value for the depth buffer */
618 void (*ClearDepth
)(GLcontext
*ctx
, GLclampd d
);
619 /** Specify the clear value for the color index buffers */
620 void (*ClearIndex
)(GLcontext
*ctx
, GLuint index
);
621 /** Specify the clear value for the stencil buffer */
622 void (*ClearStencil
)(GLcontext
*ctx
, GLint s
);
623 /** Specify a plane against which all geometry is clipped */
624 void (*ClipPlane
)(GLcontext
*ctx
, GLenum plane
, const GLfloat
*equation
);
625 /** Enable and disable writing of frame buffer color components */
626 void (*ColorMask
)(GLcontext
*ctx
, GLboolean rmask
, GLboolean gmask
,
627 GLboolean bmask
, GLboolean amask
);
628 /** Cause a material color to track the current color */
629 void (*ColorMaterial
)(GLcontext
*ctx
, GLenum face
, GLenum mode
);
630 /** Specify whether front- or back-facing facets can be culled */
631 void (*CullFace
)(GLcontext
*ctx
, GLenum mode
);
632 /** Define front- and back-facing polygons */
633 void (*FrontFace
)(GLcontext
*ctx
, GLenum mode
);
634 /** Specify the value used for depth buffer comparisons */
635 void (*DepthFunc
)(GLcontext
*ctx
, GLenum func
);
636 /** Enable or disable writing into the depth buffer */
637 void (*DepthMask
)(GLcontext
*ctx
, GLboolean flag
);
638 /** Specify mapping of depth values from NDC to window coordinates */
639 void (*DepthRange
)(GLcontext
*ctx
, GLclampd nearval
, GLclampd farval
);
640 /** Specify the current buffer for writing */
641 void (*DrawBuffer
)( GLcontext
*ctx
, GLenum buffer
);
642 /** Specify the buffers for writing for fragment programs*/
643 void (*DrawBuffers
)( GLcontext
*ctx
, GLsizei n
, const GLenum
*buffers
);
644 /** Enable or disable server-side gl capabilities */
645 void (*Enable
)(GLcontext
*ctx
, GLenum cap
, GLboolean state
);
646 /** Specify fog parameters */
647 void (*Fogfv
)(GLcontext
*ctx
, GLenum pname
, const GLfloat
*params
);
648 /** Specify implementation-specific hints */
649 void (*Hint
)(GLcontext
*ctx
, GLenum target
, GLenum mode
);
650 /** Control the writing of individual bits in the color index buffers */
651 void (*IndexMask
)(GLcontext
*ctx
, GLuint mask
);
652 /** Set light source parameters.
653 * Note: for GL_POSITION and GL_SPOT_DIRECTION, params will have already
654 * been transformed to eye-space.
656 void (*Lightfv
)(GLcontext
*ctx
, GLenum light
,
657 GLenum pname
, const GLfloat
*params
);
658 /** Set the lighting model parameters */
659 void (*LightModelfv
)(GLcontext
*ctx
, GLenum pname
, const GLfloat
*params
);
660 /** Specify the line stipple pattern */
661 void (*LineStipple
)(GLcontext
*ctx
, GLint factor
, GLushort pattern
);
662 /** Specify the width of rasterized lines */
663 void (*LineWidth
)(GLcontext
*ctx
, GLfloat width
);
664 /** Specify a logical pixel operation for color index rendering */
665 void (*LogicOpcode
)(GLcontext
*ctx
, GLenum opcode
);
666 void (*PointParameterfv
)(GLcontext
*ctx
, GLenum pname
,
667 const GLfloat
*params
);
668 /** Specify the diameter of rasterized points */
669 void (*PointSize
)(GLcontext
*ctx
, GLfloat size
);
670 /** Select a polygon rasterization mode */
671 void (*PolygonMode
)(GLcontext
*ctx
, GLenum face
, GLenum mode
);
672 /** Set the scale and units used to calculate depth values */
673 void (*PolygonOffset
)(GLcontext
*ctx
, GLfloat factor
, GLfloat units
);
674 /** Set the polygon stippling pattern */
675 void (*PolygonStipple
)(GLcontext
*ctx
, const GLubyte
*mask
);
676 /* Specifies the current buffer for reading */
677 void (*ReadBuffer
)( GLcontext
*ctx
, GLenum buffer
);
678 /** Set rasterization mode */
679 void (*RenderMode
)(GLcontext
*ctx
, GLenum mode
);
680 /** Define the scissor box */
681 void (*Scissor
)(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei w
, GLsizei h
);
682 /** Select flat or smooth shading */
683 void (*ShadeModel
)(GLcontext
*ctx
, GLenum mode
);
684 /** OpenGL 2.0 two-sided StencilFunc */
685 void (*StencilFuncSeparate
)(GLcontext
*ctx
, GLenum face
, GLenum func
,
686 GLint ref
, GLuint mask
);
687 /** OpenGL 2.0 two-sided StencilMask */
688 void (*StencilMaskSeparate
)(GLcontext
*ctx
, GLenum face
, GLuint mask
);
689 /** OpenGL 2.0 two-sided StencilOp */
690 void (*StencilOpSeparate
)(GLcontext
*ctx
, GLenum face
, GLenum fail
,
691 GLenum zfail
, GLenum zpass
);
692 /** Control the generation of texture coordinates */
693 void (*TexGen
)(GLcontext
*ctx
, GLenum coord
, GLenum pname
,
694 const GLfloat
*params
);
695 /** Set texture environment parameters */
696 void (*TexEnv
)(GLcontext
*ctx
, GLenum target
, GLenum pname
,
697 const GLfloat
*param
);
698 /** Set texture parameters */
699 void (*TexParameter
)(GLcontext
*ctx
, GLenum target
,
700 struct gl_texture_object
*texObj
,
701 GLenum pname
, const GLfloat
*params
);
702 void (*TextureMatrix
)(GLcontext
*ctx
, GLuint unit
, const GLmatrix
*mat
);
703 /** Set the viewport */
704 void (*Viewport
)(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei w
, GLsizei h
);
709 * \name Vertex array functions
711 * Called by the corresponding OpenGL functions.
714 void (*VertexPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
715 GLsizei stride
, const GLvoid
*ptr
);
716 void (*NormalPointer
)(GLcontext
*ctx
, GLenum type
,
717 GLsizei stride
, const GLvoid
*ptr
);
718 void (*ColorPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
719 GLsizei stride
, const GLvoid
*ptr
);
720 void (*FogCoordPointer
)(GLcontext
*ctx
, GLenum type
,
721 GLsizei stride
, const GLvoid
*ptr
);
722 void (*IndexPointer
)(GLcontext
*ctx
, GLenum type
,
723 GLsizei stride
, const GLvoid
*ptr
);
724 void (*SecondaryColorPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
725 GLsizei stride
, const GLvoid
*ptr
);
726 void (*TexCoordPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
727 GLsizei stride
, const GLvoid
*ptr
);
728 void (*EdgeFlagPointer
)(GLcontext
*ctx
, GLsizei stride
, const GLvoid
*ptr
);
729 void (*VertexAttribPointer
)(GLcontext
*ctx
, GLuint index
, GLint size
,
730 GLenum type
, GLsizei stride
, const GLvoid
*ptr
);
731 void (*LockArraysEXT
)( GLcontext
*ctx
, GLint first
, GLsizei count
);
732 void (*UnlockArraysEXT
)( GLcontext
*ctx
);
737 * \name State-query functions
739 * Return GL_TRUE if query was completed, GL_FALSE otherwise.
742 /** Return the value or values of a selected parameter */
743 GLboolean (*GetBooleanv
)(GLcontext
*ctx
, GLenum pname
, GLboolean
*result
);
744 /** Return the value or values of a selected parameter */
745 GLboolean (*GetDoublev
)(GLcontext
*ctx
, GLenum pname
, GLdouble
*result
);
746 /** Return the value or values of a selected parameter */
747 GLboolean (*GetFloatv
)(GLcontext
*ctx
, GLenum pname
, GLfloat
*result
);
748 /** Return the value or values of a selected parameter */
749 GLboolean (*GetIntegerv
)(GLcontext
*ctx
, GLenum pname
, GLint
*result
);
750 /** Return the value or values of a selected parameter */
751 GLboolean (*GetPointerv
)(GLcontext
*ctx
, GLenum pname
, GLvoid
**result
);
756 * \name Vertex/pixel buffer object functions
758 #if FEATURE_ARB_vertex_buffer_object
760 void (*BindBuffer
)( GLcontext
*ctx
, GLenum target
,
761 struct gl_buffer_object
*obj
);
763 struct gl_buffer_object
* (*NewBufferObject
)( GLcontext
*ctx
, GLuint buffer
,
766 void (*DeleteBuffer
)( GLcontext
*ctx
, struct gl_buffer_object
*obj
);
768 void (*BufferData
)( GLcontext
*ctx
, GLenum target
, GLsizeiptrARB size
,
769 const GLvoid
*data
, GLenum usage
,
770 struct gl_buffer_object
*obj
);
772 void (*BufferSubData
)( GLcontext
*ctx
, GLenum target
, GLintptrARB offset
,
773 GLsizeiptrARB size
, const GLvoid
*data
,
774 struct gl_buffer_object
*obj
);
776 void (*GetBufferSubData
)( GLcontext
*ctx
, GLenum target
,
777 GLintptrARB offset
, GLsizeiptrARB size
,
778 GLvoid
*data
, struct gl_buffer_object
*obj
);
780 void * (*MapBuffer
)( GLcontext
*ctx
, GLenum target
, GLenum access
,
781 struct gl_buffer_object
*obj
);
783 GLboolean (*UnmapBuffer
)( GLcontext
*ctx
, GLenum target
,
784 struct gl_buffer_object
*obj
);
789 * \name Functions for GL_EXT_framebuffer_object
791 #if FEATURE_EXT_framebuffer_object
793 struct gl_framebuffer
* (*NewFramebuffer
)(GLcontext
*ctx
, GLuint name
);
794 struct gl_renderbuffer
* (*NewRenderbuffer
)(GLcontext
*ctx
, GLuint name
);
795 void (*BindFramebuffer
)(GLcontext
*ctx
, GLenum target
,
796 struct gl_framebuffer
*fb
, struct gl_framebuffer
*fbread
);
797 void (*FramebufferRenderbuffer
)(GLcontext
*ctx
,
798 struct gl_framebuffer
*fb
,
800 struct gl_renderbuffer
*rb
);
801 void (*RenderTexture
)(GLcontext
*ctx
,
802 struct gl_framebuffer
*fb
,
803 struct gl_renderbuffer_attachment
*att
);
804 void (*FinishRenderTexture
)(GLcontext
*ctx
,
805 struct gl_renderbuffer_attachment
*att
);
808 #if FEATURE_EXT_framebuffer_blit
809 void (*BlitFramebuffer
)(GLcontext
*ctx
,
810 GLint srcX0
, GLint srcY0
, GLint srcX1
, GLint srcY1
,
811 GLint dstX0
, GLint dstY0
, GLint dstX1
, GLint dstY1
,
812 GLbitfield mask
, GLenum filter
);
816 * \name Query objects
819 struct gl_query_object
* (*NewQueryObject
)(GLcontext
*ctx
, GLuint id
);
820 void (*DeleteQuery
)(GLcontext
*ctx
, struct gl_query_object
*q
);
821 void (*BeginQuery
)(GLcontext
*ctx
, struct gl_query_object
*q
);
822 void (*EndQuery
)(GLcontext
*ctx
, struct gl_query_object
*q
);
823 void (*CheckQuery
)(GLcontext
*ctx
, struct gl_query_object
*q
);
824 void (*WaitQuery
)(GLcontext
*ctx
, struct gl_query_object
*q
);
829 * \name Vertex Array objects
832 struct gl_array_object
* (*NewArrayObject
)(GLcontext
*ctx
, GLuint id
);
833 void (*DeleteArrayObject
)(GLcontext
*ctx
, struct gl_array_object
*obj
);
834 void (*BindArrayObject
)(GLcontext
*ctx
, struct gl_array_object
*obj
);
838 * \name GLSL-related functions (ARB extensions and OpenGL 2.x)
841 void (*AttachShader
)(GLcontext
*ctx
, GLuint program
, GLuint shader
);
842 void (*BindAttribLocation
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
843 const GLcharARB
*name
);
844 void (*CompileShader
)(GLcontext
*ctx
, GLuint shader
);
845 GLuint (*CreateShader
)(GLcontext
*ctx
, GLenum type
);
846 GLuint (*CreateProgram
)(GLcontext
*ctx
);
847 void (*DeleteProgram2
)(GLcontext
*ctx
, GLuint program
);
848 void (*DeleteShader
)(GLcontext
*ctx
, GLuint shader
);
849 void (*DetachShader
)(GLcontext
*ctx
, GLuint program
, GLuint shader
);
850 void (*GetActiveAttrib
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
851 GLsizei maxLength
, GLsizei
* length
, GLint
* size
,
852 GLenum
* type
, GLcharARB
* name
);
853 void (*GetActiveUniform
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
854 GLsizei maxLength
, GLsizei
*length
, GLint
*size
,
855 GLenum
*type
, GLcharARB
*name
);
856 void (*GetAttachedShaders
)(GLcontext
*ctx
, GLuint program
, GLsizei maxCount
,
857 GLsizei
*count
, GLuint
*obj
);
858 GLint (*GetAttribLocation
)(GLcontext
*ctx
, GLuint program
,
859 const GLcharARB
*name
);
860 GLuint (*GetHandle
)(GLcontext
*ctx
, GLenum pname
);
861 void (*GetProgramiv
)(GLcontext
*ctx
, GLuint program
,
862 GLenum pname
, GLint
*params
);
863 void (*GetProgramInfoLog
)(GLcontext
*ctx
, GLuint program
, GLsizei bufSize
,
864 GLsizei
*length
, GLchar
*infoLog
);
865 void (*GetShaderiv
)(GLcontext
*ctx
, GLuint shader
,
866 GLenum pname
, GLint
*params
);
867 void (*GetShaderInfoLog
)(GLcontext
*ctx
, GLuint shader
, GLsizei bufSize
,
868 GLsizei
*length
, GLchar
*infoLog
);
869 void (*GetShaderSource
)(GLcontext
*ctx
, GLuint shader
, GLsizei maxLength
,
870 GLsizei
*length
, GLcharARB
*sourceOut
);
871 void (*GetUniformfv
)(GLcontext
*ctx
, GLuint program
, GLint location
,
873 GLint (*GetUniformLocation
)(GLcontext
*ctx
, GLuint program
,
874 const GLcharARB
*name
);
875 GLboolean (*IsProgram
)(GLcontext
*ctx
, GLuint name
);
876 GLboolean (*IsShader
)(GLcontext
*ctx
, GLuint name
);
877 void (*LinkProgram
)(GLcontext
*ctx
, GLuint program
);
878 void (*ShaderSource
)(GLcontext
*ctx
, GLuint shader
, const GLchar
*source
);
879 void (*Uniform
)(GLcontext
*ctx
, GLint location
, GLsizei count
,
880 const GLvoid
*values
, GLenum type
);
881 void (*UniformMatrix
)(GLcontext
*ctx
, GLint cols
, GLint rows
,
882 GLenum matrixType
, GLint location
, GLsizei count
,
883 GLboolean transpose
, const GLfloat
*values
);
884 void (*UseProgram
)(GLcontext
*ctx
, GLuint program
);
885 void (*ValidateProgram
)(GLcontext
*ctx
, GLuint program
);
886 /* XXX many more to come */
891 * \name Support for multiple T&L engines
896 * Bitmask of state changes that require the current T&L module to be
897 * validated, using ValidateTnlModule() below.
902 * Validate the current T&L module.
904 * This is called directly after UpdateState() when a state change that has
905 * occurred matches the dd_function_table::NeedValidate bitmask above. This
906 * ensures all computed values are up to date, thus allowing the driver to
907 * decide if the current T&L module needs to be swapped out.
909 * This must be non-NULL if a driver installs a custom T&L module and sets
910 * the dd_function_table::NeedValidate bitmask, but may be NULL otherwise.
912 void (*ValidateTnlModule
)( GLcontext
*ctx
, GLuint new_state
);
915 #define PRIM_OUTSIDE_BEGIN_END (GL_POLYGON+1)
916 #define PRIM_INSIDE_UNKNOWN_PRIM (GL_POLYGON+2)
917 #define PRIM_UNKNOWN (GL_POLYGON+3)
920 * Set by the driver-supplied T&L engine.
922 * Set to PRIM_OUTSIDE_BEGIN_END when outside glBegin()/glEnd().
924 GLuint CurrentExecPrimitive
;
927 * Current state of an in-progress compilation.
929 * May take on any of the additional values PRIM_OUTSIDE_BEGIN_END,
930 * PRIM_INSIDE_UNKNOWN_PRIM or PRIM_UNKNOWN defined above.
932 GLuint CurrentSavePrimitive
;
935 #define FLUSH_STORED_VERTICES 0x1
936 #define FLUSH_UPDATE_CURRENT 0x2
938 * Set by the driver-supplied T&L engine whenever vertices are buffered
939 * between glBegin()/glEnd() objects or __GLcontextRec::Current is not
942 * The dd_function_table::FlushVertices call below may be used to resolve
946 GLuint SaveNeedFlush
;
949 * If inside glBegin()/glEnd(), it should ASSERT(0). Otherwise, if
950 * FLUSH_STORED_VERTICES bit in \p flags is set flushes any buffered
951 * vertices, if FLUSH_UPDATE_CURRENT bit is set updates
952 * __GLcontextRec::Current and gl_light_attrib::Material
954 * Note that the default T&L engine never clears the
955 * FLUSH_UPDATE_CURRENT bit, even after performing the update.
957 void (*FlushVertices
)( GLcontext
*ctx
, GLuint flags
);
958 void (*SaveFlushVertices
)( GLcontext
*ctx
);
961 * Give the driver the opportunity to hook in its own vtxfmt for
962 * compiling optimized display lists. This is called on each valid
963 * glBegin() during list compilation.
965 GLboolean (*NotifySaveBegin
)( GLcontext
*ctx
, GLenum mode
);
968 * Notify driver that the special derived value _NeedEyeCoords has
971 void (*LightingSpaceChange
)( GLcontext
*ctx
);
974 * Called by glNewList().
976 * Let the T&L component know what is going on with display lists
977 * in time to make changes to dispatch tables, etc.
979 void (*NewList
)( GLcontext
*ctx
, GLuint list
, GLenum mode
);
981 * Called by glEndList().
983 * \sa dd_function_table::NewList.
985 void (*EndList
)( GLcontext
*ctx
);
988 * Called by glCallList(s).
990 * Notify the T&L component before and after calling a display list.
992 void (*BeginCallList
)( GLcontext
*ctx
,
993 struct mesa_display_list
*dlist
);
995 * Called by glEndCallList().
997 * \sa dd_function_table::BeginCallList.
999 void (*EndCallList
)( GLcontext
*ctx
);
1005 * Transform/Clip/Lighting interface
1007 * Drivers present a reduced set of the functions possible in
1008 * glBegin()/glEnd() objects. Core mesa provides translation stubs for the
1009 * remaining functions to map down to these entry points.
1011 * These are the initial values to be installed into dispatch by
1012 * mesa. If the T&L driver wants to modify the dispatch table
1013 * while installed, it must do so itself. It would be possible for
1014 * the vertexformat to install it's own initial values for these
1015 * functions, but this way there is an obvious list of what is
1016 * expected of the driver.
1018 * If the driver wants to hook in entry points other than those
1019 * listed, it must restore them to their original values in
1020 * the disable() callback, below.
1027 void (GLAPIENTRYP ArrayElement
)( GLint
); /* NOTE */
1028 void (GLAPIENTRYP Color3f
)( GLfloat
, GLfloat
, GLfloat
);
1029 void (GLAPIENTRYP Color3fv
)( const GLfloat
* );
1030 void (GLAPIENTRYP Color4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1031 void (GLAPIENTRYP Color4fv
)( const GLfloat
* );
1032 void (GLAPIENTRYP EdgeFlag
)( GLboolean
);
1033 void (GLAPIENTRYP EvalCoord1f
)( GLfloat
); /* NOTE */
1034 void (GLAPIENTRYP EvalCoord1fv
)( const GLfloat
* ); /* NOTE */
1035 void (GLAPIENTRYP EvalCoord2f
)( GLfloat
, GLfloat
); /* NOTE */
1036 void (GLAPIENTRYP EvalCoord2fv
)( const GLfloat
* ); /* NOTE */
1037 void (GLAPIENTRYP EvalPoint1
)( GLint
); /* NOTE */
1038 void (GLAPIENTRYP EvalPoint2
)( GLint
, GLint
); /* NOTE */
1039 void (GLAPIENTRYP FogCoordfEXT
)( GLfloat
);
1040 void (GLAPIENTRYP FogCoordfvEXT
)( const GLfloat
* );
1041 void (GLAPIENTRYP Indexf
)( GLfloat
);
1042 void (GLAPIENTRYP Indexfv
)( const GLfloat
* );
1043 void (GLAPIENTRYP Materialfv
)( GLenum face
, GLenum pname
, const GLfloat
* ); /* NOTE */
1044 void (GLAPIENTRYP MultiTexCoord1fARB
)( GLenum
, GLfloat
);
1045 void (GLAPIENTRYP MultiTexCoord1fvARB
)( GLenum
, const GLfloat
* );
1046 void (GLAPIENTRYP MultiTexCoord2fARB
)( GLenum
, GLfloat
, GLfloat
);
1047 void (GLAPIENTRYP MultiTexCoord2fvARB
)( GLenum
, const GLfloat
* );
1048 void (GLAPIENTRYP MultiTexCoord3fARB
)( GLenum
, GLfloat
, GLfloat
, GLfloat
);
1049 void (GLAPIENTRYP MultiTexCoord3fvARB
)( GLenum
, const GLfloat
* );
1050 void (GLAPIENTRYP MultiTexCoord4fARB
)( GLenum
, GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1051 void (GLAPIENTRYP MultiTexCoord4fvARB
)( GLenum
, const GLfloat
* );
1052 void (GLAPIENTRYP Normal3f
)( GLfloat
, GLfloat
, GLfloat
);
1053 void (GLAPIENTRYP Normal3fv
)( const GLfloat
* );
1054 void (GLAPIENTRYP SecondaryColor3fEXT
)( GLfloat
, GLfloat
, GLfloat
);
1055 void (GLAPIENTRYP SecondaryColor3fvEXT
)( const GLfloat
* );
1056 void (GLAPIENTRYP TexCoord1f
)( GLfloat
);
1057 void (GLAPIENTRYP TexCoord1fv
)( const GLfloat
* );
1058 void (GLAPIENTRYP TexCoord2f
)( GLfloat
, GLfloat
);
1059 void (GLAPIENTRYP TexCoord2fv
)( const GLfloat
* );
1060 void (GLAPIENTRYP TexCoord3f
)( GLfloat
, GLfloat
, GLfloat
);
1061 void (GLAPIENTRYP TexCoord3fv
)( const GLfloat
* );
1062 void (GLAPIENTRYP TexCoord4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1063 void (GLAPIENTRYP TexCoord4fv
)( const GLfloat
* );
1064 void (GLAPIENTRYP Vertex2f
)( GLfloat
, GLfloat
);
1065 void (GLAPIENTRYP Vertex2fv
)( const GLfloat
* );
1066 void (GLAPIENTRYP Vertex3f
)( GLfloat
, GLfloat
, GLfloat
);
1067 void (GLAPIENTRYP Vertex3fv
)( const GLfloat
* );
1068 void (GLAPIENTRYP Vertex4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1069 void (GLAPIENTRYP Vertex4fv
)( const GLfloat
* );
1070 void (GLAPIENTRYP CallList
)( GLuint
); /* NOTE */
1071 void (GLAPIENTRYP CallLists
)( GLsizei
, GLenum
, const GLvoid
* ); /* NOTE */
1072 void (GLAPIENTRYP Begin
)( GLenum
);
1073 void (GLAPIENTRYP End
)( void );
1074 /* GL_NV_vertex_program */
1075 void (GLAPIENTRYP VertexAttrib1fNV
)( GLuint index
, GLfloat x
);
1076 void (GLAPIENTRYP VertexAttrib1fvNV
)( GLuint index
, const GLfloat
*v
);
1077 void (GLAPIENTRYP VertexAttrib2fNV
)( GLuint index
, GLfloat x
, GLfloat y
);
1078 void (GLAPIENTRYP VertexAttrib2fvNV
)( GLuint index
, const GLfloat
*v
);
1079 void (GLAPIENTRYP VertexAttrib3fNV
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
);
1080 void (GLAPIENTRYP VertexAttrib3fvNV
)( GLuint index
, const GLfloat
*v
);
1081 void (GLAPIENTRYP VertexAttrib4fNV
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
, GLfloat w
);
1082 void (GLAPIENTRYP VertexAttrib4fvNV
)( GLuint index
, const GLfloat
*v
);
1083 #if FEATURE_ARB_vertex_program
1084 void (GLAPIENTRYP VertexAttrib1fARB
)( GLuint index
, GLfloat x
);
1085 void (GLAPIENTRYP VertexAttrib1fvARB
)( GLuint index
, const GLfloat
*v
);
1086 void (GLAPIENTRYP VertexAttrib2fARB
)( GLuint index
, GLfloat x
, GLfloat y
);
1087 void (GLAPIENTRYP VertexAttrib2fvARB
)( GLuint index
, const GLfloat
*v
);
1088 void (GLAPIENTRYP VertexAttrib3fARB
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
);
1089 void (GLAPIENTRYP VertexAttrib3fvARB
)( GLuint index
, const GLfloat
*v
);
1090 void (GLAPIENTRYP VertexAttrib4fARB
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
, GLfloat w
);
1091 void (GLAPIENTRYP VertexAttrib4fvARB
)( GLuint index
, const GLfloat
*v
);
1097 void (GLAPIENTRYP Rectf
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1103 void (GLAPIENTRYP DrawArrays
)( GLenum mode
, GLint start
, GLsizei count
);
1104 void (GLAPIENTRYP DrawElements
)( GLenum mode
, GLsizei count
, GLenum type
,
1105 const GLvoid
*indices
);
1106 void (GLAPIENTRYP DrawRangeElements
)( GLenum mode
, GLuint start
,
1107 GLuint end
, GLsizei count
,
1108 GLenum type
, const GLvoid
*indices
);
1114 * If you don't support eval, fallback to the default vertex format
1115 * on receiving an eval call and use the pipeline mechanism to
1116 * provide partial T&L acceleration.
1118 * Mesa will provide a set of helper functions to do eval within
1119 * accelerated vertex formats, eventually...
1122 void (GLAPIENTRYP EvalMesh1
)( GLenum mode
, GLint i1
, GLint i2
);
1123 void (GLAPIENTRYP EvalMesh2
)( GLenum mode
, GLint i1
, GLint i2
, GLint j1
, GLint j2
);
1129 #endif /* DD_INCLUDED */