Cleanup: manually remove header text not handled by automation
[blender.git] / source / blender / blenkernel / BKE_colortools.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 #ifndef __BKE_COLORTOOLS_H__
20 #define __BKE_COLORTOOLS_H__
21
22 /** \file BKE_colortools.h
23  *  \ingroup bke
24  */
25
26 struct ColorManagedColorspaceSettings;
27 struct ColorManagedDisplaySettings;
28 struct ColorManagedViewSettings;
29 struct CurveMap;
30 struct CurveMapPoint;
31 struct CurveMapping;
32 struct Histogram;
33 struct ImBuf;
34 struct Scopes;
35 struct rctf;
36
37 void                curvemapping_set_defaults(struct CurveMapping *cumap, int tot, float minx, float miny, float maxx, float maxy);
38 struct CurveMapping *curvemapping_add(int tot, float minx, float miny, float maxx, float maxy);
39 void                curvemapping_free_data(struct CurveMapping *cumap);
40 void                curvemapping_free(struct CurveMapping *cumap);
41 void                curvemapping_copy_data(struct CurveMapping *target, const struct CurveMapping *cumap);
42 struct CurveMapping *curvemapping_copy(const struct CurveMapping *cumap);
43 void                curvemapping_set_black_white_ex(const float black[3], const float white[3], float r_bwmul[3]);
44 void                curvemapping_set_black_white(struct CurveMapping *cumap, const float black[3], const float white[3]);
45
46 enum {
47         CURVEMAP_SLOPE_NEGATIVE   = 0,
48         CURVEMAP_SLOPE_POSITIVE   = 1,
49         CURVEMAP_SLOPE_POS_NEG    = 2,
50 };
51
52 void                    curvemap_reset(struct CurveMap *cuma, const struct rctf *clipr, int preset, int slope);
53 void                    curvemap_remove(struct CurveMap *cuma, const short flag);
54 bool                    curvemap_remove_point(struct CurveMap *cuma, struct CurveMapPoint *cmp);
55 struct CurveMapPoint   *curvemap_insert(struct CurveMap *cuma, float x, float y);
56 void                    curvemap_handle_set(struct CurveMap *cuma, int type);
57
58 void                curvemapping_changed(struct CurveMapping *cumap, const bool rem_doubles);
59 void                curvemapping_changed_all(struct CurveMapping *cumap);
60
61 /* call before _all_ evaluation functions */
62 void                curvemapping_initialize(struct CurveMapping *cumap);
63
64 /* keep these (const CurveMap) - to help with thread safety */
65 /* single curve, no table check */
66 float               curvemap_evaluateF(const struct CurveMap *cuma, float value);
67 /* single curve, with table check */
68 float               curvemapping_evaluateF(const struct CurveMapping *cumap, int cur, float value);
69 void                curvemapping_evaluate3F(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
70 void                curvemapping_evaluateRGBF(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
71 void                curvemapping_evaluate_premulRGB(const struct CurveMapping *cumap, unsigned char vecout_byte[3], const unsigned char vecin_byte[3]);
72 void                curvemapping_evaluate_premulRGBF_ex(const struct CurveMapping *cumap, float vecout[3], const float vecin[3],
73                                                         const float black[3], const float bwmul[3]);
74 void                curvemapping_evaluate_premulRGBF(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
75 int                 curvemapping_RGBA_does_something(const struct CurveMapping *cumap);
76 void                curvemapping_table_RGBA(const struct CurveMapping *cumap, float **array, int *size);
77
78 /* non-const, these modify the curve */
79 void                curvemapping_premultiply(struct CurveMapping *cumap, int restore);
80
81
82 void                BKE_histogram_update_sample_line(struct Histogram *hist, struct ImBuf *ibuf,
83                                                      const struct ColorManagedViewSettings *view_settings,
84                                                      const struct ColorManagedDisplaySettings *display_settings);
85 void                scopes_update(struct Scopes *scopes, struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
86                                   const struct ColorManagedDisplaySettings *display_settings);
87 void                scopes_free(struct Scopes *scopes);
88 void                scopes_new(struct Scopes *scopes);
89
90 void BKE_color_managed_display_settings_init(
91         struct ColorManagedDisplaySettings *settings);
92 void BKE_color_managed_display_settings_copy(
93         struct ColorManagedDisplaySettings *new_settings,
94         const struct ColorManagedDisplaySettings *settings);
95
96 /* Initialize view settings to be best suitable for render type of viewing.
97  * This will use default view transform from the OCIO configuration. */
98 void BKE_color_managed_view_settings_init_render(
99         struct ColorManagedViewSettings *settings,
100         const struct ColorManagedDisplaySettings *display_settings);
101
102 /* Initialize view settings which are best suitable for viewing non-render
103  * images. For example,s movie clips while tracking. */
104 void BKE_color_managed_view_settings_init_default(
105         struct ColorManagedViewSettings *settings,
106         const struct ColorManagedDisplaySettings *display_settings);
107
108 void BKE_color_managed_view_settings_copy(
109         struct ColorManagedViewSettings *new_settings,
110         const struct ColorManagedViewSettings *settings);
111 void BKE_color_managed_view_settings_free(struct ColorManagedViewSettings *settings);
112
113 void BKE_color_managed_colorspace_settings_init(
114         struct ColorManagedColorspaceSettings *colorspace_settings);
115 void BKE_color_managed_colorspace_settings_copy(
116         struct ColorManagedColorspaceSettings *colorspace_settings,
117         const struct ColorManagedColorspaceSettings *settings);
118 bool BKE_color_managed_colorspace_settings_equals(
119         const struct ColorManagedColorspaceSettings *settings1,
120         const struct ColorManagedColorspaceSettings *settings2);
121 #endif