OpenGL: stipple support added to basic GLSL shader
[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
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /* Fixed Function Shader */
42
43 typedef enum GPUBasicShaderOption {
44         GPU_SHADER_USE_COLOR =        (1<<0),   /* use glColor, for lighting it replaces diffuse */
45         GPU_SHADER_LIGHTING =         (1<<1),   /* use lighting */
46         GPU_SHADER_TWO_SIDED =        (1<<2),   /* flip normals towards viewer */
47         GPU_SHADER_TEXTURE_2D =       (1<<3),   /* use 2D texture to replace diffuse color */
48
49         GPU_SHADER_SOLID_LIGHTING =   (1<<4),   /* use faster lighting (set automatically) */
50         GPU_SHADER_STIPPLE =          (1<<5),   /* use stipple */
51         GPU_SHADER_OPTIONS_NUM = 6,
52         GPU_SHADER_OPTION_COMBINATIONS = (1<<GPU_SHADER_OPTIONS_NUM)
53 } GPUBasicShaderOption;
54
55 /* Keep these in sync with gpu_shader_basic_frag.glsl */
56 typedef enum GPUBasicShaderStipple {
57         GPU_SHADER_STIPPLE_HALFTONE                        = 0,
58         GPU_SHADER_STIPPLE_QUARTTONE                       = 1,
59         GPU_SHADER_STIPPLE_CHECKER_8PX                     = 2,
60         GPU_SHADER_STIPPLE_HEXAGON                         = 3,
61         GPU_SHADER_STIPPLE_DIAG_STRIPES                    = 4,
62         GPU_SHADER_STIPPLE_DIAG_STRIPES_SWAP               = 5,
63         GPU_SHADER_STIPPLE_S3D_INTERLACE_ROW               = 6,
64         GPU_SHADER_STIPPLE_S3D_INTERLACE_ROW_SWAP          = 7,
65         GPU_SHADER_STIPPLE_S3D_INTERLACE_COLUMN            = 8,
66         GPU_SHADER_STIPPLE_S3D_INTERLACE_COLUMN_SWAP       = 9,
67         GPU_SHADER_STIPPLE_S3D_INTERLACE_CHECKER           = 10,
68         GPU_SHADER_STIPPLE_S3D_INTERLACE_CHECKER_SWAP      = 11
69 } GPUBasicShaderStipple;
70
71 void GPU_basic_shaders_init(void);
72 void GPU_basic_shaders_exit(void);
73
74 void GPU_basic_shader_bind(int options);
75 int GPU_basic_shader_bound_options(void);
76
77 void GPU_basic_shader_colors(const float diffuse[3], const float specular[3],
78         int shininess, float alpha);
79
80 /* Fixed Function Lighting */
81
82 typedef enum GPULightType {
83         GPU_LIGHT_POINT,
84         GPU_LIGHT_SPOT,
85         GPU_LIGHT_SUN
86 } GPULightType;
87
88 typedef struct GPULightData {
89         GPULightType type;
90
91         float position[3];
92         float direction[3];
93
94         float diffuse[3];
95         float specular[3];
96
97         float constant_attenuation;
98         float linear_attenuation;
99         float quadratic_attenuation;
100
101         float spot_cutoff;
102         float spot_exponent;
103 } GPULightData;
104
105 void GPU_basic_shader_light_set(int light_num, GPULightData *light);
106 void GPU_basic_shader_light_set_viewer(bool local);
107 void GPU_basic_shader_stipple(GPUBasicShaderStipple stipple_id);
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif
114