Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / makesdna / DNA_color_types.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) 2006 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup DNA
21  */
22
23 #ifndef __DNA_COLOR_TYPES_H__
24 #define __DNA_COLOR_TYPES_H__
25
26 #include "DNA_vec_types.h"
27
28 /* general defines for kernel functions */
29 #define CM_RESOL 32
30 #define CM_TABLE 256
31 #define CM_TABLEDIV             (1.0f/256.0f)
32
33 #define CM_TOT  4
34
35 typedef struct CurveMapPoint {
36         float x, y;
37         /** Shorty for result lookup. */
38         short flag, shorty;
39 } CurveMapPoint;
40
41 /* curvepoint->flag */
42 enum {
43         CUMA_SELECT = (1 << 0),
44         CUMA_HANDLE_VECTOR = (1 << 1),
45         CUMA_HANDLE_AUTO_ANIM = (1 << 2),
46 };
47
48 typedef struct CurveMap {
49         short totpoint, flag;
50
51         /** Quick multiply value for reading table. */
52         float range;
53         /** The x-axis range for the table. */
54         float mintable, maxtable;
55         /** For extrapolated curves, the direction vector. */
56         float ext_in[2], ext_out[2];
57         /** Actual curve. */
58         CurveMapPoint *curve;
59         /** Display and evaluate table. */
60         CurveMapPoint *table;
61
62         /** For RGB curves, premulled table. */
63         CurveMapPoint *premultable;
64         /** For RGB curves, premulled extrapolation vector. */
65         float premul_ext_in[2];
66         float premul_ext_out[2];
67 } CurveMap;
68
69 /* cuma->flag */
70 #define CUMA_EXTEND_EXTRAPOLATE 1
71
72 typedef struct CurveMapping {
73         /** Cur; for buttons, to show active curve. */
74         int flag, cur;
75         int preset;
76         int changed_timestamp;
77
78         /** Current rect, clip rect (is default rect too). */
79         rctf curr, clipr;
80
81         /** Max 4 builtin curves per mapping struct now. */
82         CurveMap cm[4];
83         /** Black/white point (black[0] abused for current frame). */
84         float black[3], white[3];
85         /** Black/white point multiply value, for speed. */
86         float bwmul[3];
87
88         /** Sample values, if flag set it draws line and intersection. */
89         float sample[3];
90
91         short tone;
92         short pad[3];
93 } CurveMapping;
94
95 /* cumapping->flag */
96 #define CUMA_DO_CLIP            (1 << 0)
97 #define CUMA_PREMULLED          (1 << 1)
98 #define CUMA_DRAW_CFRA          (1 << 2)
99 #define CUMA_DRAW_SAMPLE        (1 << 3)
100
101 /* cumapping->preset */
102 typedef enum eCurveMappingPreset {
103         CURVE_PRESET_LINE   = 0,
104         CURVE_PRESET_SHARP  = 1,
105         CURVE_PRESET_SMOOTH = 2,
106         CURVE_PRESET_MAX    = 3,
107         CURVE_PRESET_MID9   = 4,
108         CURVE_PRESET_ROUND  = 5,
109         CURVE_PRESET_ROOT   = 6,
110         CURVE_PRESET_GAUSS  = 7,
111         CURVE_PRESET_BELL   = 8,
112 } eCurveMappingPreset;
113
114 /* CurveMapping->tone */
115 typedef enum eCurveMappingTone {
116         CURVE_TONE_STANDARD = 0,
117         CURVE_TONE_FILMLIKE = 2,
118 } eCurveMappingTone;
119
120 /* histogram->mode */
121 enum {
122         HISTO_MODE_LUMA   = 0,
123         HISTO_MODE_RGB    = 1,
124         HISTO_MODE_R      = 2,
125         HISTO_MODE_G      = 3,
126         HISTO_MODE_B      = 4,
127         HISTO_MODE_ALPHA  = 5,
128 };
129
130 enum {
131         HISTO_FLAG_LINE        = (1 << 0),
132         HISTO_FLAG_SAMPLELINE  = (1 << 1),
133 };
134
135 typedef struct Histogram {
136         int channels;
137         int x_resolution;
138         float data_luma[256];
139         float data_r[256];
140         float data_g[256];
141         float data_b[256];
142         float data_a[256];
143         float xmax, ymax;
144         short mode;
145         short flag;
146         int height;
147
148         /* sample line only */
149         /* image coords src -> dst */
150         float co[2][2];
151 } Histogram;
152
153
154 typedef struct Scopes {
155         int ok;
156         int sample_full;
157         int sample_lines;
158         float accuracy;
159         int wavefrm_mode;
160         float wavefrm_alpha;
161         float wavefrm_yfac;
162         int wavefrm_height;
163         float vecscope_alpha;
164         int vecscope_height;
165         float minmax[3][2];
166         struct Histogram hist;
167         float *waveform_1;
168         float *waveform_2;
169         float *waveform_3;
170         float *vecscope;
171         int waveform_tot;
172         int pad;
173 } Scopes;
174
175 /* scopes->wavefrm_mode */
176 #define SCOPES_WAVEFRM_LUMA             0
177 #define SCOPES_WAVEFRM_RGB_PARADE       1
178 #define SCOPES_WAVEFRM_YCC_601  2
179 #define SCOPES_WAVEFRM_YCC_709  3
180 #define SCOPES_WAVEFRM_YCC_JPEG 4
181 #define SCOPES_WAVEFRM_RGB              5
182
183 typedef struct ColorManagedViewSettings {
184         int flag, pad;
185         /** Look which is being applied when displaying buffer on the screen
186          * (prior to view transform). */
187         char look[64];
188         /** View transform which is being applied when displaying buffer on the screen. */
189         char view_transform[64];
190         /** Fstop exposure. */
191         float exposure;
192         /** Post-display gamma transform. */
193         float gamma;
194         /** Pre-display RGB curves transform. */
195         struct CurveMapping *curve_mapping;
196         void *pad2;
197 } ColorManagedViewSettings;
198
199 typedef struct ColorManagedDisplaySettings {
200         char display_device[64];
201 } ColorManagedDisplaySettings;
202
203 typedef struct ColorManagedColorspaceSettings {
204         /** MAX_COLORSPACE_NAME. */
205         char name[64];
206 } ColorManagedColorspaceSettings;
207
208 /* ColorManagedViewSettings->flag */
209 enum {
210         COLORMANAGE_VIEW_USE_CURVES = (1 << 0),
211 };
212
213 #endif