#include "BLI_span.hh"
#include "DNA_brush_enums.h"
#include "DNA_color_types.h"
#include "DNA_object_enums.h"

Functions
void	BKE_brush_system_init ()

void	BKE_brush_system_exit ()

Brush *	BKE_brush_add (Main bmain, const char name, eObjectMode ob_mode)

bool	BKE_brush_delete (Main bmain, Brush brush)

void	BKE_brush_init_gpencil_settings (Brush *brush)

void	BKE_brush_init_curves_sculpt_settings (Brush *brush)

void	BKE_brush_tag_unsaved_changes (Brush *brush)

Brush *	BKE_brush_first_search (Main *bmain, eObjectMode ob_mode)

void	BKE_brush_jitter_pos (const Scene &scene, const Brush &brush, const float pos[2], float jitterpos[2])

void	BKE_brush_randomize_texture_coords (UnifiedPaintSettings *ups, bool mask)

void	BKE_brush_curve_preset (Brush *b, enum eCurveMappingPreset preset)

void	BKE_brush_calc_curve_factors (eBrushCurvePreset preset, const CurveMapping *cumap, blender::Span< float > distances, float brush_radius, blender::MutableSpan< float > factors)

float	BKE_brush_curve_strength_clamped (const Brush *br, float p, float len)

float	BKE_brush_curve_strength (eBrushCurvePreset preset, const CurveMapping *cumap, float distance, float brush_radius)

float	BKE_brush_curve_strength (const Brush *br, float p, float len)

float	BKE_brush_sample_tex_3d (const Scene scene, const Brush br, const MTex mtex, const float point[3], float rgba[4], int thread, ImagePool pool)

float	BKE_brush_sample_masktex (const Scene scene, Brush br, const float point[2], int thread, ImagePool *pool)

const MTex *	BKE_brush_mask_texture_get (const Brush *brush, const eObjectMode object_mode)

const MTex *	BKE_brush_color_texture_get (const Brush *brush, const eObjectMode object_mode)

ImBuf *	BKE_brush_gen_radial_control_imbuf (Brush *br, bool secondary, bool display_gradient)

const float *	BKE_brush_color_get (const Scene scene, const Paint paint, const Brush *brush)

const float *	BKE_brush_secondary_color_get (const Scene scene, const Paint paint, const Brush *brush)

void	BKE_brush_color_set (Scene scene, const Paint paint, Brush *brush, const float color[3])

int	BKE_brush_size_get (const Scene scene, const Brush brush)

void	BKE_brush_size_set (Scene scene, Brush brush, int size)

float	BKE_brush_unprojected_radius_get (const Scene scene, const Brush brush)

void	BKE_brush_unprojected_radius_set (Scene scene, Brush brush, float unprojected_radius)

float	BKE_brush_alpha_get (const Scene scene, const Brush brush)

void	BKE_brush_alpha_set (Scene scene, Brush brush, float alpha)

float	BKE_brush_weight_get (const Scene scene, const Brush brush)

void	BKE_brush_weight_set (const Scene scene, Brush brush, float value)

int	BKE_brush_input_samples_get (const Scene scene, const Brush brush)

void	BKE_brush_input_samples_set (const Scene scene, Brush brush, int value)

bool	BKE_brush_use_locked_size (const Scene scene, const Brush brush)

bool	BKE_brush_use_alpha_pressure (const Brush *brush)

bool	BKE_brush_use_size_pressure (const Brush *brush)

bool	BKE_brush_sculpt_has_secondary_color (const Brush *brush)

void	BKE_brush_scale_unprojected_radius (float *unprojected_radius, int new_brush_size, int old_brush_size)

void	BKE_brush_scale_size (int *r_brush_size, float new_unprojected_radius, float old_unprojected_radius)

bool	BKE_brush_has_cube_tip (const Brush *brush, PaintMode paint_mode)

void	BKE_brush_debug_print_state (Brush *br)

Detailed Description

General operations for brushes.

Definition in file BKE_brush.hh.

Function Documentation

◆ BKE_brush_add()

Brush * BKE_brush_add	(	Main *	bmain,
		const char *	name,
		eObjectMode	ob_mode )

Note: Resulting brush will have two users: one as a fake user, another is assumed to be used by the caller.

Definition at line 542 of file brush.cc.

References BKE_brush_init_curves_sculpt_settings(), BKE_brush_init_gpencil_settings(), BKE_id_new(), ELEM, ID_BR, Brush::ob_mode, OB_MODE_PAINT_GREASE_PENCIL, OB_MODE_SCULPT_CURVES, OB_MODE_SCULPT_GREASE_PENCIL, OB_MODE_VERTEX_GREASE_PENCIL, and OB_MODE_WEIGHT_GREASE_PENCIL.

◆ BKE_brush_alpha_get()

float BKE_brush_alpha_get	(	const Scene *	scene,
		const Brush *	brush )

Definition at line 1153 of file brush.cc.

References Brush::alpha, UnifiedPaintSettings::alpha, UnifiedPaintSettings::flag, and UNIFIED_PAINT_ALPHA.

◆ BKE_brush_alpha_set()

void BKE_brush_alpha_set	(	Scene *	scene,
		Brush *	brush,
		float	alpha )

Definition at line 1140 of file brush.cc.

References Brush::alpha, UnifiedPaintSettings::alpha, BKE_brush_tag_unsaved_changes(), UnifiedPaintSettings::flag, and UNIFIED_PAINT_ALPHA.

Referenced by blender::ed::sculpt_paint::image::ops::paint::paint_stroke_update_step().

◆ BKE_brush_calc_curve_factors()

void BKE_brush_calc_curve_factors	(	eBrushCurvePreset	preset,
		const CurveMapping *	cumap,
		blender::Span< float >	distances,
		float	brush_radius,
		blender::MutableSpan< float >	factors )

Combine the brush strength based on the distances and brush settings with the existing factors.

Definition at line 1265 of file brush.cc.

References BKE_curvemapping_evaluateF(), BLI_assert, BRUSH_CURVE_CONSTANT, BRUSH_CURVE_CUSTOM, BRUSH_CURVE_INVSQUARE, BRUSH_CURVE_LIN, BRUSH_CURVE_POW4, BRUSH_CURVE_ROOT, BRUSH_CURVE_SHARP, BRUSH_CURVE_SMOOTH, BRUSH_CURVE_SMOOTHER, BRUSH_CURVE_SPHERE, blender::Span< T >::index_range(), pow3f(), blender::math::rcp(), blender::MutableSpan< T >::size(), blender::Span< T >::size(), and sqrtf.

Referenced by blender::ed::sculpt_paint::calc_brush_strength_factors(), blender::ed::sculpt_paint::sample_node_surface_bmesh(), blender::ed::sculpt_paint::sample_node_surface_grids(), and blender::ed::sculpt_paint::sample_node_surface_mesh().

◆ BKE_brush_color_get()

const float * BKE_brush_color_get	(	const Scene *	scene,
		const Paint *	paint,
		const Brush *	brush )

Definition at line 1029 of file brush.cc.

References BKE_paint_use_unified_color(), and Brush::rgb.

Referenced by blender::ed::sculpt_paint::expand::cache_initial_config_set(), blender::ed::sculpt_paint::color::do_paint_brush_task(), blender::ed::sculpt_paint::paint::image::do_paint_pixels(), blender::ed::sculpt_paint::grease_pencil_brush_cursor_draw(), blender::ed::greasepencil::grease_pencil_vertex_paint_set_exec(), blender::ed::sculpt_paint::greasepencil::TintOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::VertexPaintOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexReplaceOperation::on_stroke_extended(), paint_brush_color_get(), blender::ed::sculpt_paint::image::ops::paint::ImagePaintMode::paint_bucket_fill(), palette_color_add_exec(), sample_color_invoke(), and vpaint_get_current_col().

◆ BKE_brush_color_set()

void BKE_brush_color_set	(	Scene *	scene,
		const Paint *	paint,
		Brush *	brush,
		const float	color[3] )

Definition at line 1047 of file brush.cc.

References BKE_brush_tag_unsaved_changes(), BKE_paint_use_unified_color(), copy_v3_v3(), Brush::rgb, and UnifiedPaintSettings::rgb.

Referenced by paint_sample_color(), blender::ed::sculpt_paint::sample_color_invoke(), sample_color_modal(), and ui_do_but_COLOR().

◆ BKE_brush_color_texture_get()

const MTex * BKE_brush_color_texture_get	(	const Brush *	brush,
		const eObjectMode	object_mode )

Get the color texture for this given object mode.

This is preferred above using mtex/mask_mtex attributes directly as due to legacy these attributes got switched in sculpt mode.

Definition at line 770 of file brush.cc.

References Brush::mask_mtex, Brush::mtex, and OB_MODE_SCULPT.

Referenced by do_projectpaint_thread().

◆ BKE_brush_curve_preset()

void BKE_brush_curve_preset	(	Brush *	b,
		enum eCurveMappingPreset	preset )

Library Operations

Definition at line 744 of file brush.cc.

References b, BKE_brush_tag_unsaved_changes(), BKE_curvemap_reset(), BKE_curvemapping_add(), BKE_curvemapping_changed(), CurveMapping::clipr, CURVEMAP_SLOPE_NEGATIVE, CurveMapping::flag, and CurveMapping::preset.

Referenced by brush_blend_read_data(), brush_curve_preset_exec(), and brush_init_data().

◆ BKE_brush_curve_strength() [1/2]

float BKE_brush_curve_strength	(	const Brush *	br,
		float	p,
		float	len )

Definition at line 1439 of file brush.cc.

References BKE_brush_curve_strength(), Brush::curve, Brush::curve_preset, and len.

◆ BKE_brush_curve_strength() [2/2]

float BKE_brush_curve_strength	(	eBrushCurvePreset	preset,
		const CurveMapping *	cumap,
		float	distance,
		float	brush_radius )

Uses the brush curve control to find a strength value.

Definition at line 1388 of file brush.cc.

References BKE_curvemapping_evaluateF(), BRUSH_CURVE_CONSTANT, BRUSH_CURVE_CUSTOM, BRUSH_CURVE_INVSQUARE, BRUSH_CURVE_LIN, BRUSH_CURVE_POW4, BRUSH_CURVE_ROOT, BRUSH_CURVE_SHARP, BRUSH_CURVE_SMOOTH, BRUSH_CURVE_SMOOTHER, BRUSH_CURVE_SPHERE, distance(), pow3f(), and sqrtf.

◆ BKE_brush_curve_strength_clamped()

float BKE_brush_curve_strength_clamped	(	const Brush *	br,
		float	p,
		float	len )

Uses the brush curve control to find a strength value between 0 and 1.

Definition at line 1444 of file brush.cc.

References BKE_brush_curve_strength(), CLAMP, and len.

Referenced by BKE_brush_gen_radial_control_imbuf(), do_projectpaint_thread(), gradientVert_update(), blender::ed::sculpt_paint::load_tex_cursor_task_cb(), radial_control_paint_curve(), and blender::ed::sculpt_paint::update_sampled_curve().

◆ BKE_brush_debug_print_state()

void BKE_brush_debug_print_state ( Brush * br )

◆ BKE_brush_delete()

bool BKE_brush_delete	(	Main *	bmain,
		Brush *	brush )

Delete a Brush.

Definition at line 589 of file brush.cc.

References BKE_id_delete(), BKE_library_ID_is_indirectly_used(), Brush::id, ID_EXTRA_USERS, ID_REAL_USERS, ID_TAG_INDIRECT, and ID::tag.

◆ BKE_brush_first_search()

Brush * BKE_brush_first_search	(	Main *	bmain,
		eObjectMode	ob_mode )

Definition at line 628 of file brush.cc.

References Main::brushes, and LISTBASE_FOREACH.

◆ BKE_brush_gen_radial_control_imbuf()

ImBuf * BKE_brush_gen_radial_control_imbuf	(	Brush *	br,
		bool	secondary,
		bool	display_gradient )

Radial control.

Definition at line 1484 of file brush.cc.

References BKE_brush_curve_strength_clamped(), BKE_curvemapping_init(), brush_gen_texture(), Brush::curve, ImBufFloatBuffer::data, ImBuf::float_buffer, IB_DO_NOT_TAKE_OWNERSHIP, IMB_assign_float_buffer(), MEM_callocN, pow2f(), sqrtf, ImBuf::x, and ImBuf::y.

Referenced by radial_control_set_tex().

◆ BKE_brush_has_cube_tip()

bool BKE_brush_has_cube_tip	(	const Brush *	brush,
		PaintMode	paint_mode )

Definition at line 1514 of file brush.cc.

References ELEM, Sculpt, Brush::sculpt_brush_type, SCULPT_BRUSH_TYPE_CLAY_STRIPS, SCULPT_BRUSH_TYPE_MULTIPLANE_SCRAPE, SCULPT_BRUSH_TYPE_PAINT, Brush::tip_roundness, and Brush::tip_scale_x.

Referenced by blender::ed::sculpt_paint::do_brush_action(), paint_rake_rotation_active(), and blender::ed::sculpt_paint::sculpt_brush_needs_normal().

◆ BKE_brush_init_curves_sculpt_settings()

void BKE_brush_init_curves_sculpt_settings ( Brush * brush )

Definition at line 605 of file brush.cc.

References BKE_curvemapping_add(), BRUSH_CURVES_SCULPT_FLAG_INTERPOLATE_RADIUS, Brush::curves_sculpt_settings, and BrushCurvesSculptSettings::flag.

Referenced by BKE_brush_add().

◆ BKE_brush_init_gpencil_settings()

void BKE_brush_init_gpencil_settings ( Brush * brush )

Add grease pencil settings.

Definition at line 563 of file brush.cc.

Referenced by BKE_brush_add(), blender::ed::sculpt_paint::grease_pencil_fill_init(), blender::ed::greasepencil::grease_pencil_primitive_invoke(), blender::ed::sculpt_paint::greasepencil::init_brush(), blender::ed::sculpt_paint::greasepencil::EraseOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::PaintOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::TintOperation::on_stroke_begin(), blender::ed::greasepencil::paintmode_toggle_exec(), and blender::ed::greasepencil::stroke_trim_execute().

◆ BKE_brush_input_samples_get()

int BKE_brush_input_samples_get	(	const Scene *	scene,
		const Brush *	brush )

Definition at line 1180 of file brush.cc.

References UnifiedPaintSettings::flag, Brush::input_samples, UnifiedPaintSettings::input_samples, and UNIFIED_PAINT_INPUT_SAMPLES.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal().

◆ BKE_brush_input_samples_set()

void BKE_brush_input_samples_set	(	const Scene *	scene,
		Brush *	brush,
		int	value )

Definition at line 1187 of file brush.cc.

References BKE_brush_tag_unsaved_changes(), UnifiedPaintSettings::flag, Brush::input_samples, UnifiedPaintSettings::input_samples, and UNIFIED_PAINT_INPUT_SAMPLES.

◆ BKE_brush_jitter_pos()

void BKE_brush_jitter_pos	(	const Scene &	scene,
		const Brush &	brush,
		const float	pos[2],
		float	jitterpos[2] )

Definition at line 1224 of file brush.cc.

References BKE_brush_size_get(), BLI_rng_get_float(), BRUSH_ABSOLUTE_JITTER, brush_rng, Brush::flag, Brush::jitter, Brush::jitter_absolute, len_squared_v2(), pos, and square_f().

Referenced by blender::ed::sculpt_paint::paint_stroke_jitter_pos().

◆ BKE_brush_mask_texture_get()

const MTex * BKE_brush_mask_texture_get	(	const Brush *	brush,
		const eObjectMode	object_mode )

Get the mask texture for this given object mode.

This is preferred above using mtex/mask_mtex attributes directly as due to legacy these attributes got switched in sculpt mode.

Definition at line 762 of file brush.cc.

References Brush::mask_mtex, Brush::mtex, and OB_MODE_SCULPT.

◆ BKE_brush_randomize_texture_coords()

void BKE_brush_randomize_texture_coords	(	UnifiedPaintSettings *	ups,
		bool	mask )

Definition at line 1251 of file brush.cc.

References BLI_rng_get_float(), brush_rng, UnifiedPaintSettings::mask_tex_mouse, UnifiedPaintSettings::pixel_radius, and UnifiedPaintSettings::tex_mouse.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ BKE_brush_sample_masktex()

float BKE_brush_sample_masktex	(	const Scene *	scene,
		Brush *	br,
		const float	point[2],
		int	thread,
		ImagePool *	pool )

◆ BKE_brush_sample_tex_3d()

float BKE_brush_sample_tex_3d	(	const Scene *	scene,
		const Brush *	br,
		const MTex *	mtex,
		const float	point[3],
		float	rgba[4],
		int	thread,
		ImagePool *	pool )

Generic texture sampler for 3D painting systems. point has to be either in region space mouse coordinates, or 3d world coordinates for 3D mapping.

RGBA outputs straight alpha.

Definition at line 778 of file brush.cc.

References atan2f, MTex::brush_map_mode, UnifiedPaintSettings::brush_rotation, UnifiedPaintSettings::colorspace, cosf, UnifiedPaintSettings::do_linear_conversion, fabsf, IMB_colormanagement_colorspace_to_scene_linear_v3(), MTEX_MAP_MODE_3D, MTEX_MAP_MODE_RANDOM, MTEX_MAP_MODE_STENCIL, MTEX_MAP_MODE_TILED, MTEX_MAP_MODE_VIEW, UnifiedPaintSettings::pixel_radius, RE_texture_evaluate(), MTex::rot, sinf, sqrtf, UnifiedPaintSettings::start_pixel_radius, Brush::stencil_dimension, Brush::stencil_pos, MTex::tex, UnifiedPaintSettings::tex_mouse, Brush::texture_sample_bias, x, y, and zero_v4().

Referenced by brush_painter_imbuf_new(), brush_painter_imbuf_update(), do_projectpaint_thread(), blender::ed::sculpt_paint::expand::falloff_value_vertex_get(), paint_and_tex_color_alpha_intern(), and sculpt_apply_texture().

◆ BKE_brush_scale_size()

void BKE_brush_scale_size	(	int *	r_brush_size,
		float	new_unprojected_radius,
		float	old_unprojected_radius )

Scale brush size to reflect a change in the brush's unprojected radius.

Definition at line 1212 of file brush.cc.

References int.

◆ BKE_brush_scale_unprojected_radius()

void BKE_brush_scale_unprojected_radius	(	float *	unprojected_radius,
		int	new_brush_size,
		int	old_brush_size )

Scale unprojected radius to reflect a change in the brush's 2D size.

Definition at line 1200 of file brush.cc.

References float.

◆ BKE_brush_sculpt_has_secondary_color()

bool BKE_brush_sculpt_has_secondary_color ( const Brush * brush )

Definition at line 1101 of file brush.cc.

References ELEM, Brush::sculpt_brush_type, SCULPT_BRUSH_TYPE_BLOB, SCULPT_BRUSH_TYPE_CLAY, SCULPT_BRUSH_TYPE_CLAY_STRIPS, SCULPT_BRUSH_TYPE_CLAY_THUMB, SCULPT_BRUSH_TYPE_CREASE, SCULPT_BRUSH_TYPE_DRAW, SCULPT_BRUSH_TYPE_DRAW_SHARP, SCULPT_BRUSH_TYPE_FILL, SCULPT_BRUSH_TYPE_FLATTEN, SCULPT_BRUSH_TYPE_INFLATE, SCULPT_BRUSH_TYPE_LAYER, SCULPT_BRUSH_TYPE_MASK, SCULPT_BRUSH_TYPE_PINCH, and SCULPT_BRUSH_TYPE_SCRAPE.

Referenced by blender::ed::sculpt_paint::paint_cursor_context_init().

◆ BKE_brush_secondary_color_get()

const float * BKE_brush_secondary_color_get	(	const Scene *	scene,
		const Paint *	paint,
		const Brush *	brush )

Definition at line 1037 of file brush.cc.

References BKE_paint_use_unified_color(), and Brush::secondary_rgb.

Referenced by blender::ed::sculpt_paint::color::do_paint_brush_task(), blender::ed::sculpt_paint::paint::image::do_paint_pixels(), paint_brush_color_get(), blender::ed::sculpt_paint::image::ops::paint::ImagePaintMode::paint_bucket_fill(), and vpaint_get_current_col().

◆ BKE_brush_size_get()

int BKE_brush_size_get	(	const Scene *	scene,
		const Brush *	brush )

Definition at line 1075 of file brush.cc.

References UnifiedPaintSettings::flag, Brush::size, size(), UnifiedPaintSettings::size, and UNIFIED_PAINT_SIZE.

◆ BKE_brush_size_set()

void BKE_brush_size_set	(	Scene *	scene,
		Brush *	brush,
		int	size )

Definition at line 1059 of file brush.cc.

References BKE_brush_tag_unsaved_changes(), CLAMP, UnifiedPaintSettings::flag, MAX_BRUSH_PIXEL_RADIUS, Brush::size, size(), UnifiedPaintSettings::size, and UNIFIED_PAINT_SIZE.

Referenced by brush_scale_size_exec(), blender::ed::sculpt_paint::paint_cursor_sculpt_session_update_and_init(), paint_proj_new_stroke(), paint_proj_stroke_done(), blender::ed::sculpt_paint::smooth_brush_toggle_off(), blender::ed::sculpt_paint::vwpaint::smooth_brush_toggle_off(), blender::ed::sculpt_paint::smooth_brush_toggle_on(), blender::ed::sculpt_paint::vwpaint::smooth_brush_toggle_on(), and texture_paint_camera_project_exec().

◆ BKE_brush_system_exit()

void BKE_brush_system_exit ( )

Definition at line 476 of file brush.cc.

References BLI_rng_free(), and brush_rng.

Referenced by BKE_blender_free().

◆ BKE_brush_system_init()

void BKE_brush_system_init ( )

Definition at line 470 of file brush.cc.

References BLI_rng_new(), BLI_rng_srandom(), and brush_rng.

Referenced by main().

◆ BKE_brush_tag_unsaved_changes()

void BKE_brush_tag_unsaved_changes ( Brush * brush )

Tag a linked brush as having changed settings so an indicator can be displayed to the user, showing that the brush settings differ from the state of the imported brush asset. Call every time a user visible change to the brush is done.

Since this is meant to indicate brushes that are known to differ from the linked source file, tagging is only performed for linked brushes. File local brushes are normal data-blocks that get saved with the file, and don't need special attention by the user.

For convenience, null may be passed for brush.

Definition at line 621 of file brush.cc.

References Brush::has_unsaved_changes, and ID_IS_LINKED.

Referenced by BKE_brush_alpha_set(), BKE_brush_color_set(), BKE_brush_curve_preset(), BKE_brush_input_samples_set(), BKE_brush_size_set(), BKE_brush_unprojected_radius_set(), BKE_brush_weight_set(), BKE_gpencil_brush_material_set(), brush_colors_flip_exec(), brush_scale_size_exec(), brush_sculpt_curves_falloff_preset_exec(), calculateCenterActive(), ED_render_id_flush_update(), blender::ui::greasepencil::eyedropper_set_brush_color(), flushTransPaintCurve(), grab_clone_apply(), grab_clone_modal(), blender::ed::sculpt_paint::grease_pencil_apply_fill(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_modal(), paintcurve_delete_point_exec(), paintcurve_new_exec(), paintcurve_point_add(), paintcurve_slide_invoke(), set_current_brush_texture(), stencil_control_calculate(), stencil_fit_image_aspect_exec(), stencil_reset_transform_exec(), blender::ed::greasepencil::toggle_weight_tool_direction(), and ui_do_but_COLOR().