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