Blender V5.3
BKE_brush.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
12
13#include <optional>
14
16#include "BLI_span.hh"
17
18#include "DNA_brush_enums.h"
19#include "DNA_color_types.h"
20#include "DNA_object_enums.h"
21#include "DNA_userdef_enums.h"
22
23namespace blender {
24
25enum class PaintMode : int8_t;
26struct Brush;
27struct ImBuf;
28struct ImagePool;
29struct Main;
30struct MTex;
31struct Paint;
32struct Scene;
34
35/* Globals for brush execution. */
36
39
40/* Data-block functions. */
41
46Brush *BKE_brush_add(Main *bmain, const char *name, eObjectMode ob_mode);
50bool BKE_brush_delete(Main *bmain, Brush *brush);
51
71 Brush *brush,
72 eDupli_ID_Flags dupflag,
73 /*eLibIDDuplicateFlags*/ uint duplicate_options);
78
80
82
95
96float2 BKE_brush_jitter_pos(const Paint &paint, const Brush &brush, const float2 &pos);
98
99/* Brush curve. */
100
105
109
114 const CurveMapping *cumap,
115 Span<float> distances,
116 float brush_radius,
117 MutableSpan<float> factors);
121float BKE_brush_curve_strength_clamped(const Brush *br, float p, float len);
126 const CurveMapping *cumap,
127 float distance,
128 float brush_radius);
129float BKE_brush_curve_strength(const Brush *br, float p, float len);
130
131/* Sampling. */
132
141 const Brush *br,
142 const MTex *mtex,
143 const float3 &point,
144 float4 &rgba,
145 int thread,
146 ImagePool *pool);
148 const Paint *paint, Brush *br, const float2 &point, int thread, ImagePool *pool);
149
156const MTex *BKE_brush_mask_texture_get(const Brush *brush, PaintMode paint_mode);
157
164const MTex *BKE_brush_color_texture_get(const Brush *brush, PaintMode paint_mode);
165
169ImBuf *BKE_brush_gen_radial_control_imbuf(Brush *br, bool secondary, bool display_gradient);
170
171/* Unified strength size and color. */
172
176
189
191std::optional<BrushColorJitterSettings> BKE_brush_color_jitter_get_settings(const Paint *paint,
192 const Brush *brush);
195
198
199int BKE_brush_size_get(const Paint *paint, const Brush *brush);
200void BKE_brush_size_set(Paint *paint, Brush *brush, int size);
201float BKE_brush_radius_get(const Paint *paint, const Brush *brush);
202
204void BKE_brush_unprojected_size_set(Paint *paint, Brush *brush, float unprojected_size);
206
207float BKE_brush_alpha_get(const Paint *paint, const Brush *brush);
208void BKE_brush_alpha_set(Paint *paint, Brush *brush, float alpha);
209float BKE_brush_weight_get(const Paint *paint, const Brush *brush);
210void BKE_brush_weight_set(Paint *paint, Brush *brush, float value);
211
214
215bool BKE_brush_use_locked_size(const Paint *paint, const Brush *brush);
218
222void BKE_brush_scale_unprojected_size(float *unprojected_size,
223 int new_brush_size,
224 int old_brush_size);
225
229void BKE_brush_scale_size(int *r_brush_size,
230 float new_unprojected_size,
231 float old_unprojected_size);
232
233/* Returns true if a brush requires a cube
234 * (often presented to the user as a square) tip inside a specific paint mode.
235 */
236bool BKE_brush_has_cube_tip(const Brush *brush, PaintMode paint_mode);
237
238namespace bke::brush {
239float normal_weight_get(const Brush &brush, bool invert);
240}
241
242/* debugging only */
243void BKE_brush_debug_print_state(Brush *br);
244
245namespace bke::brush {
246bool implements_3d_texture_paint(const Brush &brush);
247}
248
249/* -------------------------------------------------------------------- */
254
255namespace bke::brush {
256bool supports_dyntopo(const Brush &brush);
257bool supports_accumulate(const Brush &brush);
258bool supports_topology_rake(const Brush &brush);
259bool supports_auto_smooth(const Brush &brush);
260bool supports_normal_radius(const Brush &brush);
261bool supports_tip_roundness(const Brush &brush);
262bool supports_hardness(const Brush &brush);
263bool supports_height(const Brush &brush);
264bool supports_plane_height(const Brush &brush);
265bool supports_plane_depth(const Brush &brush);
266bool supports_jitter(const Brush &brush);
267bool supports_normal_weight(const Brush &brush);
268bool supports_rake_factor(const Brush &brush);
269bool supports_persistence(const Brush &brush);
270bool supports_pinch_factor(const Brush &brush);
271bool supports_plane_offset(const Brush &brush);
272bool supports_random_texture_angle(const Brush &brush);
273bool supports_sculpt_plane(const Brush &brush);
274bool supports_color(const Brush &brush);
275bool supports_secondary_cursor_color(const Brush &brush);
276bool supports_smooth_stroke(const Brush &brush);
277bool supports_space_attenuation(const Brush &brush);
278bool supports_strength_pressure(const Brush &brush);
279bool supports_size_pressure(const Brush &brush);
280bool supports_auto_smooth_pressure(const Brush &brush);
281bool supports_hardness_pressure(const Brush &brush);
282bool supports_inverted_direction(const Brush &brush);
283bool supports_gravity(const Brush &brush);
284bool supports_tilt(const Brush &brush);
285} // namespace bke::brush
286
288
289} // namespace blender
float distance(float, float) RET
float2x2 invert(float2x2 mat)
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
bool supports_sculpt_plane(const Brush &brush)
Definition brush.cc:2014
bool supports_secondary_cursor_color(const Brush &brush)
Definition brush.cc:2028
bool supports_auto_smooth(const Brush &brush)
Definition brush.cc:1943
bool supports_jitter(const Brush &brush)
Definition brush.cc:1975
bool supports_space_attenuation(const Brush &brush)
Definition brush.cc:2052
bool supports_size_pressure(const Brush &brush)
Definition brush.cc:2061
bool supports_persistence(const Brush &brush)
Definition brush.cc:1991
bool supports_tilt(const Brush &brush)
Definition brush.cc:2103
bool supports_inverted_direction(const Brush &brush)
Definition brush.cc:2073
bool supports_hardness(const Brush &brush)
Definition brush.cc:1959
bool supports_auto_smooth_pressure(const Brush &brush)
Definition brush.cc:2065
bool supports_rake_factor(const Brush &brush)
Definition brush.cc:1987
bool supports_plane_depth(const Brush &brush)
Definition brush.cc:1971
bool supports_accumulate(const Brush &brush)
Definition brush.cc:1916
bool supports_gravity(const Brush &brush)
Definition brush.cc:2091
bool supports_hardness_pressure(const Brush &brush)
Definition brush.cc:2069
bool supports_smooth_stroke(const Brush &brush)
Definition brush.cc:2043
bool supports_plane_offset(const Brush &brush)
Definition brush.cc:2002
bool supports_pinch_factor(const Brush &brush)
Definition brush.cc:1995
float normal_weight_get(const Brush &brush, bool invert)
Definition brush.cc:1841
bool supports_normal_radius(const Brush &brush)
Definition brush.cc:1949
bool supports_color(const Brush &brush)
Definition brush.cc:2024
void common_pressure_curves_init(Brush &brush)
Definition brush.cc:1549
bool supports_random_texture_angle(const Brush &brush)
Definition brush.cc:2010
bool supports_strength_pressure(const Brush &brush)
Definition brush.cc:2057
bool supports_dyntopo(const Brush &brush)
Definition brush.cc:1893
bool supports_height(const Brush &brush)
Definition brush.cc:1963
bool supports_topology_rake(const Brush &brush)
Definition brush.cc:1932
bool implements_3d_texture_paint(const Brush &brush)
Definition brush.cc:1850
bool supports_plane_height(const Brush &brush)
Definition brush.cc:1967
bool supports_normal_weight(const Brush &brush)
Definition brush.cc:1980
bool supports_tip_roundness(const Brush &brush)
Definition brush.cc:1955
BMesh Iterators.
void BKE_brush_init_curves_sculpt_settings(Brush *brush)
Definition brush.cc:827
const MTex * BKE_brush_color_texture_get(const Brush *brush, PaintMode paint_mode)
Definition brush.cc:977
void BKE_brush_system_init()
Definition brush.cc:625
unsigned int uint
Definition BKE_text.h:55
float BKE_brush_sample_tex_3d(const Paint *paint, const Brush *br, const MTex *mtex, const float3 &point, float4 &rgba, int thread, ImagePool *pool)
Definition brush.cc:985
float BKE_brush_sample_masktex(const Paint *paint, Brush *br, const float2 &point, int thread, ImagePool *pool)
Definition brush.cc:1101
void BKE_brush_curve_preset(Brush *b, eCurveMappingPreset preset)
Definition brush.cc:951
float BKE_brush_radius_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1366
void BKE_brush_init_gpencil_settings(Brush *brush)
Definition brush.cc:719
Brush * BKE_brush_duplicate(Main *bmain, Brush *brush, eDupli_ID_Flags dupflag, uint duplicate_options)
Definition brush.cc:761
void BKE_brush_calc_curve_factors(eBrushCurvePreset preset, const CurveMapping *cumap, Span< float > distances, float brush_radius, MutableSpan< float > factors)
Definition brush.cc:1561
void BKE_brush_scale_size(int *r_brush_size, float new_unprojected_size, float old_unprojected_size)
Definition brush.cc:1429
ImBuf * BKE_brush_gen_radial_control_imbuf(Brush *br, bool secondary, bool display_gradient)
Definition brush.cc:1791
void BKE_brush_init_mesh_automasking_settings(Brush *brush)
Definition brush.cc:819
bool BKE_brush_delete(Main *bmain, Brush *brush)
Definition brush.cc:745
bool BKE_brush_use_alpha_pressure(const Brush *brush)
Definition brush.cc:1385
float BKE_brush_unprojected_radius_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1412
void BKE_brush_tag_unsaved_changes(Brush *brush)
Definition brush.cc:843
void BKE_brush_unprojected_size_set(Paint *paint, Brush *brush, float unprojected_size)
Definition brush.cc:1390
VecBase< float, 4 > float4
float2 BKE_brush_jitter_pos(const Paint &paint, const Brush &brush, const float2 &pos)
Definition brush.cc:1509
bool BKE_brush_use_unified_strength(const Paint *paint, const Brush *brush)
Definition brush.cc:1231
VecBase< float, 2 > float2
void BKE_brush_color_set(Paint *paint, Brush *brush, const float3 &color)
Definition brush.cc:1305
float BKE_brush_curve_strength(eBrushCurvePreset preset, const CurveMapping *cumap, float distance, float brush_radius)
Definition brush.cc:1691
int BKE_brush_size_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1356
bool BKE_brush_use_locked_size(const Paint *paint, const Brush *brush)
Definition brush.cc:1371
void BKE_brush_color_sync_legacy(Brush *brush)
Definition brush.cc:1319
void BKE_brush_size_set(Paint *paint, Brush *brush, int size)
Definition brush.cc:1340
const MTex * BKE_brush_mask_texture_get(const Brush *brush, PaintMode paint_mode)
Definition brush.cc:969
void BKE_brush_randomize_texture_coords(Paint *paint, bool mask)
Definition brush.cc:1533
void BKE_brush_scale_unprojected_size(float *unprojected_size, int new_brush_size, int old_brush_size)
Definition brush.cc:1417
bool BKE_brush_use_unified_size(const Paint *paint, const Brush *brush)
Definition brush.cc:1220
void BKE_brush_debug_print_state(Brush *br)
Definition brush.cc:850
bool BKE_brush_use_size_pressure(const Brush *brush)
Definition brush.cc:1380
float BKE_brush_curve_strength_clamped(const Brush *br, float p, float len)
Definition brush.cc:1751
void BKE_brush_system_exit()
Definition brush.cc:631
void BKE_brush_input_samples_set(Paint *paint, Brush *brush, int value)
Definition brush.cc:1494
bool BKE_brush_has_cube_tip(const Brush *brush, PaintMode paint_mode)
Definition brush.cc:1816
void BKE_brush_weight_set(Paint *paint, Brush *brush, float value)
Definition brush.cc:1472
float BKE_brush_unprojected_size_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1403
std::optional< BrushColorJitterSettings > BKE_brush_color_jitter_get_settings(const Paint *paint, const Brush *brush)
Definition brush.cc:1262
float3 BKE_brush_color_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1253
float BKE_brush_weight_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1464
VecBase< float, 3 > float3
void BKE_brush_alpha_set(Paint *paint, Brush *brush, float alpha)
Definition brush.cc:1441
Brush * BKE_brush_add(Main *bmain, const char *name, eObjectMode ob_mode)
Definition brush.cc:695
float BKE_brush_alpha_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1454
signed char int8_t
Definition BKE_text.h:76
bool BKE_brush_use_unified_color(const Paint *paint, const Brush *brush)
Definition brush.cc:1242
float3 BKE_brush_secondary_color_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1297
int BKE_brush_input_samples_get(const Paint *paint, const Brush *brush)
Definition brush.cc:1485