Physically based defaults for Eevee Bloom and Shutter
[blender.git] / source / blender / blenkernel / BKE_brush.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BKE_BRUSH_H__
22 #define __BKE_BRUSH_H__
23
24 /** \file BKE_brush.h
25  *  \ingroup bke
26  *
27  * General operations for brushes.
28  */
29
30 enum eCurveMappingPreset;
31 struct bContext;
32 struct Brush;
33 struct Paint;
34 struct ImBuf;
35 struct ImagePool;
36 struct Main;
37 struct Scene;
38 struct ToolSettings;
39 struct UnifiedPaintSettings;
40 struct Material;
41
42 // enum eCurveMappingPreset;
43
44 #include "DNA_object_enums.h"
45
46 /* globals for brush execution */
47 void BKE_brush_system_init(void);
48 void BKE_brush_system_exit(void);
49
50 /* datablock functions */
51 void BKE_brush_init(struct Brush *brush);
52 struct Brush *BKE_brush_add(struct Main *bmain, const char *name, const eObjectMode ob_mode);
53 struct Brush *BKE_brush_add_gpencil(struct Main *bmain, struct ToolSettings *ts, const char *name);
54 void BKE_brush_init_gpencil_settings(struct Brush *brush);
55 struct Brush *BKE_brush_first_search(struct Main *bmain, const eObjectMode ob_mode);
56 void BKE_brush_copy_data(struct Main *bmain, struct Brush *brush_dst, const struct Brush *brush_src, const int flag);
57 struct Brush *BKE_brush_copy(struct Main *bmain, const struct Brush *brush);
58 void BKE_brush_make_local(struct Main *bmain, struct Brush *brush, const bool lib_local);
59 void BKE_brush_free(struct Brush *brush);
60
61 void BKE_brush_sculpt_reset(struct Brush *brush);
62 void BKE_brush_gpencil_presets(struct bContext *C);
63 void BKE_brush_update_material(struct Main *bmain, struct Material *ma, struct Brush *exclude_brush);
64
65 /* image icon function */
66 struct ImBuf *get_brush_icon(struct Brush *brush);
67
68 /* jitter */
69 void BKE_brush_jitter_pos(
70         const struct Scene *scene, struct Brush *brush,
71         const float pos[2], float jitterpos[2]);
72 void BKE_brush_randomize_texture_coords(struct UnifiedPaintSettings *ups, bool mask);
73
74 /* brush curve */
75 void BKE_brush_curve_preset(struct Brush *b, enum eCurveMappingPreset preset);
76 float BKE_brush_curve_strength_clamped(struct Brush *br, float p, const float len);
77 float BKE_brush_curve_strength(const struct Brush *br, float p, const float len);
78
79 /* sampling */
80 float BKE_brush_sample_tex_3d(
81         const struct Scene *scene, const struct Brush *br, const float point[3],
82         float rgba[4], const int thread, struct ImagePool *pool);
83 float BKE_brush_sample_masktex(
84         const struct Scene *scene, struct Brush *br, const float point[2],
85         const int thread, struct ImagePool *pool);
86
87 /* texture */
88 unsigned int *BKE_brush_gen_texture_cache(struct Brush *br, int half_side, bool use_secondary);
89
90 /* radial control */
91 struct ImBuf *BKE_brush_gen_radial_control_imbuf(struct Brush *br, bool secondary);
92
93 /* unified strength size and color */
94
95 const float *BKE_brush_color_get(const struct Scene *scene, const struct Brush *brush);
96 const float *BKE_brush_secondary_color_get(const struct Scene *scene, const struct Brush *brush);
97 void BKE_brush_color_set(struct Scene *scene, struct Brush *brush, const float color[3]);
98
99 int  BKE_brush_size_get(const struct Scene *scene, const struct Brush *brush);
100 void BKE_brush_size_set(struct Scene *scene, struct Brush *brush, int value);
101
102 float BKE_brush_unprojected_radius_get(const struct Scene *scene, const struct Brush *brush);
103 void  BKE_brush_unprojected_radius_set(struct Scene *scene, struct Brush *brush, float value);
104
105 float BKE_brush_alpha_get(const struct Scene *scene, const struct Brush *brush);
106 void BKE_brush_alpha_set(struct Scene *scene, struct Brush *brush, float alpha);
107 float BKE_brush_weight_get(const struct Scene *scene, const struct Brush *brush);
108 void BKE_brush_weight_set(const struct Scene *scene, struct Brush *brush, float value);
109
110 bool BKE_brush_use_locked_size(const struct Scene *scene, const struct Brush *brush);
111 bool BKE_brush_use_alpha_pressure(const struct Scene *scene, const struct Brush *brush);
112 bool BKE_brush_use_size_pressure(const struct Scene *scene, const struct Brush *brush);
113
114 bool BKE_brush_sculpt_has_secondary_color(const struct Brush *brush);
115
116 /* scale unprojected radius to reflect a change in the brush's 2D size */
117 void BKE_brush_scale_unprojected_radius(
118         float *unprojected_radius,
119         int new_brush_size,
120         int old_brush_size);
121
122 /* scale brush size to reflect a change in the brush's unprojected radius */
123 void BKE_brush_scale_size(
124         int *r_brush_size,
125         float new_unprojected_radius,
126         float old_unprojected_radius);
127
128 /* Accessors */
129 #define BKE_brush_tool_get(brush, p) \
130         (CHECK_TYPE_ANY(brush, struct Brush *, const struct Brush *), \
131          *(const char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset))
132 #define BKE_brush_tool_set(brush, p, tool) { \
133         CHECK_TYPE_ANY(brush, struct Brush *); \
134         *(char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset) = tool; } ((void)0)
135
136 /* debugging only */
137 void BKE_brush_debug_print_state(struct Brush *br);
138
139 #endif