Welcome to mirror list, hosted at ThFree Co, Russian Federation.

vertex_buffer.h « gawain « gawain « intern - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 46f83f5c551fe00ad623ff4fd98c6649ce51e854 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

// Gawain vertex buffer
//
// This code is part of the Gawain library, with modifications
// specific to integration with Blender.
//
// Copyright 2016 Mike Erwin
//
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of
// the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

#pragma once

#include "vertex_format.h"

// How to create a Gwn_VertBuf:
// 1) verts = GWN_vertbuf_create() or GWN_vertbuf_init(verts)
// 2) GWN_vertformat_attr_add(verts->format, ...)
// 3) GWN_vertbuf_data_alloc(verts, vertex_ct) <-- finalizes/packs vertex format
// 4) GWN_vertbuf_attr_fill(verts, pos, application_pos_buffer)

// Is Gwn_VertBuf always used as part of a Gwn_Batch?

typedef struct {
	Gwn_VertFormat format;
	unsigned vertex_ct;
	GLubyte* data; // NULL indicates data in VRAM (unmapped) or not yet allocated
	GLuint vbo_id; // 0 indicates not yet sent to VRAM
} Gwn_VertBuf;

Gwn_VertBuf* GWN_vertbuf_create(void);
Gwn_VertBuf* GWN_vertbuf_create_with_format(const Gwn_VertFormat*);

void GWN_vertbuf_discard(Gwn_VertBuf*);

void GWN_vertbuf_init(Gwn_VertBuf*);
void GWN_vertbuf_init_with_format(Gwn_VertBuf*, const Gwn_VertFormat*);

unsigned GWN_vertbuf_size_get(const Gwn_VertBuf*);
void GWN_vertbuf_data_alloc(Gwn_VertBuf*, unsigned v_ct);
void GWN_vertbuf_data_resize(Gwn_VertBuf*, unsigned v_ct);

// The most important set_attrib variant is the untyped one. Get it right first.
// It takes a void* so the app developer is responsible for matching their app data types
// to the vertex attribute's type and component count. They're in control of both, so this
// should not be a problem.

void GWN_vertbuf_attr_set(Gwn_VertBuf*, unsigned a_idx, unsigned v_idx, const void* data);
void GWN_vertbuf_attr_fill(Gwn_VertBuf*, unsigned a_idx, const void* data); // tightly packed, non interleaved input data
void GWN_vertbuf_attr_fill_stride(Gwn_VertBuf*, unsigned a_idx, unsigned stride, const void* data);

// TODO: decide whether to keep the functions below
// doesn't immediate mode satisfy these needs?

//	void setAttrib1f(unsigned a_idx, unsigned v_idx, float x);
//	void setAttrib2f(unsigned a_idx, unsigned v_idx, float x, float y);
//	void setAttrib3f(unsigned a_idx, unsigned v_idx, float x, float y, float z);
//	void setAttrib4f(unsigned a_idx, unsigned v_idx, float x, float y, float z, float w);
//
//	void setAttrib3ub(unsigned a_idx, unsigned v_idx, unsigned char r, unsigned char g, unsigned char b);
//	void setAttrib4ub(unsigned a_idx, unsigned v_idx, unsigned char r, unsigned char g, unsigned char b, unsigned char a);

void GWN_vertbuf_use(Gwn_VertBuf*);


// Metrics

unsigned GWN_vertbuf_get_memory_usage(void);


// Macros

#define GWN_VERTBUF_DISCARD_SAFE(verts) do { \
	if (verts != NULL) { \
		GWN_vertbuf_discard(verts); \
		verts = NULL; \
	} \
} while (0)