src/mesa/vbo/vbo_save.h

   1 /**************************************************************************
   2
   3 Copyright 2002 VMware, Inc.
   4
   5 All Rights Reserved.
   6
   7 Permission is hereby granted, free of charge, to any person obtaining a
   8 copy of this software and associated documentation files (the "Software"),
   9 to deal in the Software without restriction, including without limitation
  10 on the rights to use, copy, modify, merge, publish, distribute, sub
  11 license, and/or sell copies of the Software, and to permit persons to whom
  12 the Software is furnished to do so, subject to the following conditions:
  13
  14 The above copyright notice and this permission notice (including the next
  15 paragraph) shall be included in all copies or substantial portions of the
  16 Software.
  17
  18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21 VMWARE AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24 USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26 **************************************************************************/
  27
  28 /*
  29  * Authors:
  30  *   Keith Whitwell <keithw@vmware.com>
  31  *
  32  */
  33
  34 #ifndef VBO_SAVE_H
  35 #define VBO_SAVE_H
  36
  37 #include "main/mtypes.h"
  38 #include "vbo.h"
  39 #include "vbo_attrib.h"
  40
  41
  42 struct vbo_save_copied_vtx {
  43    fi_type buffer[VBO_ATTRIB_MAX * 4 * VBO_MAX_COPIED_VERTS];
  44    GLuint nr;
  45 };
  46
  47
  48 /* For display lists, this structure holds a run of vertices of the
  49  * same format, and a strictly well-formed set of begin/end pairs,
  50  * starting on the first vertex and ending at the last.  Vertex
  51  * copying on buffer breaks is precomputed according to these
  52  * primitives, though there are situations where the copying will need
  53  * correction at execute-time, perhaps by replaying the list as
  54  * immediate mode commands.
  55  *
  56  * On executing this list, the 'current' values may be updated with
  57  * the values of the final vertex, and often no fixup of the start of
  58  * the vertex list is required.
  59  *
  60  * Eval and other commands that don't fit into these vertex lists are
  61  * compiled using the fallback opcode mechanism provided by dlist.c.
  62  */
  63 struct vbo_save_vertex_list {
  64    GLbitfield64 enabled; /**< mask of enabled vbo arrays. */
  65    GLubyte attrsz[VBO_ATTRIB_MAX];
  66    GLenum16 attrtype[VBO_ATTRIB_MAX];
  67    GLuint offsets[VBO_ATTRIB_MAX];
  68    GLuint vertex_size;  /**< size in GLfloats */
  69
  70    /* Copy of the final vertex from node->vertex_store->bufferobj.
  71     * Keep this in regular (non-VBO) memory to avoid repeated
  72     * map/unmap of the VBO when updating GL current data.
  73     */
  74    fi_type *current_data;
  75    GLuint current_size;
  76
  77    GLuint buffer_offset;        /**< in bytes */
  78    GLuint start_vertex;         /**< first vertex used by any primitive */
  79    GLuint vertex_count;         /**< number of vertices in this list */
  80    GLuint wrap_count;           /* number of copied vertices at start */
  81    GLboolean dangling_attr_ref; /* current attr implicitly referenced
  82                                    outside the list */
  83
  84    struct _mesa_prim *prims;
  85    GLuint prim_count;
  86
  87    struct vbo_save_vertex_store *vertex_store;
  88    struct vbo_save_primitive_store *prim_store;
  89 };
  90
  91
  92 /**
  93  * Is the vertex list's buffer offset an exact multiple of the
  94  * vertex size (in bytes)?  This is used to check for a vertex array /
  95  * drawing optimization.
  96  */
  97 static inline bool
  98 aligned_vertex_buffer_offset(const struct vbo_save_vertex_list *node)
  99 {
 100    unsigned vertex_size = node->vertex_size * sizeof(GLfloat); /* in bytes */
 101    return vertex_size != 0 && node->buffer_offset % vertex_size == 0;
 102 }
 103
 104
 105 /* These buffers should be a reasonable size to support upload to
 106  * hardware.  Current vbo implementation will re-upload on any
 107  * changes, so don't make too big or apps which dynamically create
 108  * dlists and use only a few times will suffer.
 109  *
 110  * Consider stategy of uploading regions from the VBO on demand in the
 111  * case of dynamic vbos.  Then make the dlist code signal that
 112  * likelyhood as it occurs.  No reason we couldn't change usage
 113  * internally even though this probably isn't allowed for client VBOs?
 114  */
 115 #define VBO_SAVE_BUFFER_SIZE (256*1024) /* dwords */
 116 #define VBO_SAVE_PRIM_SIZE   128
 117 #define VBO_SAVE_PRIM_MODE_MASK         0x3f
 118 #define VBO_SAVE_PRIM_WEAK              0x40
 119 #define VBO_SAVE_PRIM_NO_CURRENT_UPDATE 0x80
 120
 121 #define VBO_SAVE_FALLBACK    0x10000000
 122
 123 /* Storage to be shared among several vertex_lists.
 124  */
 125 struct vbo_save_vertex_store {
 126    struct gl_buffer_object *bufferobj;
 127    fi_type *buffer_map;
 128    GLuint used;           /**< Number of 4-byte words used in buffer */
 129    GLuint refcount;
 130 };
 131
 132 struct vbo_save_primitive_store {
 133    struct _mesa_prim prims[VBO_SAVE_PRIM_SIZE];
 134    GLuint used;
 135    GLuint refcount;
 136 };
 137
 138
 139 struct vbo_save_context {
 140    struct gl_context *ctx;
 141    GLvertexformat vtxfmt;
 142    GLvertexformat vtxfmt_noop;  /**< Used if out_of_memory is true */
 143    struct gl_vertex_array arrays[VBO_ATTRIB_MAX];
 144    const struct gl_vertex_array *inputs[VBO_ATTRIB_MAX];
 145
 146    GLbitfield64 enabled; /**< mask of enabled vbo arrays. */
 147    GLubyte attrsz[VBO_ATTRIB_MAX];  /**< 1, 2, 3 or 4 */
 148    GLenum16 attrtype[VBO_ATTRIB_MAX];  /**< GL_FLOAT, GL_INT, etc */
 149    GLubyte active_sz[VBO_ATTRIB_MAX];  /**< 1, 2, 3 or 4 */
 150    GLuint vertex_size;  /**< size in GLfloats */
 151
 152    GLboolean out_of_memory;  /**< True if last VBO allocation failed */
 153
 154    GLuint wrap_count;
 155    GLbitfield replay_flags;
 156
 157    struct _mesa_prim *prims;
 158    GLuint prim_count, prim_max;
 159
 160    struct vbo_save_vertex_store *vertex_store;
 161    struct vbo_save_primitive_store *prim_store;
 162
 163    fi_type *buffer_map;            /**< Mapping of vertex_store's buffer */
 164    fi_type *buffer_ptr;            /**< cursor, points into buffer_map */
 165    fi_type vertex[VBO_ATTRIB_MAX*4];       /* current values */
 166    fi_type *attrptr[VBO_ATTRIB_MAX];
 167    GLuint vert_count;
 168    GLuint max_vert;
 169    GLboolean dangling_attr_ref;
 170
 171    GLuint opcode_vertex_list;
 172
 173    struct vbo_save_copied_vtx copied;
 174
 175    fi_type *current[VBO_ATTRIB_MAX]; /* points into ctx->ListState */
 176    GLubyte *currentsz[VBO_ATTRIB_MAX];
 177 };
 178
 179 void vbo_save_init(struct gl_context *ctx);
 180 void vbo_save_destroy(struct gl_context *ctx);
 181 void vbo_save_fallback(struct gl_context *ctx, GLboolean fallback);
 182
 183 /* save_loopback.c:
 184  */
 185 void vbo_loopback_vertex_list(struct gl_context *ctx,
 186                               const GLfloat *buffer,
 187                               const GLubyte *attrsz,
 188                               const struct _mesa_prim *prim,
 189                               GLuint prim_count,
 190                               GLuint wrap_count,
 191                               GLuint vertex_size);
 192
 193 /* Callbacks:
 194  */
 195 void
 196 vbo_save_playback_vertex_list(struct gl_context *ctx, void *data);
 197
 198 void
 199 vbo_save_api_init(struct vbo_save_context *save);
 200
 201 fi_type *
 202 vbo_save_map_vertex_store(struct gl_context *ctx,
 203                           struct vbo_save_vertex_store *vertex_store);
 204
 205 void
 206 vbo_save_unmap_vertex_store(struct gl_context *ctx,
 207                             struct vbo_save_vertex_store *vertex_store);
 208
 209 #endif /* VBO_SAVE_H */