GPU: Remove GPU_INDEX_U8
authorClément Foucault <foucault.clem@gmail.com>
Tue, 28 May 2019 22:08:10 +0000 (00:08 +0200)
committerClément Foucault <foucault.clem@gmail.com>
Thu, 30 May 2019 11:42:21 +0000 (13:42 +0200)
This type of indices is not natively supported on modern GPU and
gives warning on some implementation. The memory savings it
provides is also quite minimal and unlikely to be visible on
nowadays hardware.

This remove some uneeded struct members and makes primitive
restart always enabled by default. This can be broken by addons
if they are not careful enough but many other states have this
problem.

Also leverage GL_PRIMITIVE_RESTART_FIXED_INDEX if
ARB_ES3_compatibility is supported. This removes all API calls
to change restart index depending on indices length.

source/blender/draw/intern/draw_cache.c
source/blender/draw/intern/draw_cache_impl_curve.c
source/blender/draw/intern/draw_cache_impl_mesh.c
source/blender/draw/intern/draw_cache_impl_particles.c
source/blender/gpu/GPU_element.h
source/blender/gpu/intern/gpu_batch.c
source/blender/gpu/intern/gpu_draw.c
source/blender/gpu/intern/gpu_element.c

index c40e977..88125e8 100644 (file)
@@ -2707,7 +2707,7 @@ GPUBatch *DRW_cache_bone_stick_get(void)
     GPU_vertbuf_data_alloc(vbo, vcount);
 
     GPUIndexBufBuilder elb;
-    GPU_indexbuf_init_ex(&elb, GPU_PRIM_TRI_FAN, (CIRCLE_RESOL + 2) * 2 + 6 + 2, vcount, true);
+    GPU_indexbuf_init_ex(&elb, GPU_PRIM_TRI_FAN, (CIRCLE_RESOL + 2) * 2 + 6 + 2, vcount);
 
     /* head/tail points */
     for (int i = 0; i < 2; ++i) {
@@ -3931,7 +3931,7 @@ GPUBatch *DRW_cache_cursor_get(bool crosshair_lines)
     }
 
     GPUIndexBufBuilder elb;
-    GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, index_len, vert_len, true);
+    GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, index_len, vert_len);
 
     GPUVertBuf *vbo = GPU_vertbuf_create_with_format(&format);
     GPU_vertbuf_data_alloc(vbo, vert_len);
index 0904027..1d6f2aa 100644 (file)
@@ -601,7 +601,7 @@ static void curve_create_curves_lines(CurveRenderData *rdata, GPUIndexBuf *ibo_c
   const int index_len = edge_len + curve_len * 2;
 
   GPUIndexBufBuilder elb;
-  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, index_len, vert_len, true);
+  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, index_len, vert_len);
 
   int v_idx = 0;
   for (const BevList *bl = rdata->ob_curve_cache->bev.first; bl; bl = bl->next) {
index 9fb9f97..27956f1 100644 (file)
@@ -3802,7 +3802,7 @@ static void mesh_create_loops_line_strips(MeshRenderData *rdata,
   const int poly_len = mesh_render_data_polys_len_get(rdata);
 
   GPUIndexBufBuilder elb;
-  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, loop_len + poly_len * 2, loop_len, true);
+  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, loop_len + poly_len * 2, loop_len);
 
   uint v_index = 0;
   if (rdata->mapped.use == false) {
@@ -4842,13 +4842,13 @@ static void mesh_create_uvedit_buffers(MeshRenderData *rdata,
 
   GPUIndexBufBuilder elb_vert, elb_edge, elb_face;
   if (DRW_TEST_ASSIGN_IBO(ibo_vert)) {
-    GPU_indexbuf_init_ex(&elb_vert, GPU_PRIM_POINTS, loop_len, loop_len, false);
+    GPU_indexbuf_init_ex(&elb_vert, GPU_PRIM_POINTS, loop_len, loop_len);
   }
   if (DRW_TEST_ASSIGN_IBO(ibo_edge)) {
-    GPU_indexbuf_init_ex(&elb_edge, GPU_PRIM_LINES, loop_len * 2, loop_len, false);
+    GPU_indexbuf_init_ex(&elb_edge, GPU_PRIM_LINES, loop_len * 2, loop_len);
   }
   if (DRW_TEST_ASSIGN_IBO(ibo_face)) {
-    GPU_indexbuf_init_ex(&elb_face, GPU_PRIM_TRI_FAN, idx_len, loop_len, true);
+    GPU_indexbuf_init_ex(&elb_face, GPU_PRIM_TRI_FAN, idx_len, loop_len);
   }
 
   uvedit_fill_buffer_data(rdata,
index 9a15c51..5b19164 100644 (file)
@@ -1053,7 +1053,7 @@ static void particle_batch_cache_ensure_procedural_indices(PTCacheEdit *edit,
   GPU_vertbuf_data_alloc(vbo, 1);
 
   GPUIndexBufBuilder elb;
-  GPU_indexbuf_init_ex(&elb, prim_type, element_count, element_count, true);
+  GPU_indexbuf_init_ex(&elb, prim_type, element_count, element_count);
 
   if (edit != NULL && edit->pathcache != NULL) {
     particle_batch_cache_fill_segments_indices(
@@ -1194,8 +1194,7 @@ static void particle_batch_cache_ensure_pos_and_seg(PTCacheEdit *edit,
   GPU_vertbuf_data_alloc(hair_cache->pos, hair_cache->point_len);
 
   GPUIndexBufBuilder elb;
-  GPU_indexbuf_init_ex(
-      &elb, GPU_PRIM_LINE_STRIP, hair_cache->elems_len, hair_cache->point_len, true);
+  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, hair_cache->elems_len, hair_cache->point_len);
 
   if (num_uv_layers || num_col_layers) {
     BKE_mesh_tessface_ensure(psmd->mesh_final);
@@ -1499,8 +1498,7 @@ static void particle_batch_cache_ensure_edit_pos_and_seg(PTCacheEdit *edit,
   GPU_vertbuf_data_alloc(hair_cache->pos, hair_cache->point_len);
   GPU_vertbuf_attr_get_raw_data(hair_cache->pos, pos_id, &data_step);
 
-  GPU_indexbuf_init_ex(
-      &elb, GPU_PRIM_LINE_STRIP, hair_cache->elems_len, hair_cache->point_len, true);
+  GPU_indexbuf_init_ex(&elb, GPU_PRIM_LINE_STRIP, hair_cache->elems_len, hair_cache->point_len);
 
   if (edit != NULL && edit->pathcache != NULL) {
     particle_batch_cache_fill_segments_edit(
index d1a199f..4ac89d2 100644 (file)
 
 #define GPU_TRACK_INDEX_RANGE 1
 
-#define GPU_PRIM_RESTART 0xFFFFFFFF
-
 typedef enum {
-  GPU_INDEX_U8, /* GL has this, Vulkan does not */
   GPU_INDEX_U16,
   GPU_INDEX_U32,
 } GPUIndexBufType;
@@ -43,13 +40,10 @@ typedef struct GPUIndexBuf {
 #if GPU_TRACK_INDEX_RANGE
   GPUIndexBufType index_type;
   uint32_t gl_index_type;
-  uint min_index;
-  uint max_index;
   uint base_index;
 #endif
   uint32_t ibo_id; /* 0 indicates not yet sent to VRAM */
   void *data;      /* non-NULL indicates not yet sent to VRAM */
-  bool use_prim_restart;
 } GPUIndexBuf;
 
 void GPU_indexbuf_use(GPUIndexBuf *);
@@ -61,12 +55,10 @@ typedef struct GPUIndexBufBuilder {
   uint index_len;
   GPUPrimType prim_type;
   uint *data;
-  bool use_prim_restart;
 } GPUIndexBufBuilder;
 
 /* supports all primitive types. */
-void GPU_indexbuf_init_ex(
-    GPUIndexBufBuilder *, GPUPrimType, uint index_len, uint vertex_len, bool use_prim_restart);
+void GPU_indexbuf_init_ex(GPUIndexBufBuilder *, GPUPrimType, uint index_len, uint vertex_len);
 
 /* supports only GPU_PRIM_POINTS, GPU_PRIM_LINES and GPU_PRIM_TRIS. */
 void GPU_indexbuf_init(GPUIndexBufBuilder *, GPUPrimType, uint prim_len, uint vertex_len);
index d1cfd5c..fb2a87f 100644 (file)
@@ -545,36 +545,26 @@ void GPU_batch_uniform_mat4(GPUBatch *batch, const char *name, const float data[
   glUniformMatrix4fv(uniform->location, 1, GL_FALSE, (const float *)data);
 }
 
-static void primitive_restart_enable(const GPUIndexBuf *el)
+static void primitive_restart_index(const GPUIndexBuf *el)
 {
-  // TODO(fclem) Replace by GL_PRIMITIVE_RESTART_FIXED_INDEX when we have ogl 4.3
-  glEnable(GL_PRIMITIVE_RESTART);
-  GLuint restart_index = (GLuint)0xFFFFFFFF;
-
 #if GPU_TRACK_INDEX_RANGE
-  if (el->index_type == GPU_INDEX_U8) {
-    restart_index = (GLuint)0xFF;
-  }
-  else if (el->index_type == GPU_INDEX_U16) {
-    restart_index = (GLuint)0xFFFF;
+  /* Can be removed if GL 4.3 is available. */
+  if (!GLEW_ARB_ES3_compatibility) {
+    /* Stay sync with GPU_state_init(). */
+    static int last_type = GPU_INDEX_U32;
+    if (el->index_type != last_type) {
+      GLuint restart_index = (el->index_type == GPU_INDEX_U16) ? (GLuint)0xFFFF :
+                                                                 (GLuint)0xFFFFFFFF;
+      glPrimitiveRestartIndex(restart_index);
+    }
   }
 #endif
-
-  glPrimitiveRestartIndex(restart_index);
-}
-
-static void primitive_restart_disable(void)
-{
-  glDisable(GL_PRIMITIVE_RESTART);
 }
 
 static void *elem_offset(const GPUIndexBuf *el, int v_first)
 {
 #if GPU_TRACK_INDEX_RANGE
-  if (el->index_type == GPU_INDEX_U8) {
-    return (GLubyte *)0 + v_first;
-  }
-  else if (el->index_type == GPU_INDEX_U16) {
+  if (el->index_type == GPU_INDEX_U16) {
     return (GLushort *)0 + v_first;
   }
 #endif
@@ -641,9 +631,7 @@ void GPU_batch_draw_advanced(GPUBatch *batch, int v_first, int v_count, int i_fi
 #endif
     void *v_first_ofs = elem_offset(el, v_first);
 
-    if (el->use_prim_restart) {
-      primitive_restart_enable(el);
-    }
+    primitive_restart_index(el);
 
     if (GLEW_ARB_base_instance) {
       glDrawElementsInstancedBaseVertexBaseInstance(
@@ -653,10 +641,6 @@ void GPU_batch_draw_advanced(GPUBatch *batch, int v_first, int v_count, int i_fi
       glDrawElementsInstancedBaseVertex(
           batch->gl_prim_type, v_count, index_type, v_first_ofs, i_count, base_index);
     }
-
-    if (el->use_prim_restart) {
-      primitive_restart_disable();
-    }
   }
   else {
     if (GLEW_ARB_base_instance) {
index 5f27a0e..c3c05c3 100644 (file)
@@ -1372,6 +1372,16 @@ void GPU_state_init(void)
   glDisable(GL_CULL_FACE);
 
   gpu_disable_multisample();
+
+  /* This is a bit dangerous since addons could change this. */
+  glEnable(GL_PRIMITIVE_RESTART);
+  glPrimitiveRestartIndex((GLuint)0xFFFFFFFF);
+
+  /* TODO: Should become default. But needs at least GL 4.3 */
+  if (GLEW_ARB_ES3_compatibility) {
+    /* Takes predecence over GL_PRIMITIVE_RESTART */
+    glEnable(GL_PRIMITIVE_RESTART_FIXED_INDEX);
+  }
 }
 
 /** \name Framebuffer color depth, for selection codes
index 0b7f37a..380de4c 100644 (file)
 
 #define KEEP_SINGLE_COPY 1
 
+#define RESTART_INDEX 0xFFFFFFFF
+
 static GLenum convert_index_type_to_gl(GPUIndexBufType type)
 {
   static const GLenum table[] = {
-      [GPU_INDEX_U8] = GL_UNSIGNED_BYTE, /* GL has this, Vulkan does not */
       [GPU_INDEX_U16] = GL_UNSIGNED_SHORT,
       [GPU_INDEX_U32] = GL_UNSIGNED_INT,
   };
@@ -47,7 +48,6 @@ uint GPU_indexbuf_size_get(const GPUIndexBuf *elem)
 {
 #if GPU_TRACK_INDEX_RANGE
   static const uint table[] = {
-      [GPU_INDEX_U8] = sizeof(GLubyte), /* GL has this, Vulkan does not */
       [GPU_INDEX_U16] = sizeof(GLushort),
       [GPU_INDEX_U32] = sizeof(GLuint),
   };
@@ -80,10 +80,8 @@ int GPU_indexbuf_primitive_len(GPUPrimType prim_type)
 void GPU_indexbuf_init_ex(GPUIndexBufBuilder *builder,
                           GPUPrimType prim_type,
                           uint index_len,
-                          uint vertex_len,
-                          bool use_prim_restart)
+                          uint vertex_len)
 {
-  builder->use_prim_restart = use_prim_restart;
   builder->max_allowed_index = vertex_len - 1;
   builder->max_index_len = index_len;
   builder->index_len = 0;  // start empty
@@ -100,7 +98,7 @@ void GPU_indexbuf_init(GPUIndexBufBuilder *builder,
 #if TRUST_NO_ONE
   assert(verts_per_prim != -1);
 #endif
-  GPU_indexbuf_init_ex(builder, prim_type, prim_len * (uint)verts_per_prim, vertex_len, false);
+  GPU_indexbuf_init_ex(builder, prim_type, prim_len * (uint)verts_per_prim, vertex_len);
 }
 
 void GPU_indexbuf_add_generic_vert(GPUIndexBufBuilder *builder, uint v)
@@ -118,9 +116,8 @@ void GPU_indexbuf_add_primitive_restart(GPUIndexBufBuilder *builder)
 #if TRUST_NO_ONE
   assert(builder->data != NULL);
   assert(builder->index_len < builder->max_index_len);
-  assert(builder->use_prim_restart);
 #endif
-  builder->data[builder->index_len++] = GPU_PRIM_RESTART;
+  builder->data[builder->index_len++] = RESTART_INDEX;
 }
 
 void GPU_indexbuf_add_point_vert(GPUIndexBufBuilder *builder, uint v)
@@ -180,7 +177,7 @@ static uint index_range(const uint values[], uint value_len, uint *min_out, uint
   uint max_value = values[0];
   for (uint i = 1; i < value_len; ++i) {
     const uint value = values[i];
-    if (value == GPU_PRIM_RESTART) {
+    if (value == RESTART_INDEX) {
       continue;
     }
     else if (value < min_value) {
@@ -195,33 +192,10 @@ static uint index_range(const uint values[], uint value_len, uint *min_out, uint
   return max_value - min_value;
 }
 
-static void squeeze_indices_byte(GPUIndexBufBuilder *builder, GPUIndexBuf *elem)
-{
-  const uint *values = builder->data;
-  const uint index_len = elem->index_len;
-
-  /* data will never be *larger* than builder->data...
-   * converting in place to avoid extra allocation */
-  GLubyte *data = (GLubyte *)builder->data;
-
-  if (elem->max_index > 0xFF) {
-    const uint base = elem->min_index;
-    elem->base_index = base;
-    elem->min_index = 0;
-    elem->max_index -= base;
-    for (uint i = 0; i < index_len; ++i) {
-      data[i] = (values[i] == GPU_PRIM_RESTART) ? 0xFF : (GLubyte)(values[i] - base);
-    }
-  }
-  else {
-    elem->base_index = 0;
-    for (uint i = 0; i < index_len; ++i) {
-      data[i] = (GLubyte)(values[i]);
-    }
-  }
-}
-
-static void squeeze_indices_short(GPUIndexBufBuilder *builder, GPUIndexBuf *elem)
+static void squeeze_indices_short(GPUIndexBufBuilder *builder,
+                                  GPUIndexBuf *elem,
+                                  uint min_index,
+                                  uint max_index)
 {
   const uint *values = builder->data;
   const uint index_len = elem->index_len;
@@ -230,13 +204,10 @@ static void squeeze_indices_short(GPUIndexBufBuilder *builder, GPUIndexBuf *elem
    * converting in place to avoid extra allocation */
   GLushort *data = (GLushort *)builder->data;
 
-  if (elem->max_index > 0xFFFF) {
-    const uint base = elem->min_index;
-    elem->base_index = base;
-    elem->min_index = 0;
-    elem->max_index -= base;
+  if (max_index > 0xFFFF) {
+    elem->base_index = min_index;
     for (uint i = 0; i < index_len; ++i) {
-      data[i] = (values[i] == GPU_PRIM_RESTART) ? 0xFFFF : (GLushort)(values[i] - base);
+      data[i] = (values[i] == RESTART_INDEX) ? 0xFFFF : (GLushort)(values[i] - min_index);
     }
   }
   else {
@@ -262,24 +233,18 @@ void GPU_indexbuf_build_in_place(GPUIndexBufBuilder *builder, GPUIndexBuf *elem)
   assert(builder->data != NULL);
 #endif
   elem->index_len = builder->index_len;
-  elem->use_prim_restart = builder->use_prim_restart;
   elem->ibo_id = 0; /* Created at first use. */
 
 #if GPU_TRACK_INDEX_RANGE
-  uint range = index_range(builder->data, builder->index_len, &elem->min_index, &elem->max_index);
+  uint min_index, max_index;
+  uint range = index_range(builder->data, builder->index_len, &min_index, &max_index);
 
   /* count the primitive restart index. */
-  if (elem->use_prim_restart) {
-    range += 1;
-  }
+  range += 1;
 
-  if (range <= 0xFF) {
-    elem->index_type = GPU_INDEX_U8;
-    squeeze_indices_byte(builder, elem);
-  }
-  else if (range <= 0xFFFF) {
+  if (range <= 0xFFFF) {
     elem->index_type = GPU_INDEX_U16;
-    squeeze_indices_short(builder, elem);
+    squeeze_indices_short(builder, elem, min_index, max_index);
   }
   else {
     elem->index_type = GPU_INDEX_U32;