#include "BLI_utildefines.h"
#include "GPU_index_buffer.h"
#include "GPU_shader.h"
#include "GPU_vertex_buffer.h"

Macros
#define	GPU_BATCH_VBO_MAX_LEN 6

#define	GPU_BATCH_INST_VBO_MAX_LEN 2

#define	GPU_BATCH_VAO_STATIC_LEN 3

#define	GPU_BATCH_VAO_DYN_ALLOC_COUNT 16

#define	GPU_BATCH_OWNS_NONE GPU_BATCH_INVALID

#define	GPU_batch_create(prim, verts, elem) GPU_batch_create_ex(prim, verts, elem, 0)

#define	GPU_batch_init(batch, prim, verts, elem) GPU_batch_init_ex(batch, prim, verts, elem, 0)

#define	GPU_batch_vertbuf_add(batch, verts) GPU_batch_vertbuf_add_ex(batch, verts, false)

#define	GPU_batch_uniform_1i(batch, name, x) GPU_shader_uniform_1i((batch)->shader, name, x);

#define	GPU_batch_uniform_1b(batch, name, x) GPU_shader_uniform_1b((batch)->shader, name, x);

#define	GPU_batch_uniform_1f(batch, name, x) GPU_shader_uniform_1f((batch)->shader, name, x);

#define	GPU_batch_uniform_2f(batch, name, x, y) GPU_shader_uniform_2f((batch)->shader, name, x, y);

#define	GPU_batch_uniform_3f(batch, name, x, y, z) GPU_shader_uniform_3f((batch)->shader, name, x, y, z);

#define	GPU_batch_uniform_4f(batch, name, x, y, z, w) GPU_shader_uniform_4f((batch)->shader, name, x, y, z, w);

#define	GPU_batch_uniform_2fv(batch, name, val) GPU_shader_uniform_2fv((batch)->shader, name, val);

#define	GPU_batch_uniform_3fv(batch, name, val) GPU_shader_uniform_3fv((batch)->shader, name, val);

#define	GPU_batch_uniform_4fv(batch, name, val) GPU_shader_uniform_4fv((batch)->shader, name, val);

#define	GPU_batch_uniform_2fv_array(batch, name, len, val) GPU_shader_uniform_2fv_array((batch)->shader, name, len, val);

#define	GPU_batch_uniform_4fv_array(batch, name, len, val) GPU_shader_uniform_4fv_array((batch)->shader, name, len, val);

#define	GPU_batch_uniform_mat4(batch, name, val) GPU_shader_uniform_mat4((batch)->shader, name, val);

#define	GPU_batch_texture_bind(batch, name, tex) GPU_texture_bind(tex, GPU_shader_get_texture_binding((batch)->shader, name));

#define	GPU_BATCH_DISCARD_SAFE(batch)

#define	GPU_BATCH_CLEAR_SAFE(batch)

#define	GPU_BATCH_DISCARD_ARRAY_SAFE(_batch_array, _len)

Typedefs
typedef enum eGPUBatchFlag	eGPUBatchFlag

Enumerations
enum	eGPUBatchFlag { GPU_BATCH_INVALID = 0 , GPU_BATCH_OWNS_VBO = (1 << 0) , GPU_BATCH_OWNS_VBO_MAX = (GPU_BATCH_OWNS_VBO << (GPU_BATCH_VBO_MAX_LEN - 1)) , GPU_BATCH_OWNS_VBO_ANY = ((GPU_BATCH_OWNS_VBO << GPU_BATCH_VBO_MAX_LEN) - 1) , GPU_BATCH_OWNS_INST_VBO = (GPU_BATCH_OWNS_VBO_MAX << 1) , GPU_BATCH_OWNS_INST_VBO_MAX = (GPU_BATCH_OWNS_INST_VBO << (GPU_BATCH_INST_VBO_MAX_LEN - 1)) , GPU_BATCH_OWNS_INST_VBO_ANY , GPU_BATCH_OWNS_INDEX = (GPU_BATCH_OWNS_INST_VBO_MAX << 1) , GPU_BATCH_INIT = (1 << 16) , GPU_BATCH_BUILDING = (1 << 16) , GPU_BATCH_DIRTY = (1 << 17) }

Functions
	BLI_STATIC_ASSERT (GPU_BATCH_OWNS_INDEX< GPU_BATCH_INIT, "eGPUBatchFlag: Error: status flags are shadowed by the ownership bits!") typedef struct GPUBatch

GPUBatch *	GPU_batch_calloc (void)

GPUBatch *	GPU_batch_create_ex (GPUPrimType prim, GPUVertBuf vert, GPUIndexBuf elem, eGPUBatchFlag owns_flag)

void	GPU_batch_init_ex (GPUBatch batch, GPUPrimType prim, GPUVertBuf vert, GPUIndexBuf *elem, eGPUBatchFlag owns_flag)

void	GPU_batch_copy (GPUBatch batch_dst, GPUBatch batch_src)

void	GPU_batch_clear (GPUBatch *)

void	GPU_batch_discard (GPUBatch *)

void	GPU_batch_instbuf_set (GPUBatch , GPUVertBuf , bool own_vbo)

void	GPU_batch_elembuf_set (GPUBatch batch, GPUIndexBuf elem, bool own_ibo)

int	GPU_batch_instbuf_add_ex (GPUBatch , GPUVertBuf , bool own_vbo)

int	GPU_batch_vertbuf_add_ex (GPUBatch , GPUVertBuf , bool own_vbo)

void	GPU_batch_set_shader (GPUBatch batch, GPUShader shader)

void	GPU_batch_program_set_imm_shader (GPUBatch *batch)

void	GPU_batch_program_set_builtin (GPUBatch *batch, eGPUBuiltinShader shader_id)

void	GPU_batch_program_set_builtin_with_config (GPUBatch *batch, eGPUBuiltinShader shader_id, eGPUShaderConfig sh_cfg)

void	GPU_batch_draw (GPUBatch *batch)

void	GPU_batch_draw_range (GPUBatch *batch, int v_first, int v_count)

void	GPU_batch_draw_instanced (GPUBatch *batch, int i_count)

void	GPU_batch_draw_advanced (GPUBatch *, int v_first, int v_count, int i_first, int i_count)

void	gpu_batch_init (void)

void	gpu_batch_exit (void)

Variables
	GPUBatch

Detailed Description

GPU geometry batch Contains VAOs + VBOs + Shader representing a drawable entity.

Definition in file GPU_batch.h.

Macro Definition Documentation

◆ GPU_BATCH_CLEAR_SAFE

#define GPU_BATCH_CLEAR_SAFE ( batch )

Value:

  do { \
    if (batch != NULL) { \
      GPU_batch_clear(batch); \
      memset(batch, 0, sizeof(*(batch))); \
    } \
  } while (0)

Definition at line 207 of file GPU_batch.h.

◆ GPU_batch_create

#define GPU_batch_create	(	prim,
		verts,
		elem
	)	GPU_batch_create_ex(prim, verts, elem, 0)

Definition at line 107 of file GPU_batch.h.

◆ GPU_BATCH_DISCARD_ARRAY_SAFE

#define GPU_BATCH_DISCARD_ARRAY_SAFE	(	_batch_array,
		_len
	)

Value:

  do { \
    if (_batch_array != NULL) { \
      BLI_assert(_len > 0); \
      for (int _i = 0; _i < _len; _i++) { \
        GPU_BATCH_DISCARD_SAFE(_batch_array[_i]); \
      } \
      MEM_freeN(_batch_array); \
    } \
  } while (0)

Definition at line 215 of file GPU_batch.h.

◆ GPU_BATCH_DISCARD_SAFE

#define GPU_BATCH_DISCARD_SAFE ( batch )

Value:

  do { \
    if (batch != NULL) { \
      GPU_batch_discard(batch); \
      batch = NULL; \
    } \
  } while (0)

Definition at line 199 of file GPU_batch.h.

◆ GPU_batch_init

#define GPU_batch_init	(	batch,
		prim,
		verts,
		elem
	)	GPU_batch_init_ex(batch, prim, verts, elem, 0)

Definition at line 108 of file GPU_batch.h.

◆ GPU_BATCH_INST_VBO_MAX_LEN

#define GPU_BATCH_INST_VBO_MAX_LEN 2

Definition at line 36 of file GPU_batch.h.

◆ GPU_BATCH_OWNS_NONE

#define GPU_BATCH_OWNS_NONE GPU_BATCH_INVALID

Definition at line 64 of file GPU_batch.h.

◆ GPU_batch_texture_bind

#define GPU_batch_texture_bind	(	batch,
		name,
		tex
	)	GPU_texture_bind(tex, GPU_shader_get_texture_binding((batch)->shader, name));

Definition at line 149 of file GPU_batch.h.

◆ GPU_batch_uniform_1b

#define GPU_batch_uniform_1b	(	batch,
		name,
		x
	)	GPU_shader_uniform_1b((batch)->shader, name, x);

Definition at line 133 of file GPU_batch.h.

◆ GPU_batch_uniform_1f

#define GPU_batch_uniform_1f	(	batch,
		name,
		x
	)	GPU_shader_uniform_1f((batch)->shader, name, x);

Definition at line 134 of file GPU_batch.h.

◆ GPU_batch_uniform_1i

#define GPU_batch_uniform_1i	(	batch,
		name,
		x
	)	GPU_shader_uniform_1i((batch)->shader, name, x);

Definition at line 132 of file GPU_batch.h.

◆ GPU_batch_uniform_2f

#define GPU_batch_uniform_2f	(	batch,
		name,
		x,
		y
	)	GPU_shader_uniform_2f((batch)->shader, name, x, y);

Definition at line 135 of file GPU_batch.h.

◆ GPU_batch_uniform_2fv

#define GPU_batch_uniform_2fv	(	batch,
		name,
		val
	)	GPU_shader_uniform_2fv((batch)->shader, name, val);

Definition at line 140 of file GPU_batch.h.

◆ GPU_batch_uniform_2fv_array

#define GPU_batch_uniform_2fv_array	(	batch,
		name,
		len,
		val
	)	GPU_shader_uniform_2fv_array((batch)->shader, name, len, val);

Definition at line 143 of file GPU_batch.h.

◆ GPU_batch_uniform_3f

#define GPU_batch_uniform_3f	(	batch,
		name,
		x,
		y,
		z
	)	GPU_shader_uniform_3f((batch)->shader, name, x, y, z);

Definition at line 136 of file GPU_batch.h.

◆ GPU_batch_uniform_3fv

#define GPU_batch_uniform_3fv	(	batch,
		name,
		val
	)	GPU_shader_uniform_3fv((batch)->shader, name, val);

Definition at line 141 of file GPU_batch.h.

◆ GPU_batch_uniform_4f

#define GPU_batch_uniform_4f	(	batch,
		name,
		x,
		y,
		z,
		w
	)	GPU_shader_uniform_4f((batch)->shader, name, x, y, z, w);

Definition at line 138 of file GPU_batch.h.

◆ GPU_batch_uniform_4fv

#define GPU_batch_uniform_4fv	(	batch,
		name,
		val
	)	GPU_shader_uniform_4fv((batch)->shader, name, val);

Definition at line 142 of file GPU_batch.h.

◆ GPU_batch_uniform_4fv_array

#define GPU_batch_uniform_4fv_array	(	batch,
		name,
		len,
		val
	)	GPU_shader_uniform_4fv_array((batch)->shader, name, len, val);

Definition at line 145 of file GPU_batch.h.

◆ GPU_batch_uniform_mat4

#define GPU_batch_uniform_mat4	(	batch,
		name,
		val
	)	GPU_shader_uniform_mat4((batch)->shader, name, val);

Definition at line 147 of file GPU_batch.h.

◆ GPU_BATCH_VAO_DYN_ALLOC_COUNT

#define GPU_BATCH_VAO_DYN_ALLOC_COUNT 16

Definition at line 38 of file GPU_batch.h.

◆ GPU_BATCH_VAO_STATIC_LEN

#define GPU_BATCH_VAO_STATIC_LEN 3

Definition at line 37 of file GPU_batch.h.

◆ GPU_BATCH_VBO_MAX_LEN

#define GPU_BATCH_VBO_MAX_LEN 6

Definition at line 35 of file GPU_batch.h.

◆ GPU_batch_vertbuf_add

#define GPU_batch_vertbuf_add	(	batch,
		verts
	)	GPU_batch_vertbuf_add_ex(batch, verts, false)

Definition at line 121 of file GPU_batch.h.

Typedef Documentation

◆ eGPUBatchFlag

typedef enum eGPUBatchFlag eGPUBatchFlag

Enumeration Type Documentation

◆ eGPUBatchFlag

enum eGPUBatchFlag

Enumerator
GPU_BATCH_INVALID	Invalid default state.
GPU_BATCH_OWNS_VBO	GPUVertBuf ownership. (One bit per vbo)
GPU_BATCH_OWNS_VBO_MAX
GPU_BATCH_OWNS_VBO_ANY
GPU_BATCH_OWNS_INST_VBO	Instance GPUVertBuf ownership. (One bit per vbo)
GPU_BATCH_OWNS_INST_VBO_MAX
GPU_BATCH_OWNS_INST_VBO_ANY
GPU_BATCH_OWNS_INDEX	GPUIndexBuf ownership.
GPU_BATCH_INIT	Has been initialized. At least one VBO is set.
GPU_BATCH_BUILDING	Batch is initialized but its VBOs are still being populated. (optional)
GPU_BATCH_DIRTY	Cached data need to be rebuild. (VAO, PSO, ...)

Definition at line 40 of file GPU_batch.h.

Function Documentation

◆ BLI_STATIC_ASSERT()

BLI_STATIC_ASSERT ( )

IMPORTANT: Do not allocate manually as the real struct is bigger (i.e: GLBatch). This is only the common and "public" part of the struct. Use the provided allocator. TODO(fclem): Make the content of this struct hidden and expose getters/setters.

verts[0] is required, others can be NULL

Instance attributes.

NULL if element list not needed

Bookkeeping.

Type of geometry to draw.

Current assigned shader. DEPRECATED. Here only for uniform binding.

Definition at line 66 of file GPU_batch.h.

References GPU_BATCH_INST_VBO_MAX_LEN, GPU_BATCH_VBO_MAX_LEN, GPUBatch, shader(), and verts.