Audaspace Py API documentation fixes.
[blender.git] / source / blender / blenkernel / BKE_brush.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * General operations for brushes.
29  */
30
31 #ifndef BKE_BRUSH_H
32 #define BKE_BRUSH_H
33
34 struct ID;
35 struct Brush;
36 struct ImBuf;
37 struct Scene;
38 struct wmOperator;
39 enum CurveMappingPreset;
40
41 /* datablock functions */
42 struct Brush *add_brush(const char *name);
43 struct Brush *copy_brush(struct Brush *brush);
44 void make_local_brush(struct Brush *brush);
45 void free_brush(struct Brush *brush);
46
47 /* image icon function */
48 struct ImBuf *get_brush_icon(struct Brush *brush);
49
50 /* brush library operations used by different paint panels */
51 int brush_set_nr(struct Brush **current_brush, int nr, const char *name);
52 int brush_delete(struct Brush **current_brush);
53 void brush_check_exists(struct Brush **brush, const char *name);
54 void brush_toggled_fake_user(struct Brush *brush);
55 int brush_texture_set_nr(struct Brush *brush, int nr);
56 int brush_texture_delete(struct Brush *brush);
57 int brush_clone_image_set_nr(struct Brush *brush, int nr);
58 int brush_clone_image_delete(struct Brush *brush);
59
60 /* brush curve */
61 void brush_curve_preset(struct Brush *b, /*enum CurveMappingPreset*/int preset);
62 float brush_curve_strength_clamp(struct Brush *br, float p, const float len);
63 float brush_curve_strength(struct Brush *br, float p, const float len); /* used for sculpt */
64
65 /* sampling */
66 void brush_sample_tex(struct Brush *brush, float *xy, float *rgba);
67 void brush_imbuf_new(struct Brush *brush, short flt, short texfalloff, int size,
68         struct ImBuf **imbuf);
69
70 /* painting */
71 struct BrushPainter;
72 typedef struct BrushPainter BrushPainter;
73 typedef int (*BrushFunc)(void *user, struct ImBuf *ibuf, float *lastpos, float *pos);
74
75 BrushPainter *brush_painter_new(struct Brush *brush);
76 void brush_painter_require_imbuf(BrushPainter *painter, short flt,
77         short texonly, int size);
78 int brush_painter_paint(BrushPainter *painter, BrushFunc func, float *pos,
79         double time, float pressure, void *user);
80 void brush_painter_break_stroke(BrushPainter *painter);
81 void brush_painter_free(BrushPainter *painter);
82
83 /* texture */
84 unsigned int *brush_gen_texture_cache(struct Brush *br, int half_side);
85
86 /* radial control */
87 void brush_radial_control_invoke(struct wmOperator *op, struct Brush *br, float size_weight);
88 int brush_radial_control_exec(struct wmOperator *op, struct Brush *br, float size_weight);
89
90 /* unified strength and size */
91 int sculpt_get_brush_size(struct Brush *brush);
92 void sculpt_set_brush_size(struct Brush *brush, int size);
93 int sculpt_get_lock_brush_size(struct Brush *brush);
94 float sculpt_get_brush_unprojected_radius(struct Brush *brush);
95 void sculpt_set_brush_unprojected_radius(struct Brush *brush, float unprojected_radius);
96 float sculpt_get_brush_alpha(struct Brush *brush);
97 void sculpt_set_brush_alpha(struct Brush *brush, float alpha);
98
99
100 #endif
101