Fix T62178 Eevee: Texture Box mapping not matching Cycles if object is scaled
[blender.git] / source / blender / gpu / GPU_vertex_buffer.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2016 by Mike Erwin.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup gpu
22  *
23  * GPU vertex buffer
24  */
25
26 #ifndef __GPU_VERTEX_BUFFER_H__
27 #define __GPU_VERTEX_BUFFER_H__
28
29 #include "GPU_vertex_format.h"
30
31 #define VRAM_USAGE 1
32 /**
33  * How to create a #GPUVertBuf:
34  * 1) verts = GPU_vertbuf_create() or GPU_vertbuf_init(verts)
35  * 2) GPU_vertformat_attr_add(verts->format, ...)
36  * 3) GPU_vertbuf_data_alloc(verts, vertex_len) <-- finalizes/packs vertex format
37  * 4) GPU_vertbuf_attr_fill(verts, pos, application_pos_buffer)
38  */
39
40 /* Is GPUVertBuf always used as part of a GPUBatch? */
41
42 typedef enum {
43         /* can be extended to support more types */
44         GPU_USAGE_STREAM,
45         GPU_USAGE_STATIC, /* do not keep data in memory */
46         GPU_USAGE_DYNAMIC
47 } GPUUsageType;
48
49 typedef struct GPUVertBuf {
50         GPUVertFormat format;
51         uint vertex_len;    /* number of verts we want to draw */
52         uint vertex_alloc;  /* number of verts data */
53         bool dirty;
54         unsigned char *data; /* NULL indicates data in VRAM (unmapped) */
55         uint32_t vbo_id; /* 0 indicates not yet allocated */
56         GPUUsageType usage; /* usage hint for GL optimisation */
57 } GPUVertBuf;
58
59 GPUVertBuf *GPU_vertbuf_create(GPUUsageType);
60 GPUVertBuf *GPU_vertbuf_create_with_format_ex(const GPUVertFormat *, GPUUsageType);
61
62 #define GPU_vertbuf_create_with_format(format) \
63         GPU_vertbuf_create_with_format_ex(format, GPU_USAGE_STATIC)
64
65 void GPU_vertbuf_discard(GPUVertBuf *);
66
67 void GPU_vertbuf_init(GPUVertBuf *, GPUUsageType);
68 void GPU_vertbuf_init_with_format_ex(GPUVertBuf *, const GPUVertFormat *, GPUUsageType);
69
70 #define GPU_vertbuf_init_with_format(verts, format) \
71         GPU_vertbuf_init_with_format_ex(verts, format, GPU_USAGE_STATIC)
72
73 uint GPU_vertbuf_size_get(const GPUVertBuf *);
74 void GPU_vertbuf_data_alloc(GPUVertBuf *, uint v_len);
75 void GPU_vertbuf_data_resize(GPUVertBuf *, uint v_len);
76 void GPU_vertbuf_data_len_set(GPUVertBuf *, uint v_len);
77
78 /* The most important #set_attr variant is the untyped one. Get it right first.
79  * It takes a void* so the app developer is responsible for matching their app data types
80  * to the vertex attribute's type and component count. They're in control of both, so this
81  * should not be a problem. */
82
83 void GPU_vertbuf_attr_set(GPUVertBuf *, uint a_idx, uint v_idx, const void *data);
84 void GPU_vertbuf_attr_fill(GPUVertBuf *, uint a_idx, const void *data); /* tightly packed, non interleaved input data */
85 void GPU_vertbuf_attr_fill_stride(GPUVertBuf *, uint a_idx, uint stride, const void *data);
86
87 /* For low level access only */
88 typedef struct GPUVertBufRaw {
89         uint size;
90         uint stride;
91         unsigned char *data;
92         unsigned char *data_init;
93 #if TRUST_NO_ONE
94         /* Only for overflow check */
95         unsigned char *_data_end;
96 #endif
97 } GPUVertBufRaw;
98
99 GPU_INLINE void *GPU_vertbuf_raw_step(GPUVertBufRaw *a)
100 {
101         unsigned char *data = a->data;
102         a->data += a->stride;
103 #if TRUST_NO_ONE
104         assert(data < a->_data_end);
105 #endif
106         return (void *)data;
107 }
108
109 GPU_INLINE uint GPU_vertbuf_raw_used(GPUVertBufRaw *a)
110 {
111         return ((a->data - a->data_init) / a->stride);
112 }
113
114 void GPU_vertbuf_attr_get_raw_data(GPUVertBuf *, uint a_idx, GPUVertBufRaw *access);
115
116 void GPU_vertbuf_use(GPUVertBuf *);
117
118 /* Metrics */
119 uint GPU_vertbuf_get_memory_usage(void);
120
121 /* Macros */
122 #define GPU_VERTBUF_DISCARD_SAFE(verts) do { \
123         if (verts != NULL) { \
124                 GPU_vertbuf_discard(verts); \
125                 verts = NULL; \
126         } \
127 } while (0)
128
129 #endif /* __GPU_VERTEX_BUFFER_H__ */