src/mesa/tnl/tnl.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *    Keith Whitwell <keithw@vmware.com>
  26  */
  27
  28 #ifndef _TNL_H
  29 #define _TNL_H
  30
  31 #include "main/glheader.h"
  32
  33 struct gl_vertex_array;
  34 struct gl_context;
  35 struct gl_program;
  36 struct gl_buffer_object;
  37 struct gl_transform_feedback_object;
  38 struct dd_function_table;
  39
  40
  41 /* These are the public-access functions exported from tnl.  (A few
  42  * more are currently hooked into dispatch directly by the module
  43  * itself.)
  44  */
  45 extern GLboolean
  46 _tnl_CreateContext( struct gl_context *ctx );
  47
  48 extern void
  49 _tnl_DestroyContext( struct gl_context *ctx );
  50
  51 extern void
  52 _tnl_InvalidateState( struct gl_context *ctx, GLuint new_state );
  53
  54 extern void
  55 _tnl_init_driver_draw_function(struct dd_function_table *functions);
  56
  57 /* Functions to revive the tnl module after being unhooked from
  58  * dispatch and/or driver callbacks.
  59  */
  60
  61 extern void
  62 _tnl_wakeup( struct gl_context *ctx );
  63
  64 /* Driver configuration options:
  65  */
  66 extern void
  67 _tnl_need_projected_coords( struct gl_context *ctx, GLboolean flag );
  68
  69 extern void
  70 _tnl_bind_inputs( struct gl_context *ctx );
  71
  72
  73 /* Control whether T&L does per-vertex fog
  74  */
  75 extern void
  76 _tnl_allow_vertex_fog( struct gl_context *ctx, GLboolean value );
  77
  78 extern void
  79 _tnl_allow_pixel_fog( struct gl_context *ctx, GLboolean value );
  80
  81 extern GLboolean
  82 _tnl_program_string(struct gl_context *ctx, GLenum target, struct gl_program *program);
  83
  84 struct _mesa_prim;
  85 struct _mesa_index_buffer;
  86
  87 void
  88 _tnl_draw_prims(struct gl_context *ctx,
  89                 const struct gl_vertex_array *arrays,
  90                      const struct _mesa_prim *prim,
  91                      GLuint nr_prims,
  92                      const struct _mesa_index_buffer *ib,
  93                      GLboolean index_bounds_valid,
  94                      GLuint min_index,
  95                      GLuint max_index,
  96                      struct gl_transform_feedback_object *tfb_vertcount,
  97                      unsigned stream,
  98                      struct gl_buffer_object *indirect );
  99
 100 void
 101 _tnl_draw(struct gl_context *ctx,
 102           const struct _mesa_prim *prim, GLuint nr_prims,
 103           const struct _mesa_index_buffer *ib,
 104           GLboolean index_bounds_valid, GLuint min_index, GLuint max_index,
 105           struct gl_transform_feedback_object *tfb_vertcount, unsigned stream,
 106           struct gl_buffer_object *indirect);
 107
 108 extern void
 109 _tnl_RasterPos(struct gl_context *ctx, const GLfloat vObj[4]);
 110
 111 extern void
 112 _tnl_validate_shine_tables( struct gl_context *ctx );
 113
 114
 115
 116 /**
 117  * For indirect array drawing:
 118  *
 119  *    typedef struct {
 120  *       GLuint count;
 121  *       GLuint primCount;
 122  *       GLuint first;
 123  *       GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
 124  *    } DrawArraysIndirectCommand;
 125  *
 126  * For indirect indexed drawing:
 127  *
 128  *    typedef struct {
 129  *       GLuint count;
 130  *       GLuint primCount;
 131  *       GLuint firstIndex;
 132  *       GLint  baseVertex;
 133  *       GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
 134  *    } DrawElementsIndirectCommand;
 135  */
 136
 137
 138 /**
 139  * Draw a number of primitives.
 140  * \param prims  array [nr_prims] describing what to draw (prim type,
 141  *               vertex count, first index, instance count, etc).
 142  * \param arrays array of vertex arrays for draw
 143  * \param ib  index buffer for indexed drawing, NULL for array drawing
 144  * \param index_bounds_valid  are min_index and max_index valid?
 145  * \param min_index  lowest vertex index used
 146  * \param max_index  highest vertex index used
 147  * \param tfb_vertcount  if non-null, indicates which transform feedback
 148  *                       object has the vertex count.
 149  * \param tfb_stream  If called via DrawTransformFeedbackStream, specifies the
 150  *                    vertex stream buffer from which to get the vertex count.
 151  * \param indirect  If any prims are indirect, this specifies the buffer
 152  *                  to find the "DrawArrays/ElementsIndirectCommand" data.
 153  *                  This may be deprecated in the future
 154  */
 155 typedef void (*tnl_draw_func)(struct gl_context *ctx,
 156                               const struct gl_vertex_array* arrays,
 157                               const struct _mesa_prim *prims,
 158                               GLuint nr_prims,
 159                               const struct _mesa_index_buffer *ib,
 160                               GLboolean index_bounds_valid,
 161                               GLuint min_index,
 162                               GLuint max_index,
 163                               struct gl_transform_feedback_object *tfb_vertcount,
 164                               unsigned tfb_stream,
 165                               struct gl_buffer_object *indirect);
 166
 167
 168 /* Utility function to cope with various constraints on tnl modules or
 169  * hardware.  This can be used to split an incoming set of arrays and
 170  * primitives against the following constraints:
 171  *    - Maximum number of indices in index buffer.
 172  *    - Maximum number of vertices referenced by index buffer.
 173  *    - Maximum hardware vertex buffer size.
 174  */
 175 struct split_limits
 176 {
 177    GLuint max_verts;
 178    GLuint max_indices;
 179    GLuint max_vb_size;          /* bytes */
 180 };
 181
 182 void
 183 _tnl_split_prims(struct gl_context *ctx,
 184                  const struct gl_vertex_array *arrays,
 185                  const struct _mesa_prim *prim,
 186                  GLuint nr_prims,
 187                  const struct _mesa_index_buffer *ib,
 188                  GLuint min_index,
 189                  GLuint max_index,
 190                  tnl_draw_func draw,
 191                  const struct split_limits *limits);
 192
 193
 194 #endif