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