Cleanup: replace attrib w/ attr
[blender.git] / source / blender / gpu / GPU_shader_interface.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 by Mike Erwin.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/gpu/GPU_shader_interface.h
27  *  \ingroup gpu
28  *
29  * GPU shader interface (C --> GLSL)
30  */
31
32 #ifndef __GPU_SHADER_INTERFACE_H__
33 #define __GPU_SHADER_INTERFACE_H__
34
35 #include "GPU_common.h"
36
37 typedef enum {
38         GPU_UNIFORM_NONE = 0, /* uninitialized/unknown */
39
40         GPU_UNIFORM_MODEL,      /* mat4 ModelMatrix */
41         GPU_UNIFORM_VIEW,       /* mat4 ViewMatrix */
42         GPU_UNIFORM_MODELVIEW,  /* mat4 ModelViewMatrix */
43         GPU_UNIFORM_PROJECTION, /* mat4 ProjectionMatrix */
44         GPU_UNIFORM_VIEWPROJECTION, /* mat4 ViewProjectionMatrix */
45         GPU_UNIFORM_MVP,        /* mat4 ModelViewProjectionMatrix */
46
47         GPU_UNIFORM_MODEL_INV,           /* mat4 ModelMatrixInverse */
48         GPU_UNIFORM_VIEW_INV,            /* mat4 ViewMatrixInverse */
49         GPU_UNIFORM_MODELVIEW_INV,       /* mat4 ModelViewMatrixInverse */
50         GPU_UNIFORM_PROJECTION_INV,      /* mat4 ProjectionMatrixInverse */
51         GPU_UNIFORM_VIEWPROJECTION_INV,  /* mat4 ViewProjectionMatrixInverse */
52
53         GPU_UNIFORM_NORMAL,      /* mat3 NormalMatrix */
54         GPU_UNIFORM_WORLDNORMAL, /* mat3 WorldNormalMatrix */
55         GPU_UNIFORM_CAMERATEXCO, /* vec4 CameraTexCoFactors */
56         GPU_UNIFORM_ORCO,        /* vec3 OrcoTexCoFactors[] */
57
58         GPU_UNIFORM_COLOR, /* vec4 color */
59         GPU_UNIFORM_EYE, /* vec3 eye */
60         GPU_UNIFORM_CALLID, /* int callId */
61         GPU_UNIFORM_OBJECT_INFO, /* vec3 objectInfo */
62
63         GPU_UNIFORM_CUSTOM, /* custom uniform, not one of the above built-ins */
64
65         GPU_NUM_UNIFORMS, /* Special value, denotes number of builtin uniforms. */
66 } GPUUniformBuiltin;
67
68 typedef struct GPUShaderInput {
69         struct GPUShaderInput *next;
70         uint32_t name_offset;
71         uint name_hash;
72         /** Only for uniform inputs. */
73         GPUUniformBuiltin builtin_type;
74         /** Only for attribute inputs. */
75         uint32_t gl_type;
76         /** Only for attribute inputs. */
77         int32_t size;
78         int32_t location;
79 } GPUShaderInput;
80
81 #define GPU_NUM_SHADERINTERFACE_BUCKETS 257
82 #define GPU_SHADERINTERFACE_REF_ALLOC_COUNT 16
83
84 typedef struct GPUShaderInterface {
85         int32_t program;
86         uint32_t name_buffer_offset;
87         GPUShaderInput *attr_buckets[GPU_NUM_SHADERINTERFACE_BUCKETS];
88         GPUShaderInput *uniform_buckets[GPU_NUM_SHADERINTERFACE_BUCKETS];
89         GPUShaderInput *ubo_buckets[GPU_NUM_SHADERINTERFACE_BUCKETS];
90         GPUShaderInput *builtin_uniforms[GPU_NUM_UNIFORMS];
91         char *name_buffer;
92         struct GPUBatch **batches; /* references to batches using this interface */
93         uint batches_len;
94 } GPUShaderInterface;
95
96 GPUShaderInterface *GPU_shaderinterface_create(int32_t program_id);
97 void GPU_shaderinterface_discard(GPUShaderInterface *);
98
99 const GPUShaderInput *GPU_shaderinterface_uniform(const GPUShaderInterface *, const char *name);
100 const GPUShaderInput *GPU_shaderinterface_uniform_ensure(const GPUShaderInterface *, const char *name);
101 const GPUShaderInput *GPU_shaderinterface_uniform_builtin(const GPUShaderInterface *, GPUUniformBuiltin);
102 const GPUShaderInput *GPU_shaderinterface_ubo(const GPUShaderInterface *, const char *name);
103 const GPUShaderInput *GPU_shaderinterface_attr(const GPUShaderInterface *, const char *name);
104
105 /* keep track of batches using this interface */
106 void GPU_shaderinterface_add_batch_ref(GPUShaderInterface *, struct GPUBatch *);
107 void GPU_shaderinterface_remove_batch_ref(GPUShaderInterface *, struct GPUBatch *);
108
109 #endif /* __GPU_SHADER_INTERFACE_H__ */