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 * \name Image-related functions
119 * Called by glDrawPixels().
120 * \p unpack describes how to unpack the source image data.
122 void (*DrawPixels
)( GLcontext
*ctx
,
123 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
124 GLenum format
, GLenum type
,
125 const struct gl_pixelstore_attrib
*unpack
,
126 const GLvoid
*pixels
);
129 * Called by glReadPixels().
131 void (*ReadPixels
)( GLcontext
*ctx
,
132 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
133 GLenum format
, GLenum type
,
134 const struct gl_pixelstore_attrib
*unpack
,
138 * Called by glCopyPixels().
140 void (*CopyPixels
)( GLcontext
*ctx
, GLint srcx
, GLint srcy
,
141 GLsizei width
, GLsizei height
,
142 GLint dstx
, GLint dsty
, GLenum type
);
145 * Called by glBitmap().
147 void (*Bitmap
)( GLcontext
*ctx
,
148 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
149 const struct gl_pixelstore_attrib
*unpack
,
150 const GLubyte
*bitmap
);
155 * \name Texture image functions
160 * Choose texture format.
162 * This is called by the \c _mesa_store_tex[sub]image[123]d() fallback
163 * functions. The driver should examine \p internalFormat and return a
164 * pointer to an appropriate gl_texture_format.
166 const struct gl_texture_format
*(*ChooseTextureFormat
)( GLcontext
*ctx
,
167 GLint internalFormat
, GLenum srcFormat
, GLenum srcType
);
170 * Called by glTexImage1D().
172 * \param target user specified.
173 * \param format user specified.
174 * \param type user specified.
175 * \param pixels user specified.
176 * \param packing indicates the image packing of pixels.
177 * \param texObj is the target texture object.
178 * \param texImage is the target texture image. It will have the texture \p
179 * width, \p height, \p depth, \p border and \p internalFormat information.
181 * \p retainInternalCopy is returned by this function and indicates whether
182 * core Mesa should keep an internal copy of the texture image.
184 * Drivers should call a fallback routine from texstore.c if needed.
186 void (*TexImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
187 GLint internalFormat
,
188 GLint width
, GLint border
,
189 GLenum format
, GLenum type
, const GLvoid
*pixels
,
190 const struct gl_pixelstore_attrib
*packing
,
191 struct gl_texture_object
*texObj
,
192 struct gl_texture_image
*texImage
);
195 * Called by glTexImage2D().
197 * \sa dd_function_table::TexImage1D.
199 void (*TexImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
200 GLint internalFormat
,
201 GLint width
, GLint height
, GLint border
,
202 GLenum format
, GLenum type
, const GLvoid
*pixels
,
203 const struct gl_pixelstore_attrib
*packing
,
204 struct gl_texture_object
*texObj
,
205 struct gl_texture_image
*texImage
);
208 * Called by glTexImage3D().
210 * \sa dd_function_table::TexImage1D.
212 void (*TexImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
213 GLint internalFormat
,
214 GLint width
, GLint height
, GLint depth
, GLint border
,
215 GLenum format
, GLenum type
, const GLvoid
*pixels
,
216 const struct gl_pixelstore_attrib
*packing
,
217 struct gl_texture_object
*texObj
,
218 struct gl_texture_image
*texImage
);
221 * Called by glTexSubImage1D().
223 * \param target user specified.
224 * \param level user specified.
225 * \param xoffset user specified.
226 * \param yoffset user specified.
227 * \param zoffset user specified.
228 * \param width user specified.
229 * \param height user specified.
230 * \param depth user specified.
231 * \param format user specified.
232 * \param type user specified.
233 * \param pixels user specified.
234 * \param packing indicates the image packing of pixels.
235 * \param texObj is the target texture object.
236 * \param texImage is the target texture image. It will have the texture \p
237 * width, \p height, \p border and \p internalFormat information.
239 * The driver should use a fallback routine from texstore.c if needed.
241 void (*TexSubImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
242 GLint xoffset
, GLsizei width
,
243 GLenum format
, GLenum type
,
244 const GLvoid
*pixels
,
245 const struct gl_pixelstore_attrib
*packing
,
246 struct gl_texture_object
*texObj
,
247 struct gl_texture_image
*texImage
);
250 * Called by glTexSubImage2D().
252 * \sa dd_function_table::TexSubImage1D.
254 void (*TexSubImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
255 GLint xoffset
, GLint yoffset
,
256 GLsizei width
, GLsizei height
,
257 GLenum format
, GLenum type
,
258 const GLvoid
*pixels
,
259 const struct gl_pixelstore_attrib
*packing
,
260 struct gl_texture_object
*texObj
,
261 struct gl_texture_image
*texImage
);
264 * Called by glTexSubImage3D().
266 * \sa dd_function_table::TexSubImage1D.
268 void (*TexSubImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
269 GLint xoffset
, GLint yoffset
, GLint zoffset
,
270 GLsizei width
, GLsizei height
, GLint depth
,
271 GLenum format
, GLenum type
,
272 const GLvoid
*pixels
,
273 const struct gl_pixelstore_attrib
*packing
,
274 struct gl_texture_object
*texObj
,
275 struct gl_texture_image
*texImage
);
278 * Called by glGetTexImage().
280 void (*GetTexImage
)( GLcontext
*ctx
, GLenum target
, GLint level
,
281 GLenum format
, GLenum type
, GLvoid
*pixels
,
282 struct gl_texture_object
*texObj
,
283 struct gl_texture_image
*texImage
);
286 * Called by glCopyTexImage1D().
288 * Drivers should use a fallback routine from texstore.c if needed.
290 void (*CopyTexImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
291 GLenum internalFormat
, GLint x
, GLint y
,
292 GLsizei width
, GLint border
);
295 * Called by glCopyTexImage2D().
297 * Drivers should use a fallback routine from texstore.c if needed.
299 void (*CopyTexImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
300 GLenum internalFormat
, GLint x
, GLint y
,
301 GLsizei width
, GLsizei height
, GLint border
);
304 * Called by glCopyTexSubImage1D().
306 * Drivers should use a fallback routine from texstore.c if needed.
308 void (*CopyTexSubImage1D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
310 GLint x
, GLint y
, GLsizei width
);
312 * Called by glCopyTexSubImage2D().
314 * Drivers should use a fallback routine from texstore.c if needed.
316 void (*CopyTexSubImage2D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
317 GLint xoffset
, GLint yoffset
,
319 GLsizei width
, GLsizei height
);
321 * Called by glCopyTexSubImage3D().
323 * Drivers should use a fallback routine from texstore.c if needed.
325 void (*CopyTexSubImage3D
)( GLcontext
*ctx
, GLenum target
, GLint level
,
326 GLint xoffset
, GLint yoffset
, GLint zoffset
,
328 GLsizei width
, GLsizei height
);
331 * Called by glTexImage[123]D when user specifies a proxy texture
334 * \return GL_TRUE if the proxy test passes, or GL_FALSE if the test fails.
336 GLboolean (*TestProxyTexImage
)(GLcontext
*ctx
, GLenum target
,
337 GLint level
, GLint internalFormat
,
338 GLenum format
, GLenum type
,
339 GLint width
, GLint height
,
340 GLint depth
, GLint border
);
345 * \name Compressed texture functions
350 * Called by glCompressedTexImage1D().
352 * \param target user specified.
353 * \param format user specified.
354 * \param type user specified.
355 * \param pixels user specified.
356 * \param packing indicates the image packing of pixels.
357 * \param texObj is the target texture object.
358 * \param texImage is the target texture image. It will have the texture \p
359 * width, \p height, \p depth, \p border and \p internalFormat information.
361 * \a retainInternalCopy is returned by this function and indicates whether
362 * core Mesa should keep an internal copy of the texture image.
364 void (*CompressedTexImage1D
)( GLcontext
*ctx
, GLenum target
,
365 GLint level
, GLint internalFormat
,
366 GLsizei width
, GLint border
,
367 GLsizei imageSize
, const GLvoid
*data
,
368 struct gl_texture_object
*texObj
,
369 struct gl_texture_image
*texImage
);
371 * Called by glCompressedTexImage2D().
373 * \sa dd_function_table::CompressedTexImage1D.
375 void (*CompressedTexImage2D
)( GLcontext
*ctx
, GLenum target
,
376 GLint level
, GLint internalFormat
,
377 GLsizei width
, GLsizei height
, GLint border
,
378 GLsizei imageSize
, const GLvoid
*data
,
379 struct gl_texture_object
*texObj
,
380 struct gl_texture_image
*texImage
);
382 * Called by glCompressedTexImage3D().
384 * \sa dd_function_table::CompressedTexImage3D.
386 void (*CompressedTexImage3D
)( GLcontext
*ctx
, GLenum target
,
387 GLint level
, GLint internalFormat
,
388 GLsizei width
, GLsizei height
, GLsizei depth
,
390 GLsizei imageSize
, const GLvoid
*data
,
391 struct gl_texture_object
*texObj
,
392 struct gl_texture_image
*texImage
);
395 * Called by glCompressedTexSubImage1D().
397 * \param target user specified.
398 * \param level user specified.
399 * \param xoffset user specified.
400 * \param yoffset user specified.
401 * \param zoffset user specified.
402 * \param width user specified.
403 * \param height user specified.
404 * \param depth user specified.
405 * \param imageSize user specified.
406 * \param data user specified.
407 * \param texObj is the target texture object.
408 * \param texImage is the target texture image. It will have the texture \p
409 * width, \p height, \p depth, \p border and \p internalFormat information.
411 void (*CompressedTexSubImage1D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
412 GLint xoffset
, GLsizei width
,
414 GLsizei imageSize
, const GLvoid
*data
,
415 struct gl_texture_object
*texObj
,
416 struct gl_texture_image
*texImage
);
418 * Called by glCompressedTexSubImage2D().
420 * \sa dd_function_table::CompressedTexImage3D.
422 void (*CompressedTexSubImage2D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
423 GLint xoffset
, GLint yoffset
,
424 GLsizei width
, GLint height
,
426 GLsizei imageSize
, const GLvoid
*data
,
427 struct gl_texture_object
*texObj
,
428 struct gl_texture_image
*texImage
);
430 * Called by glCompressedTexSubImage3D().
432 * \sa dd_function_table::CompressedTexImage3D.
434 void (*CompressedTexSubImage3D
)(GLcontext
*ctx
, GLenum target
, GLint level
,
435 GLint xoffset
, GLint yoffset
, GLint zoffset
,
436 GLsizei width
, GLint height
, GLint depth
,
438 GLsizei imageSize
, const GLvoid
*data
,
439 struct gl_texture_object
*texObj
,
440 struct gl_texture_image
*texImage
);
444 * Called by glGetCompressedTexImage.
446 void (*GetCompressedTexImage
)(GLcontext
*ctx
, GLenum target
, GLint level
,
448 const struct gl_texture_object
*texObj
,
449 const struct gl_texture_image
*texImage
);
452 * Called to query number of bytes of storage needed to store the
453 * specified compressed texture.
455 GLuint (*CompressedTextureSize
)( GLcontext
*ctx
, GLsizei width
,
456 GLsizei height
, GLsizei depth
,
461 * \name Texture object functions
466 * Called by glBindTexture().
468 void (*BindTexture
)( GLcontext
*ctx
, GLenum target
,
469 struct gl_texture_object
*tObj
);
472 * Called to allocate a new texture object.
473 * A new gl_texture_object should be returned. The driver should
474 * attach to it any device-specific info it needs.
476 struct gl_texture_object
* (*NewTextureObject
)( GLcontext
*ctx
, GLuint name
,
479 * Called when a texture object is about to be deallocated.
481 * Driver should delete the gl_texture_object object and anything
484 void (*DeleteTexture
)( GLcontext
*ctx
, struct gl_texture_object
*tObj
);
487 * Called to allocate a new texture image object.
489 struct gl_texture_image
* (*NewTextureImage
)( GLcontext
*ctx
);
492 * Called to free tImage->Data.
494 void (*FreeTexImageData
)( GLcontext
*ctx
, struct gl_texture_image
*tImage
);
497 * Note: no context argument. This function doesn't initially look
498 * like it belongs here, except that the driver is the only entity
499 * that knows for sure how the texture memory is allocated - via
500 * the above callbacks. There is then an argument that the driver
501 * knows what memcpy paths might be fast. Typically this is invoked with
503 * to -- a pointer into texture memory allocated by NewTextureImage() above.
504 * from -- a pointer into client memory or a mesa temporary.
505 * sz -- nr bytes to copy.
507 void* (*TextureMemCpy
)( void *to
, const void *from
, size_t sz
);
510 * Called by glAreTextureResident().
512 GLboolean (*IsTextureResident
)( GLcontext
*ctx
,
513 struct gl_texture_object
*t
);
516 * Called by glPrioritizeTextures().
518 void (*PrioritizeTexture
)( GLcontext
*ctx
, struct gl_texture_object
*t
,
522 * Called by glActiveTextureARB() to set current texture unit.
524 void (*ActiveTexture
)( GLcontext
*ctx
, GLuint texUnitNumber
);
527 * Called when the texture's color lookup table is changed.
529 * If \p tObj is NULL then the shared texture palette
530 * gl_texture_object::Palette is to be updated.
532 void (*UpdateTexturePalette
)( GLcontext
*ctx
,
533 struct gl_texture_object
*tObj
);
538 * \name Imaging functionality
541 void (*CopyColorTable
)( GLcontext
*ctx
,
542 GLenum target
, GLenum internalformat
,
543 GLint x
, GLint y
, GLsizei width
);
545 void (*CopyColorSubTable
)( GLcontext
*ctx
,
546 GLenum target
, GLsizei start
,
547 GLint x
, GLint y
, GLsizei width
);
549 void (*CopyConvolutionFilter1D
)( GLcontext
*ctx
, GLenum target
,
550 GLenum internalFormat
,
551 GLint x
, GLint y
, GLsizei width
);
553 void (*CopyConvolutionFilter2D
)( GLcontext
*ctx
, GLenum target
,
554 GLenum internalFormat
,
556 GLsizei width
, GLsizei height
);
561 * \name Vertex/fragment program functions
564 /** Bind a vertex/fragment program */
565 void (*BindProgram
)(GLcontext
*ctx
, GLenum target
, struct gl_program
*prog
);
566 /** Allocate a new program */
567 struct gl_program
* (*NewProgram
)(GLcontext
*ctx
, GLenum target
, GLuint id
);
568 /** Delete a program */
569 void (*DeleteProgram
)(GLcontext
*ctx
, struct gl_program
*prog
);
570 /** Notify driver that a program string has been specified. */
571 void (*ProgramStringNotify
)(GLcontext
*ctx
, GLenum target
,
572 struct gl_program
*prog
);
573 /** Get value of a fragment program register during program execution. */
574 void (*GetFragmentProgramRegister
)(GLcontext
*ctx
, enum register_file file
,
575 GLuint index
, GLfloat val
[4]);
577 /** Query if program can be loaded onto hardware */
578 GLboolean (*IsProgramNative
)(GLcontext
*ctx
, GLenum target
,
579 struct gl_program
*prog
);
585 * \name State-changing functions.
587 * \note drawing functions are above.
589 * These functions are called by their corresponding OpenGL API functions.
590 * They are \e also called by the gl_PopAttrib() function!!!
591 * May add more functions like these to the device driver in the future.
594 /** Specify the alpha test function */
595 void (*AlphaFunc
)(GLcontext
*ctx
, GLenum func
, GLfloat ref
);
596 /** Set the blend color */
597 void (*BlendColor
)(GLcontext
*ctx
, const GLfloat color
[4]);
598 /** Set the blend equation */
599 void (*BlendEquationSeparate
)(GLcontext
*ctx
, GLenum modeRGB
, GLenum modeA
);
600 /** Specify pixel arithmetic */
601 void (*BlendFuncSeparate
)(GLcontext
*ctx
,
602 GLenum sfactorRGB
, GLenum dfactorRGB
,
603 GLenum sfactorA
, GLenum dfactorA
);
604 /** Specify clear values for the color buffers */
605 void (*ClearColor
)(GLcontext
*ctx
, const GLfloat color
[4]);
606 /** Specify the clear value for the depth buffer */
607 void (*ClearDepth
)(GLcontext
*ctx
, GLclampd d
);
608 /** Specify the clear value for the color index buffers */
609 void (*ClearIndex
)(GLcontext
*ctx
, GLuint index
);
610 /** Specify the clear value for the stencil buffer */
611 void (*ClearStencil
)(GLcontext
*ctx
, GLint s
);
612 /** Specify a plane against which all geometry is clipped */
613 void (*ClipPlane
)(GLcontext
*ctx
, GLenum plane
, const GLfloat
*equation
);
614 /** Enable and disable writing of frame buffer color components */
615 void (*ColorMask
)(GLcontext
*ctx
, GLboolean rmask
, GLboolean gmask
,
616 GLboolean bmask
, GLboolean amask
);
617 /** Cause a material color to track the current color */
618 void (*ColorMaterial
)(GLcontext
*ctx
, GLenum face
, GLenum mode
);
619 /** Specify whether front- or back-facing facets can be culled */
620 void (*CullFace
)(GLcontext
*ctx
, GLenum mode
);
621 /** Define front- and back-facing polygons */
622 void (*FrontFace
)(GLcontext
*ctx
, GLenum mode
);
623 /** Specify the value used for depth buffer comparisons */
624 void (*DepthFunc
)(GLcontext
*ctx
, GLenum func
);
625 /** Enable or disable writing into the depth buffer */
626 void (*DepthMask
)(GLcontext
*ctx
, GLboolean flag
);
627 /** Specify mapping of depth values from NDC to window coordinates */
628 void (*DepthRange
)(GLcontext
*ctx
, GLclampd nearval
, GLclampd farval
);
629 /** Specify the current buffer for writing */
630 void (*DrawBuffer
)( GLcontext
*ctx
, GLenum buffer
);
631 /** Specify the buffers for writing for fragment programs*/
632 void (*DrawBuffers
)( GLcontext
*ctx
, GLsizei n
, const GLenum
*buffers
);
633 /** Enable or disable server-side gl capabilities */
634 void (*Enable
)(GLcontext
*ctx
, GLenum cap
, GLboolean state
);
635 /** Specify fog parameters */
636 void (*Fogfv
)(GLcontext
*ctx
, GLenum pname
, const GLfloat
*params
);
637 /** Specify implementation-specific hints */
638 void (*Hint
)(GLcontext
*ctx
, GLenum target
, GLenum mode
);
639 /** Control the writing of individual bits in the color index buffers */
640 void (*IndexMask
)(GLcontext
*ctx
, GLuint mask
);
641 /** Set light source parameters.
642 * Note: for GL_POSITION and GL_SPOT_DIRECTION, params will have already
643 * been transformed to eye-space.
645 void (*Lightfv
)(GLcontext
*ctx
, GLenum light
,
646 GLenum pname
, const GLfloat
*params
);
647 /** Set the lighting model parameters */
648 void (*LightModelfv
)(GLcontext
*ctx
, GLenum pname
, const GLfloat
*params
);
649 /** Specify the line stipple pattern */
650 void (*LineStipple
)(GLcontext
*ctx
, GLint factor
, GLushort pattern
);
651 /** Specify the width of rasterized lines */
652 void (*LineWidth
)(GLcontext
*ctx
, GLfloat width
);
653 /** Specify a logical pixel operation for color index rendering */
654 void (*LogicOpcode
)(GLcontext
*ctx
, GLenum opcode
);
655 void (*PointParameterfv
)(GLcontext
*ctx
, GLenum pname
,
656 const GLfloat
*params
);
657 /** Specify the diameter of rasterized points */
658 void (*PointSize
)(GLcontext
*ctx
, GLfloat size
);
659 /** Select a polygon rasterization mode */
660 void (*PolygonMode
)(GLcontext
*ctx
, GLenum face
, GLenum mode
);
661 /** Set the scale and units used to calculate depth values */
662 void (*PolygonOffset
)(GLcontext
*ctx
, GLfloat factor
, GLfloat units
);
663 /** Set the polygon stippling pattern */
664 void (*PolygonStipple
)(GLcontext
*ctx
, const GLubyte
*mask
);
665 /* Specifies the current buffer for reading */
666 void (*ReadBuffer
)( GLcontext
*ctx
, GLenum buffer
);
667 /** Set rasterization mode */
668 void (*RenderMode
)(GLcontext
*ctx
, GLenum mode
);
669 /** Define the scissor box */
670 void (*Scissor
)(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei w
, GLsizei h
);
671 /** Select flat or smooth shading */
672 void (*ShadeModel
)(GLcontext
*ctx
, GLenum mode
);
673 /** OpenGL 2.0 two-sided StencilFunc */
674 void (*StencilFuncSeparate
)(GLcontext
*ctx
, GLenum face
, GLenum func
,
675 GLint ref
, GLuint mask
);
676 /** OpenGL 2.0 two-sided StencilMask */
677 void (*StencilMaskSeparate
)(GLcontext
*ctx
, GLenum face
, GLuint mask
);
678 /** OpenGL 2.0 two-sided StencilOp */
679 void (*StencilOpSeparate
)(GLcontext
*ctx
, GLenum face
, GLenum fail
,
680 GLenum zfail
, GLenum zpass
);
681 /** Control the generation of texture coordinates */
682 void (*TexGen
)(GLcontext
*ctx
, GLenum coord
, GLenum pname
,
683 const GLfloat
*params
);
684 /** Set texture environment parameters */
685 void (*TexEnv
)(GLcontext
*ctx
, GLenum target
, GLenum pname
,
686 const GLfloat
*param
);
687 /** Set texture parameters */
688 void (*TexParameter
)(GLcontext
*ctx
, GLenum target
,
689 struct gl_texture_object
*texObj
,
690 GLenum pname
, const GLfloat
*params
);
691 void (*TextureMatrix
)(GLcontext
*ctx
, GLuint unit
, const GLmatrix
*mat
);
692 /** Set the viewport */
693 void (*Viewport
)(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei w
, GLsizei h
);
698 * \name Vertex array functions
700 * Called by the corresponding OpenGL functions.
703 void (*VertexPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
704 GLsizei stride
, const GLvoid
*ptr
);
705 void (*NormalPointer
)(GLcontext
*ctx
, GLenum type
,
706 GLsizei stride
, const GLvoid
*ptr
);
707 void (*ColorPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
708 GLsizei stride
, const GLvoid
*ptr
);
709 void (*FogCoordPointer
)(GLcontext
*ctx
, GLenum type
,
710 GLsizei stride
, const GLvoid
*ptr
);
711 void (*IndexPointer
)(GLcontext
*ctx
, GLenum type
,
712 GLsizei stride
, const GLvoid
*ptr
);
713 void (*SecondaryColorPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
714 GLsizei stride
, const GLvoid
*ptr
);
715 void (*TexCoordPointer
)(GLcontext
*ctx
, GLint size
, GLenum type
,
716 GLsizei stride
, const GLvoid
*ptr
);
717 void (*EdgeFlagPointer
)(GLcontext
*ctx
, GLsizei stride
, const GLvoid
*ptr
);
718 void (*VertexAttribPointer
)(GLcontext
*ctx
, GLuint index
, GLint size
,
719 GLenum type
, GLsizei stride
, const GLvoid
*ptr
);
720 void (*LockArraysEXT
)( GLcontext
*ctx
, GLint first
, GLsizei count
);
721 void (*UnlockArraysEXT
)( GLcontext
*ctx
);
726 * \name State-query functions
728 * Return GL_TRUE if query was completed, GL_FALSE otherwise.
731 /** Return the value or values of a selected parameter */
732 GLboolean (*GetBooleanv
)(GLcontext
*ctx
, GLenum pname
, GLboolean
*result
);
733 /** Return the value or values of a selected parameter */
734 GLboolean (*GetDoublev
)(GLcontext
*ctx
, GLenum pname
, GLdouble
*result
);
735 /** Return the value or values of a selected parameter */
736 GLboolean (*GetFloatv
)(GLcontext
*ctx
, GLenum pname
, GLfloat
*result
);
737 /** Return the value or values of a selected parameter */
738 GLboolean (*GetIntegerv
)(GLcontext
*ctx
, GLenum pname
, GLint
*result
);
739 /** Return the value or values of a selected parameter */
740 GLboolean (*GetPointerv
)(GLcontext
*ctx
, GLenum pname
, GLvoid
**result
);
745 * \name Vertex/pixel buffer object functions
747 #if FEATURE_ARB_vertex_buffer_object
749 void (*BindBuffer
)( GLcontext
*ctx
, GLenum target
,
750 struct gl_buffer_object
*obj
);
752 struct gl_buffer_object
* (*NewBufferObject
)( GLcontext
*ctx
, GLuint buffer
,
755 void (*DeleteBuffer
)( GLcontext
*ctx
, struct gl_buffer_object
*obj
);
757 void (*BufferData
)( GLcontext
*ctx
, GLenum target
, GLsizeiptrARB size
,
758 const GLvoid
*data
, GLenum usage
,
759 struct gl_buffer_object
*obj
);
761 void (*BufferSubData
)( GLcontext
*ctx
, GLenum target
, GLintptrARB offset
,
762 GLsizeiptrARB size
, const GLvoid
*data
,
763 struct gl_buffer_object
*obj
);
765 void (*GetBufferSubData
)( GLcontext
*ctx
, GLenum target
,
766 GLintptrARB offset
, GLsizeiptrARB size
,
767 GLvoid
*data
, struct gl_buffer_object
*obj
);
769 void * (*MapBuffer
)( GLcontext
*ctx
, GLenum target
, GLenum access
,
770 struct gl_buffer_object
*obj
);
772 GLboolean (*UnmapBuffer
)( GLcontext
*ctx
, GLenum target
,
773 struct gl_buffer_object
*obj
);
778 * \name Functions for GL_EXT_framebuffer_object
780 #if FEATURE_EXT_framebuffer_object
782 struct gl_framebuffer
* (*NewFramebuffer
)(GLcontext
*ctx
, GLuint name
);
783 struct gl_renderbuffer
* (*NewRenderbuffer
)(GLcontext
*ctx
, GLuint name
);
784 void (*BindFramebuffer
)(GLcontext
*ctx
, GLenum target
,
785 struct gl_framebuffer
*fb
);
786 void (*FramebufferRenderbuffer
)(GLcontext
*ctx
,
787 struct gl_framebuffer
*fb
,
789 struct gl_renderbuffer
*rb
);
790 void (*RenderTexture
)(GLcontext
*ctx
,
791 struct gl_framebuffer
*fb
,
792 struct gl_renderbuffer_attachment
*att
);
793 void (*FinishRenderTexture
)(GLcontext
*ctx
,
794 struct gl_renderbuffer_attachment
*att
);
797 #if FEATURE_EXT_framebuffer_blit
798 void (*BlitFramebuffer
)(GLcontext
*ctx
,
799 GLint srcX0
, GLint srcY0
, GLint srcX1
, GLint srcY1
,
800 GLint dstX0
, GLint dstY0
, GLint dstX1
, GLint dstY1
,
801 GLbitfield mask
, GLenum filter
);
805 * \name Query objects
808 struct gl_query_object
* (*NewQueryObject
)(GLcontext
*ctx
, GLuint id
);
809 void (*BeginQuery
)(GLcontext
*ctx
, GLenum target
,
810 struct gl_query_object
*q
);
811 void (*EndQuery
)(GLcontext
*ctx
, GLenum target
, struct gl_query_object
*q
);
816 * \name Vertex Array objects
819 struct gl_array_object
* (*NewArrayObject
)(GLcontext
*ctx
, GLuint id
);
820 void (*DeleteArrayObject
)(GLcontext
*ctx
, struct gl_array_object
*obj
);
821 void (*BindArrayObject
)(GLcontext
*ctx
, struct gl_array_object
*obj
);
825 * \name GLSL-related functions (ARB extensions and OpenGL 2.x)
828 void (*AttachShader
)(GLcontext
*ctx
, GLuint program
, GLuint shader
);
829 void (*BindAttribLocation
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
830 const GLcharARB
*name
);
831 void (*CompileShader
)(GLcontext
*ctx
, GLuint shader
);
832 GLuint (*CreateShader
)(GLcontext
*ctx
, GLenum type
);
833 GLuint (*CreateProgram
)(GLcontext
*ctx
);
834 void (*DeleteProgram2
)(GLcontext
*ctx
, GLuint program
);
835 void (*DeleteShader
)(GLcontext
*ctx
, GLuint shader
);
836 void (*DetachShader
)(GLcontext
*ctx
, GLuint program
, GLuint shader
);
837 void (*GetActiveAttrib
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
838 GLsizei maxLength
, GLsizei
* length
, GLint
* size
,
839 GLenum
* type
, GLcharARB
* name
);
840 void (*GetActiveUniform
)(GLcontext
*ctx
, GLuint program
, GLuint index
,
841 GLsizei maxLength
, GLsizei
*length
, GLint
*size
,
842 GLenum
*type
, GLcharARB
*name
);
843 void (*GetAttachedShaders
)(GLcontext
*ctx
, GLuint program
, GLsizei maxCount
,
844 GLsizei
*count
, GLuint
*obj
);
845 GLint (*GetAttribLocation
)(GLcontext
*ctx
, GLuint program
,
846 const GLcharARB
*name
);
847 GLuint (*GetHandle
)(GLcontext
*ctx
, GLenum pname
);
848 void (*GetProgramiv
)(GLcontext
*ctx
, GLuint program
,
849 GLenum pname
, GLint
*params
);
850 void (*GetProgramInfoLog
)(GLcontext
*ctx
, GLuint program
, GLsizei bufSize
,
851 GLsizei
*length
, GLchar
*infoLog
);
852 void (*GetShaderiv
)(GLcontext
*ctx
, GLuint shader
,
853 GLenum pname
, GLint
*params
);
854 void (*GetShaderInfoLog
)(GLcontext
*ctx
, GLuint shader
, GLsizei bufSize
,
855 GLsizei
*length
, GLchar
*infoLog
);
856 void (*GetShaderSource
)(GLcontext
*ctx
, GLuint shader
, GLsizei maxLength
,
857 GLsizei
*length
, GLcharARB
*sourceOut
);
858 void (*GetUniformfv
)(GLcontext
*ctx
, GLuint program
, GLint location
,
860 GLint (*GetUniformLocation
)(GLcontext
*ctx
, GLuint program
,
861 const GLcharARB
*name
);
862 GLboolean (*IsProgram
)(GLcontext
*ctx
, GLuint name
);
863 GLboolean (*IsShader
)(GLcontext
*ctx
, GLuint name
);
864 void (*LinkProgram
)(GLcontext
*ctx
, GLuint program
);
865 void (*ShaderSource
)(GLcontext
*ctx
, GLuint shader
, const GLchar
*source
);
866 void (*Uniform
)(GLcontext
*ctx
, GLint location
, GLsizei count
,
867 const GLvoid
*values
, GLenum type
);
868 void (*UniformMatrix
)(GLcontext
*ctx
, GLint cols
, GLint rows
,
869 GLenum matrixType
, GLint location
, GLsizei count
,
870 GLboolean transpose
, const GLfloat
*values
);
871 void (*UseProgram
)(GLcontext
*ctx
, GLuint program
);
872 void (*ValidateProgram
)(GLcontext
*ctx
, GLuint program
);
873 /* XXX many more to come */
878 * \name Support for multiple T&L engines
883 * Bitmask of state changes that require the current T&L module to be
884 * validated, using ValidateTnlModule() below.
889 * Validate the current T&L module.
891 * This is called directly after UpdateState() when a state change that has
892 * occurred matches the dd_function_table::NeedValidate bitmask above. This
893 * ensures all computed values are up to date, thus allowing the driver to
894 * decide if the current T&L module needs to be swapped out.
896 * This must be non-NULL if a driver installs a custom T&L module and sets
897 * the dd_function_table::NeedValidate bitmask, but may be NULL otherwise.
899 void (*ValidateTnlModule
)( GLcontext
*ctx
, GLuint new_state
);
902 #define PRIM_OUTSIDE_BEGIN_END GL_POLYGON+1
903 #define PRIM_INSIDE_UNKNOWN_PRIM GL_POLYGON+2
904 #define PRIM_UNKNOWN GL_POLYGON+3
907 * Set by the driver-supplied T&L engine.
909 * Set to PRIM_OUTSIDE_BEGIN_END when outside glBegin()/glEnd().
911 GLuint CurrentExecPrimitive
;
914 * Current state of an in-progress compilation.
916 * May take on any of the additional values PRIM_OUTSIDE_BEGIN_END,
917 * PRIM_INSIDE_UNKNOWN_PRIM or PRIM_UNKNOWN defined above.
919 GLuint CurrentSavePrimitive
;
922 #define FLUSH_STORED_VERTICES 0x1
923 #define FLUSH_UPDATE_CURRENT 0x2
925 * Set by the driver-supplied T&L engine whenever vertices are buffered
926 * between glBegin()/glEnd() objects or __GLcontextRec::Current is not
929 * The dd_function_table::FlushVertices call below may be used to resolve
933 GLuint SaveNeedFlush
;
936 * If inside glBegin()/glEnd(), it should ASSERT(0). Otherwise, if
937 * FLUSH_STORED_VERTICES bit in \p flags is set flushes any buffered
938 * vertices, if FLUSH_UPDATE_CURRENT bit is set updates
939 * __GLcontextRec::Current and gl_light_attrib::Material
941 * Note that the default T&L engine never clears the
942 * FLUSH_UPDATE_CURRENT bit, even after performing the update.
944 void (*FlushVertices
)( GLcontext
*ctx
, GLuint flags
);
945 void (*SaveFlushVertices
)( GLcontext
*ctx
);
948 * Give the driver the opportunity to hook in its own vtxfmt for
949 * compiling optimized display lists. This is called on each valid
950 * glBegin() during list compilation.
952 GLboolean (*NotifySaveBegin
)( GLcontext
*ctx
, GLenum mode
);
955 * Notify driver that the special derived value _NeedEyeCoords has
958 void (*LightingSpaceChange
)( GLcontext
*ctx
);
961 * Called by glNewList().
963 * Let the T&L component know what is going on with display lists
964 * in time to make changes to dispatch tables, etc.
966 void (*NewList
)( GLcontext
*ctx
, GLuint list
, GLenum mode
);
968 * Called by glEndList().
970 * \sa dd_function_table::NewList.
972 void (*EndList
)( GLcontext
*ctx
);
975 * Called by glCallList(s).
977 * Notify the T&L component before and after calling a display list.
979 void (*BeginCallList
)( GLcontext
*ctx
,
980 struct mesa_display_list
*dlist
);
982 * Called by glEndCallList().
984 * \sa dd_function_table::BeginCallList.
986 void (*EndCallList
)( GLcontext
*ctx
);
992 * Transform/Clip/Lighting interface
994 * Drivers present a reduced set of the functions possible in
995 * glBegin()/glEnd() objects. Core mesa provides translation stubs for the
996 * remaining functions to map down to these entry points.
998 * These are the initial values to be installed into dispatch by
999 * mesa. If the T&L driver wants to modify the dispatch table
1000 * while installed, it must do so itself. It would be possible for
1001 * the vertexformat to install it's own initial values for these
1002 * functions, but this way there is an obvious list of what is
1003 * expected of the driver.
1005 * If the driver wants to hook in entry points other than those
1006 * listed, it must restore them to their original values in
1007 * the disable() callback, below.
1014 void (GLAPIENTRYP ArrayElement
)( GLint
); /* NOTE */
1015 void (GLAPIENTRYP Color3f
)( GLfloat
, GLfloat
, GLfloat
);
1016 void (GLAPIENTRYP Color3fv
)( const GLfloat
* );
1017 void (GLAPIENTRYP Color4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1018 void (GLAPIENTRYP Color4fv
)( const GLfloat
* );
1019 void (GLAPIENTRYP EdgeFlag
)( GLboolean
);
1020 void (GLAPIENTRYP EvalCoord1f
)( GLfloat
); /* NOTE */
1021 void (GLAPIENTRYP EvalCoord1fv
)( const GLfloat
* ); /* NOTE */
1022 void (GLAPIENTRYP EvalCoord2f
)( GLfloat
, GLfloat
); /* NOTE */
1023 void (GLAPIENTRYP EvalCoord2fv
)( const GLfloat
* ); /* NOTE */
1024 void (GLAPIENTRYP EvalPoint1
)( GLint
); /* NOTE */
1025 void (GLAPIENTRYP EvalPoint2
)( GLint
, GLint
); /* NOTE */
1026 void (GLAPIENTRYP FogCoordfEXT
)( GLfloat
);
1027 void (GLAPIENTRYP FogCoordfvEXT
)( const GLfloat
* );
1028 void (GLAPIENTRYP Indexf
)( GLfloat
);
1029 void (GLAPIENTRYP Indexfv
)( const GLfloat
* );
1030 void (GLAPIENTRYP Materialfv
)( GLenum face
, GLenum pname
, const GLfloat
* ); /* NOTE */
1031 void (GLAPIENTRYP MultiTexCoord1fARB
)( GLenum
, GLfloat
);
1032 void (GLAPIENTRYP MultiTexCoord1fvARB
)( GLenum
, const GLfloat
* );
1033 void (GLAPIENTRYP MultiTexCoord2fARB
)( GLenum
, GLfloat
, GLfloat
);
1034 void (GLAPIENTRYP MultiTexCoord2fvARB
)( GLenum
, const GLfloat
* );
1035 void (GLAPIENTRYP MultiTexCoord3fARB
)( GLenum
, GLfloat
, GLfloat
, GLfloat
);
1036 void (GLAPIENTRYP MultiTexCoord3fvARB
)( GLenum
, const GLfloat
* );
1037 void (GLAPIENTRYP MultiTexCoord4fARB
)( GLenum
, GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1038 void (GLAPIENTRYP MultiTexCoord4fvARB
)( GLenum
, const GLfloat
* );
1039 void (GLAPIENTRYP Normal3f
)( GLfloat
, GLfloat
, GLfloat
);
1040 void (GLAPIENTRYP Normal3fv
)( const GLfloat
* );
1041 void (GLAPIENTRYP SecondaryColor3fEXT
)( GLfloat
, GLfloat
, GLfloat
);
1042 void (GLAPIENTRYP SecondaryColor3fvEXT
)( const GLfloat
* );
1043 void (GLAPIENTRYP TexCoord1f
)( GLfloat
);
1044 void (GLAPIENTRYP TexCoord1fv
)( const GLfloat
* );
1045 void (GLAPIENTRYP TexCoord2f
)( GLfloat
, GLfloat
);
1046 void (GLAPIENTRYP TexCoord2fv
)( const GLfloat
* );
1047 void (GLAPIENTRYP TexCoord3f
)( GLfloat
, GLfloat
, GLfloat
);
1048 void (GLAPIENTRYP TexCoord3fv
)( const GLfloat
* );
1049 void (GLAPIENTRYP TexCoord4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1050 void (GLAPIENTRYP TexCoord4fv
)( const GLfloat
* );
1051 void (GLAPIENTRYP Vertex2f
)( GLfloat
, GLfloat
);
1052 void (GLAPIENTRYP Vertex2fv
)( const GLfloat
* );
1053 void (GLAPIENTRYP Vertex3f
)( GLfloat
, GLfloat
, GLfloat
);
1054 void (GLAPIENTRYP Vertex3fv
)( const GLfloat
* );
1055 void (GLAPIENTRYP Vertex4f
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1056 void (GLAPIENTRYP Vertex4fv
)( const GLfloat
* );
1057 void (GLAPIENTRYP CallList
)( GLuint
); /* NOTE */
1058 void (GLAPIENTRYP CallLists
)( GLsizei
, GLenum
, const GLvoid
* ); /* NOTE */
1059 void (GLAPIENTRYP Begin
)( GLenum
);
1060 void (GLAPIENTRYP End
)( void );
1061 /* GL_NV_vertex_program */
1062 void (GLAPIENTRYP VertexAttrib1fNV
)( GLuint index
, GLfloat x
);
1063 void (GLAPIENTRYP VertexAttrib1fvNV
)( GLuint index
, const GLfloat
*v
);
1064 void (GLAPIENTRYP VertexAttrib2fNV
)( GLuint index
, GLfloat x
, GLfloat y
);
1065 void (GLAPIENTRYP VertexAttrib2fvNV
)( GLuint index
, const GLfloat
*v
);
1066 void (GLAPIENTRYP VertexAttrib3fNV
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
);
1067 void (GLAPIENTRYP VertexAttrib3fvNV
)( GLuint index
, const GLfloat
*v
);
1068 void (GLAPIENTRYP VertexAttrib4fNV
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
, GLfloat w
);
1069 void (GLAPIENTRYP VertexAttrib4fvNV
)( GLuint index
, const GLfloat
*v
);
1070 #if FEATURE_ARB_vertex_program
1071 void (GLAPIENTRYP VertexAttrib1fARB
)( GLuint index
, GLfloat x
);
1072 void (GLAPIENTRYP VertexAttrib1fvARB
)( GLuint index
, const GLfloat
*v
);
1073 void (GLAPIENTRYP VertexAttrib2fARB
)( GLuint index
, GLfloat x
, GLfloat y
);
1074 void (GLAPIENTRYP VertexAttrib2fvARB
)( GLuint index
, const GLfloat
*v
);
1075 void (GLAPIENTRYP VertexAttrib3fARB
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
);
1076 void (GLAPIENTRYP VertexAttrib3fvARB
)( GLuint index
, const GLfloat
*v
);
1077 void (GLAPIENTRYP VertexAttrib4fARB
)( GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
, GLfloat w
);
1078 void (GLAPIENTRYP VertexAttrib4fvARB
)( GLuint index
, const GLfloat
*v
);
1084 void (GLAPIENTRYP Rectf
)( GLfloat
, GLfloat
, GLfloat
, GLfloat
);
1090 void (GLAPIENTRYP DrawArrays
)( GLenum mode
, GLint start
, GLsizei count
);
1091 void (GLAPIENTRYP DrawElements
)( GLenum mode
, GLsizei count
, GLenum type
,
1092 const GLvoid
*indices
);
1093 void (GLAPIENTRYP DrawRangeElements
)( GLenum mode
, GLuint start
,
1094 GLuint end
, GLsizei count
,
1095 GLenum type
, const GLvoid
*indices
);
1101 * If you don't support eval, fallback to the default vertex format
1102 * on receiving an eval call and use the pipeline mechanism to
1103 * provide partial T&L acceleration.
1105 * Mesa will provide a set of helper functions to do eval within
1106 * accelerated vertex formats, eventually...
1109 void (GLAPIENTRYP EvalMesh1
)( GLenum mode
, GLint i1
, GLint i2
);
1110 void (GLAPIENTRYP EvalMesh2
)( GLenum mode
, GLint i1
, GLint i2
, GLint j1
, GLint j2
);
1116 #endif /* DD_INCLUDED */