Merge branch 'blender2.7'
[blender.git] / source / blender / gpu / GPU_immediate.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Mike Erwin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/gpu/GPU_immediate.h
28  *  \ingroup gpu
29  *
30  * GPU immediate mode work-alike
31  */
32
33 #ifndef __GPU_IMMEDIATE_H__
34 #define __GPU_IMMEDIATE_H__
35
36 #include "GPU_vertex_format.h"
37 #include "GPU_primitive.h"
38 #include "GPU_shader_interface.h"
39 #include "GPU_batch.h"
40 #include "GPU_immediate_util.h"
41 #include "GPU_shader.h"
42
43 GPUVertFormat *immVertexFormat(void); /* returns a cleared vertex format, ready for add_attrib. */
44
45 void immBindProgram(uint32_t program, const GPUShaderInterface *); /* every immBegin must have a program bound first. */
46 void immUnbindProgram(void); /* call after your last immEnd, or before binding another program. */
47
48 void immBegin(GPUPrimType, uint vertex_len); /* must supply exactly vertex_len vertices. */
49 void immBeginAtMost(GPUPrimType, uint max_vertex_len); /* can supply fewer vertices. */
50 void immEnd(void); /* finishes and draws. */
51
52 /* ImmBegin a batch, then use standard immFunctions as usual. */
53 /* ImmEnd will finalize the batch instead of drawing. */
54 /* Then you can draw it as many times as you like! Partially replaces the need for display lists. */
55 GPUBatch *immBeginBatch(GPUPrimType, uint vertex_len);
56 GPUBatch *immBeginBatchAtMost(GPUPrimType, uint vertex_len);
57
58 /* Provide attribute values that can change per vertex. */
59 /* First vertex after immBegin must have all its attributes specified. */
60 /* Skipped attributes will continue using the previous value for that attr_id. */
61 void immAttr1f(uint attr_id, float x);
62 void immAttr2f(uint attr_id, float x, float y);
63 void immAttr3f(uint attr_id, float x, float y, float z);
64 void immAttr4f(uint attr_id, float x, float y, float z, float w);
65
66 void immAttr2i(uint attr_id, int x, int y);
67
68 void immAttr1u(uint attr_id, uint x);
69
70 void immAttr2s(uint attr_id, short x, short y);
71
72 void immAttr2fv(uint attr_id, const float data[2]);
73 void immAttr3fv(uint attr_id, const float data[3]);
74 void immAttr4fv(uint attr_id, const float data[4]);
75
76 void immAttr3ub(uint attr_id, unsigned char r, unsigned char g, unsigned char b);
77 void immAttr4ub(uint attr_id, unsigned char r, unsigned char g, unsigned char b, unsigned char a);
78
79 void immAttr3ubv(uint attr_id, const unsigned char data[3]);
80 void immAttr4ubv(uint attr_id, const unsigned char data[4]);
81
82 /* Explicitly skip an attribute. */
83 /* This advanced option kills automatic value copying for this attr_id. */
84 void immAttrSkip(uint attr_id);
85
86 /* Provide one last attribute value & end the current vertex. */
87 /* This is most often used for 2D or 3D position (similar to glVertex). */
88 void immVertex2f(uint attr_id, float x, float y);
89 void immVertex3f(uint attr_id, float x, float y, float z);
90 void immVertex4f(uint attr_id, float x, float y, float z, float w);
91
92 void immVertex2i(uint attr_id, int x, int y);
93
94 void immVertex2s(uint attr_id, short x, short y);
95
96 void immVertex2fv(uint attr_id, const float data[2]);
97 void immVertex3fv(uint attr_id, const float data[3]);
98
99 void immVertex2iv(uint attr_id, const int data[2]);
100
101 /* Provide uniform values that don't change for the entire draw call. */
102 void immUniform1i(const char *name, int x);
103 void immUniform4iv(const char *name, const int data[4]);
104 void immUniform1f(const char *name, float x);
105 void immUniform2f(const char *name, float x, float y);
106 void immUniform2fv(const char *name, const float data[2]);
107 void immUniform3f(const char *name, float x, float y, float z);
108 void immUniform3fv(const char *name, const float data[3]);
109 void immUniformArray3fv(const char *name, const float *data, int count);
110 void immUniform4f(const char *name, float x, float y, float z, float w);
111 void immUniform4fv(const char *name, const float data[4]);
112 void immUniformArray4fv(const char *bare_name, const float *data, int count);
113 void immUniformMatrix4fv(const char *name, const float data[4][4]);
114
115 /* Convenience functions for setting "uniform vec4 color". */
116 /* The rgb functions have implicit alpha = 1.0. */
117 void immUniformColor4f(float r, float g, float b, float a);
118 void immUniformColor4fv(const float rgba[4]);
119 void immUniformColor3f(float r, float g, float b);
120 void immUniformColor3fv(const float rgb[3]);
121 void immUniformColor3fvAlpha(const float rgb[3], float a);
122
123 void immUniformColor3ub(unsigned char r, unsigned char g, unsigned char b);
124 void immUniformColor4ub(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
125 void immUniformColor3ubv(const unsigned char rgb[3]);
126 void immUniformColor3ubvAlpha(const unsigned char rgb[3], unsigned char a);
127 void immUniformColor4ubv(const unsigned char rgba[4]);
128
129 /* Extend immBindProgram to use Blender’s library of built-in shader programs.
130  * Use immUnbindProgram() when done. */
131 void immBindBuiltinProgram(GPUBuiltinShader shader_id);
132
133 /* Extend immUniformColor to take Blender's themes */
134 void immUniformThemeColor(int color_id);
135 void immUniformThemeColor3(int color_id);
136 void immUniformThemeColorShade(int color_id, int offset);
137 void immUniformThemeColorShadeAlpha(int color_id, int color_offset, int alpha_offset);
138 void immUniformThemeColorBlendShade(int color_id1, int color_id2, float fac, int offset);
139 void immUniformThemeColorBlend(int color_id1, int color_id2, float fac);
140 void immThemeColorShadeAlpha(int colorid, int coloffset, int alphaoffset);
141
142 /* These are called by the system -- not part of drawing API. */
143 void immInit(void);
144 void immActivate(void);
145 void immDeactivate(void);
146 void immDestroy(void);
147
148 #endif  /* __GPU_IMMEDIATE_H__ */