Cleanup: comment line length (editors)
[blender.git] / source / blender / gpu / GPU_basic_shader.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) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_basic_shader.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_BASIC_SHADER_H__
33 #define __GPU_BASIC_SHADER_H__
34
35 #include "BLI_utildefines.h"
36 #include "GPU_glew.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /* Fixed Function Shader */
43
44 typedef enum GPUBasicShaderOption {
45         GPU_SHADER_USE_COLOR =        (1 << 0),   /* use glColor, for lighting it replaces diffuse */
46         GPU_SHADER_LIGHTING =         (1 << 1),   /* use lighting */
47         GPU_SHADER_TWO_SIDED =        (1 << 2),   /* flip normals towards viewer */
48         GPU_SHADER_TEXTURE_2D =       (1 << 3),   /* use 2D texture to replace diffuse color */
49         GPU_SHADER_TEXTURE_RECT =     (1 << 4),   /* same as GPU_SHADER_TEXTURE_2D, for GL_TEXTURE_RECTANGLE */
50
51         GPU_SHADER_SOLID_LIGHTING =   (1 << 5),   /* use faster lighting (set automatically) */
52         GPU_SHADER_STIPPLE =          (1 << 6),   /* use stipple */
53         GPU_SHADER_LINE =             (1 << 7),   /* draw lines */
54         GPU_SHADER_FLAT_NORMAL =      (1 << 8),   /* use flat normals */
55         GPU_SHADER_OPTIONS_NUM = 9,
56         GPU_SHADER_OPTION_COMBINATIONS = (1 << GPU_SHADER_OPTIONS_NUM)
57 } GPUBasicShaderOption;
58
59 /* Keep these in sync with gpu_shader_basic_frag.glsl */
60 typedef enum GPUBasicShaderStipple {
61         GPU_SHADER_STIPPLE_HALFTONE                        = 0,
62         GPU_SHADER_STIPPLE_QUARTTONE                       = 1,
63         GPU_SHADER_STIPPLE_CHECKER_8PX                     = 2,
64         GPU_SHADER_STIPPLE_HEXAGON                         = 3,
65         GPU_SHADER_STIPPLE_DIAG_STRIPES                    = 4,
66         GPU_SHADER_STIPPLE_DIAG_STRIPES_SWAP               = 5,
67         GPU_SHADER_STIPPLE_S3D_INTERLACE_ROW               = 6,
68         GPU_SHADER_STIPPLE_S3D_INTERLACE_ROW_SWAP          = 7,
69         GPU_SHADER_STIPPLE_S3D_INTERLACE_COLUMN            = 8,
70         GPU_SHADER_STIPPLE_S3D_INTERLACE_COLUMN_SWAP       = 9,
71         GPU_SHADER_STIPPLE_S3D_INTERLACE_CHECKER           = 10,
72         GPU_SHADER_STIPPLE_S3D_INTERLACE_CHECKER_SWAP      = 11
73 } GPUBasicShaderStipple;
74
75 void GPU_basic_shaders_init(void);
76 void GPU_basic_shaders_exit(void);
77
78 void GPU_basic_shader_bind(int options);
79 void GPU_basic_shader_bind_enable(int options);
80 void GPU_basic_shader_bind_disable(int options);
81
82 int GPU_basic_shader_bound_options(void);
83
84 /* Only use for small blocks of code that don't support glsl shader. */
85 #define GPU_BASIC_SHADER_DISABLE_AND_STORE(bound_options) \
86 if (GPU_basic_shader_use_glsl_get()) { \
87         if ((bound_options = GPU_basic_shader_bound_options())) { \
88                 GPU_basic_shader_bind(0); \
89         } \
90 } \
91 else { bound_options = 0; } ((void)0)
92 #define GPU_BASIC_SHADER_ENABLE_AND_RESTORE(bound_options) \
93 if (GPU_basic_shader_use_glsl_get()) { \
94         if (bound_options) { \
95                 GPU_basic_shader_bind(bound_options); \
96         } \
97 } ((void)0)
98
99
100 void GPU_basic_shader_colors(
101         const float diffuse[3], const float specular[3],
102         int shininess, float alpha);
103
104 /* Fixed Function Lighting */
105
106 typedef enum GPULightType {
107         GPU_LIGHT_POINT,
108         GPU_LIGHT_SPOT,
109         GPU_LIGHT_SUN
110 } GPULightType;
111
112 typedef struct GPULightData {
113         GPULightType type;
114
115         float position[3];
116         float direction[3];
117
118         float diffuse[3];
119         float specular[3];
120
121         float constant_attenuation;
122         float linear_attenuation;
123         float quadratic_attenuation;
124
125         float spot_cutoff;
126         float spot_exponent;
127 } GPULightData;
128
129 void GPU_basic_shader_light_set(int light_num, GPULightData *light);
130 void GPU_basic_shader_light_set_viewer(bool local);
131 void GPU_basic_shader_stipple(GPUBasicShaderStipple stipple_id);
132 void GPU_basic_shader_line_stipple(GLint stipple_factor, GLushort stipple_pattern);
133 void GPU_basic_shader_line_width(float line_width);
134
135 bool GPU_basic_shader_use_glsl_get(void);
136 void GPU_basic_shader_use_glsl_set(bool enabled);
137
138 #ifdef __cplusplus
139 }
140 #endif
141
142 #endif