Blender V5.3
DNA_brush_enums.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_enum_flags.hh"
12
13namespace blender {
14
15/* BrushGpencilSettings->flag */
16enum eGPDbrush_Flag : int {
17 /* brush use pressure */
19 /* brush use pressure for alpha factor */
21 /* brush use pressure for alpha factor */
23 /* Disable automatic zoom for filling. */
25 /* Show extend fill help lines. */
27 /* fill hide transparent */
29 /* show fill help lines */
31 /* lazy mouse */
33 /* lazy mouse override (internal only) */
35 /* deprecated, was default eraser brush for quick switch */
36 GP_BRUSH_UNUSED_1 = (1 << 10),
37 /* settings group */
39 /* Random settings group */
41 /* Keep material assigned to brush */
43 /* Do not show fill color while drawing (no lasso mode) */
45 /* Do not erase strokes occluded. */
47 /* Post process trim stroke */
49 /* Post process convert to outline stroke */
51 /* Collide with stroke. */
53 /* Keep the caps as they are when erasing. Otherwise flatten the caps. */
55 /* Affect only the drawing in the active layer.
56 * Otherwise affect all editable drawings in the object. */
58 /* Automatically remove fill guides created with fill tool. */
60 /* Fill Tool create internal gaps. */
62 /* Create a cyclic stroke. */
64};
66
67enum eGPDbrush_Flag2 : int {
68 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_HUE_AT_STROKE */
69 /* Brush use random Hue at stroke level */
71 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_SAT_AT_STROKE */
72 /* Brush use random Saturation at stroke level */
74 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_VAL_AT_STROKE */
75 /* Brush use random Value at stroke level */
77 /* Brush use random Pressure at stroke level */
79 /* Brush use random Strength at stroke level */
81 /* Brush use random UV at stroke level */
83 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_HUE_RAND_PRESS */
84 /* Brush use Hue random pressure */
86 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_SAT_RAND_PRESS */
87 /* Brush use Saturation random pressure */
89 /* DEPRECATED: replaced with BRUSH_COLOR_JITTER_USE_VAL_RAND_PRESS */
90 /* Brush use Value random pressure */
92 /* Brush use Pressure random pressure */
94 /* Brush use Strength random pressure */
96 /* Brush use UV random pressure */
98 /* Brush creates curves that use the stroke. */
100 /* Brush creates curves that use the fill. */
101 GP_BRUSH_USE_FILL = (1 << 13),
102};
104
105/* BrushGpencilSettings->fill_draw_mode */
111
112/* BrushGpencilSettings->fill_extend_mode */
117
118/* BrushGpencilSettings->fill_layer_mode */
127
128/* BrushGpencilSettings->fill_solver */
133
134/* BrushGpencilSettings->gp_eraser_mode */
140
141/* BrushGpencilSettings->brush_draw_mode */
147
148/* Brush.curve_preset */
170
175
183
194
199
204
210
216
222
228
234
243
250
255
260
265
267enum eGp_Vertex_Mode : int {
268 /* Affect to Stroke only. */
270 /* Affect to Fill only. */
272 /* Affect to both. */
274};
275
276/* sculpt_flag */
277enum eGP_Sculpt_Flag : int {
278 /* invert the effect of the brush */
280 /* temporary invert action */
282};
284
285/* sculpt_mode_flag */
287 /* apply brush to position */
289 /* apply brush to strength */
291 /* apply brush to thickness */
293 /* apply brush to uv data */
295};
297
304
305 /* NOTE: normal and inverted are mutually exclusive,
306 * inverted has priority if both bits are set. */
308 BRUSH_AUTOMASKING_CAVITY_ALL = (1 << 4) | (1 << 5),
310 /* (1 << 7) - unused. */
314};
316
318 /* DEPRECATED: see BRUSH_HARDNESS_PRESSURE */
320 /* DEPRECATED: replaced by pressure curves. */
330};
332
333
335 BRUSH_GRADIENT_PRESSURE = 0, /* gradient from pressure */
336 BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
337 BRUSH_GRADIENT_SPACING_CLAMP = 2, /* gradient from spacing */
338};
339
341 BRUSH_GRADIENT_LINEAR = 0, /* gradient from pressure */
342 BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
343};
344
355
366 BRUSH_UNUSED_2 = (1 << 8),
367 BRUSH_DIR_IN = (1 << 9),
368 BRUSH_UNUSED_3 = (1 << 10),
370 BRUSH_PERSISTENT = (1 << 12),
371 BRUSH_ACCUMULATE = (1 << 13),
372 BRUSH_LOCK_ALPHA = (1 << 14),
376 BRUSH_SPACE_ATTEN = (1 << 18),
378 BRUSH_LOCK_SIZE = (1 << 20),
381 BRUSH_UNUSED_4 = (1 << 23),
383 /* Deprecated. To be removed in 6.0 - @Sean-Kim */
384 BRUSH_UNUSED_7 = (1 << 25),
385 BRUSH_PLANE_TRIM = (1 << 26),
386 BRUSH_FRONTFACE = (1 << 27),
387 BRUSH_UNUSED_8 = (1 << 28),
388 BRUSH_UNUSED_5 = (1 << 29),
390 BRUSH_UNUSED_6 = (1u << 31),
391};
393
394
399
400
416
417
426
432
433
443
444#define BRUSH_OVERLAY_OVERRIDE_MASK \
445 (BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
446 BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
447
490
491/* Brush.curves_sculpt_brush_type. */
506
516
517/* The enums here should be kept in sync with the weight paint brush type.
518 * This is because #smooth_brush_toggle_on and #smooth_brush_toggle_off
519 * assumes that the blur brush has the same enum value. */
527
528/* See #eBrushVertexPaintType when changing this definition. */
536
544
554
567
575
576/* direction that the brush displaces along */
584
589
590/* blur kernel types, Brush.blur_mode */
595
601
611
617
627
628#define MAX_BRUSH_PIXEL_RADIUS 500
629#define MAX_BRUSH_PIXEL_DIAMETER 1000
630
631} // namespace blender
#define ENUM_OPERATORS(_enum_type)
BMesh Iterators.
@ BRUSH_CURVE_INVSQUARE
@ BRUSH_BOUNDARY_DEFORM_GRAB
@ BRUSH_BOUNDARY_DEFORM_SMOOTH
@ BRUSH_BOUNDARY_DEFORM_TWIST
@ BRUSH_BOUNDARY_DEFORM_EXPAND
@ BRUSH_BOUNDARY_DEFORM_BEND
@ BRUSH_BOUNDARY_DEFORM_INFLATE
@ BRUSH_GRADIENT_RADIAL
@ BRUSH_GRADIENT_LINEAR
@ GP_SCULPT_FLAG_TMP_INVERT
@ GP_SCULPT_FLAG_INVERT
@ GP_BRUSH_MODE_VERTEXCOLOR
@ GP_BRUSH_MODE_MATERIAL
@ GPWEIGHT_BRUSH_TYPE_SMEAR
@ GPWEIGHT_BRUSH_TYPE_DRAW
@ GPWEIGHT_BRUSH_TYPE_BLUR
@ GPWEIGHT_BRUSH_TYPE_AVERAGE
@ BRUSH_STROKE_DRAG_DOT
@ BRUSH_STROKE_ANCHORED
@ BRUSH_STROKE_AIRBRUSH
@ BRUSH_GRADIENT_SPACING_CLAMP
@ BRUSH_GRADIENT_SPACING_REPEAT
@ BRUSH_GRADIENT_PRESSURE
@ BRUSH_SNAKE_HOOK_DEFORM_ELASTIC
@ BRUSH_SNAKE_HOOK_DEFORM_FALLOFF
@ BRUSH_SLIDE_DEFORM_EXPAND
@ BRUSH_SLIDE_DEFORM_DRAG
@ BRUSH_SLIDE_DEFORM_PINCH
eBrushColorJitterSettings_Flag
@ BRUSH_COLOR_JITTER_USE_SAT_RAND_PRESS
@ BRUSH_COLOR_JITTER_USE_HUE_AT_STROKE
@ BRUSH_COLOR_JITTER_USE_VAL_AT_STROKE
@ BRUSH_COLOR_JITTER_USE_HUE_RAND_PRESS
@ BRUSH_COLOR_JITTER_USE_SAT_AT_STROKE
@ BRUSH_COLOR_JITTER_USE_VAL_RAND_PRESS
@ PAINT_FALLOFF_SHAPE_SPHERE
@ PAINT_FALLOFF_SHAPE_TUBE
@ GP_FILL_DMODE_CONTROL
@ WPAINT_BRUSH_TYPE_AVERAGE
@ WPAINT_BRUSH_TYPE_SMEAR
@ WPAINT_BRUSH_TYPE_DRAW
@ WPAINT_BRUSH_TYPE_BLUR
@ BRUSH_PLANE_INVERT_DISPLACEMENT
@ BRUSH_PLANE_SWAP_HEIGHT_AND_DEPTH
@ BRUSH_MULTIPLANE_SCRAPE_PLANES_PREVIEW
@ BRUSH_GRAB_SILHOUETTE
@ BRUSH_POSE_IK_ANCHORED
@ BRUSH_MULTIPLANE_SCRAPE_DYNAMIC
@ BRUSH_USE_COLOR_AS_DISPLACEMENT
@ BRUSH_PROJECT_USE_BIDIRECTIONAL
@ BRUSH_USE_CONNECTED_ONLY
@ BRUSH_CLOTH_USE_COLLISION
@ BRUSH_POSE_USE_LOCK_ROTATION
@ BRUSH_AREA_RADIUS_PRESSURE
@ BRUSH_CLOTH_PIN_SIMULATION_BOUNDARY
@ BRUSH_SMOOTH_DEFORM_LAPLACIAN
@ BRUSH_SMOOTH_DEFORM_SURFACE
@ GP_FILL_SOLVER_DELAUNAY
@ BRUSH_BOUNDARY_FALLOFF_LOOP
@ BRUSH_BOUNDARY_FALLOFF_CONSTANT
@ BRUSH_BOUNDARY_FALLOFF_RADIUS
@ BRUSH_BOUNDARY_FALLOFF_LOOP_INVERT
@ BRUSH_CLOTH_DEFORM_PUSH
@ BRUSH_CLOTH_DEFORM_EXPAND
@ BRUSH_CLOTH_DEFORM_INFLATE
@ BRUSH_CLOTH_DEFORM_SNAKE_HOOK
@ BRUSH_CLOTH_DEFORM_DRAG
@ BRUSH_CLOTH_DEFORM_GRAB
@ BRUSH_CLOTH_DEFORM_PINCH_POINT
@ BRUSH_CLOTH_DEFORM_PINCH_PERPENDICULAR
@ BRUSH_CURVES_SCULPT_FLAG_SCALE_UNIFORM
@ BRUSH_CURVES_SCULPT_FLAG_INTERPOLATE_RADIUS
@ BRUSH_CURVES_SCULPT_FLAG_INTERPOLATE_LENGTH
@ BRUSH_CURVES_SCULPT_FLAG_INTERPOLATE_POINT_COUNT
@ BRUSH_CURVES_SCULPT_FLAG_INTERPOLATE_SHAPE
@ BRUSH_CURVES_SCULPT_FLAG_GROW_SHRINK_INVERT
@ SCULPT_BRUSH_TYPE_INFLATE
@ SCULPT_BRUSH_TYPE_SMEAR
@ SCULPT_BRUSH_TYPE_CLOTH
@ SCULPT_BRUSH_TYPE_SIMPLIFY
@ SCULPT_BRUSH_TYPE_SMOOTH
@ SCULPT_BRUSH_TYPE_CLAY_STRIPS
@ SCULPT_BRUSH_TYPE_CREASE
@ SCULPT_BRUSH_TYPE_DRAW_FACE_SETS
@ SCULPT_BRUSH_TYPE_GRAB
@ SCULPT_BRUSH_TYPE_BLUR
@ SCULPT_BRUSH_TYPE_PAINT
@ SCULPT_BRUSH_TYPE_BLOB
@ SCULPT_BRUSH_TYPE_PLANE
@ SCULPT_BRUSH_TYPE_SLIDE_RELAX
@ SCULPT_BRUSH_TYPE_PINCH
@ SCULPT_BRUSH_TYPE_POSE
@ SCULPT_BRUSH_TYPE_ROTATE
@ SCULPT_BRUSH_TYPE_LAYER
@ SCULPT_BRUSH_TYPE_DISPLACEMENT_ERASER
@ SCULPT_BRUSH_TYPE_BOUNDARY
@ SCULPT_BRUSH_TYPE_MASK
@ SCULPT_BRUSH_TYPE_DISPLACEMENT_SMEAR
@ SCULPT_BRUSH_TYPE_DRAW_SHARP
@ SCULPT_BRUSH_TYPE_SNAKE_HOOK
@ SCULPT_BRUSH_TYPE_CLAY
@ SCULPT_BRUSH_TYPE_CLAY_THUMB
@ SCULPT_BRUSH_TYPE_MULTIPLANE_SCRAPE
@ SCULPT_BRUSH_TYPE_SCENE_PROJECT
@ SCULPT_BRUSH_TYPE_THUMB
@ SCULPT_BRUSH_TYPE_NUDGE
@ SCULPT_BRUSH_TYPE_ELASTIC_DEFORM
@ SCULPT_BRUSH_TYPE_DRAW
@ BRUSH_MASK_PRESSURE_CUTOFF
@ BRUSH_MASK_PRESSURE_RAMP
@ GPSCULPT_BRUSH_TYPE_CLONE
@ GPSCULPT_BRUSH_TYPE_PINCH
@ GPSCULPT_BRUSH_TYPE_PUSH
@ GPSCULPT_BRUSH_TYPE_THICKNESS
@ GPSCULPT_BRUSH_TYPE_RANDOMIZE
@ GPSCULPT_BRUSH_TYPE_GRAB
@ GPSCULPT_BRUSH_TYPE_STRENGTH
@ GPSCULPT_BRUSH_TYPE_SMOOTH
@ GPSCULPT_BRUSH_TYPE_TWIST
@ BRUSH_POSE_DEFORM_SQUASH_STRETCH
@ BRUSH_POSE_DEFORM_SCALE_TRANSLATE
@ BRUSH_POSE_DEFORM_ROTATE_TWIST
@ BRUSH_POSE_ORIGIN_TOPOLOGY
@ BRUSH_POSE_ORIGIN_FACE_SETS_FK
@ BRUSH_POSE_ORIGIN_FACE_SETS
@ BRUSH_ELASTIC_DEFORM_TWIST
@ BRUSH_ELASTIC_DEFORM_GRAB_BISCALE
@ BRUSH_ELASTIC_DEFORM_GRAB
@ BRUSH_ELASTIC_DEFORM_GRAB_TRISCALE
@ BRUSH_ELASTIC_DEFORM_SCALE
@ GP_FILL_GPLMODE_ACTIVE
@ GP_FILL_GPLMODE_BELOW
@ GP_FILL_GPLMODE_VISIBLE
@ GP_FILL_GPLMODE_ALL_ABOVE
@ GP_FILL_GPLMODE_ABOVE
@ GP_FILL_GPLMODE_ALL_BELOW
unsigned int uint32_t
Definition BKE_text.h:81
@ GPAINT_BRUSH_TYPE_ERASE
@ GPAINT_BRUSH_TYPE_FILL
@ GPAINT_BRUSH_TYPE_TINT
@ GPAINT_BRUSH_TYPE_DRAW
@ GP_BRUSH_ERASER_STROKE
@ BRUSH_PAINT_WET_MIX_PRESSURE_INVERT
@ BRUSH_PAINT_WET_PERSISTENCE_PRESSURE
@ BRUSH_PAINT_FLOW_PRESSURE_INVERT
@ BRUSH_PAINT_DENSITY_PRESSURE
@ BRUSH_PAINT_WET_MIX_PRESSURE
@ BRUSH_PAINT_DENSITY_PRESSURE_INVERT
@ BRUSH_PAINT_WET_PERSISTENCE_PRESSURE_INVERT
@ BRUSH_PAINT_FLOW_PRESSURE
@ BRUSH_PAINT_ANTIALIASING
unsigned char uint8_t
Definition BKE_text.h:79
@ IMAGE_PAINT_BRUSH_TYPE_SOFTEN
@ IMAGE_PAINT_BRUSH_TYPE_SMEAR
@ IMAGE_PAINT_BRUSH_TYPE_DRAW
@ IMAGE_PAINT_BRUSH_TYPE_FILL
@ IMAGE_PAINT_BRUSH_TYPE_MASK
@ IMAGE_PAINT_BRUSH_TYPE_CLONE
@ CURVES_SCULPT_BRUSH_TYPE_COMB
@ CURVES_SCULPT_BRUSH_TYPE_SMOOTH
@ CURVES_SCULPT_BRUSH_TYPE_ADD
@ CURVES_SCULPT_BRUSH_TYPE_SLIDE
@ CURVES_SCULPT_BRUSH_TYPE_DENSITY
@ CURVES_SCULPT_BRUSH_TYPE_PINCH
@ CURVES_SCULPT_BRUSH_TYPE_SNAKE_HOOK
@ CURVES_SCULPT_BRUSH_TYPE_GROW_SHRINK
@ CURVES_SCULPT_BRUSH_TYPE_DELETE
@ CURVES_SCULPT_BRUSH_TYPE_CUT
@ CURVES_SCULPT_BRUSH_TYPE_PUFF
@ CURVES_SCULPT_BRUSH_TYPE_SELECTION_PAINT
@ BRUSH_AUTOMASKING_VIEW_OCCLUSION
@ BRUSH_AUTOMASKING_TOPOLOGY
@ BRUSH_AUTOMASKING_BRUSH_NORMAL
@ BRUSH_AUTOMASKING_FACE_SETS
@ BRUSH_AUTOMASKING_CAVITY_USE_CURVE
@ BRUSH_AUTOMASKING_BOUNDARY_FACE_SETS
@ BRUSH_AUTOMASKING_BOUNDARY_EDGES
@ BRUSH_AUTOMASKING_CAVITY_ALL
@ BRUSH_AUTOMASKING_VIEW_NORMAL
@ BRUSH_AUTOMASKING_CAVITY_NORMAL
@ BRUSH_AUTOMASKING_CAVITY_INVERTED
@ GPVERTEX_BRUSH_TYPE_REPLACE
@ GPVERTEX_BRUSH_TYPE_BLUR
@ GPVERTEX_BRUSH_TYPE_AVERAGE
@ GPVERTEX_BRUSH_TYPE_TINT
@ GPVERTEX_BRUSH_TYPE_SMEAR
@ GPVERTEX_BRUSH_TYPE_DRAW
@ BRUSH_USE_UNIFIED_PAINT_INPUT_SAMPLES
@ BRUSH_USE_UNIFIED_PAINT_WEIGHT
@ BRUSH_USE_UNIFIED_PAINT_SIZE
@ BRUSH_USE_UNIFIED_PAINT_ALPHA
@ BRUSH_USE_UNIFIED_PAINT_COLOR
@ BRUSH_DEFORM_TARGET_CLOTH_SIM
@ BRUSH_DEFORM_TARGET_GEOMETRY
@ BRUSH_PROJECT_RAY_DIRECTION_PLANE_NORMAL
@ BRUSH_PROJECT_RAY_DIRECTION_VIEW_NORMAL
@ BRUSH_SPACING_PRESSURE
@ BRUSH_ORIGINAL_NORMAL
@ BRUSH_GRAB_ACTIVE_VERTEX
@ BRUSH_JITTER_PRESSURE
@ BRUSH_ABSOLUTE_JITTER
@ BRUSH_HARDNESS_PRESSURE
@ BRUSH_OFFSET_PRESSURE
@ BRUSH_SMOOTH_PRESSURE
@ BRUSH_INVERT_TO_SCRAPE_FILL
@ BRUSH_SMEAR_DEFORM_EXPAND
@ BRUSH_SMEAR_DEFORM_DRAG
@ BRUSH_SMEAR_DEFORM_PINCH
@ GP_BRUSH_USE_PRESS_AT_STROKE
@ GP_BRUSH_USE_UV_AT_STROKE
@ GP_BRUSH_USE_STRENGTH_RAND_PRESS
@ GP_BRUSH_USE_STROKE
@ GP_BRUSH_USE_UV_RAND_PRESS
@ GP_BRUSH_USE_PRESSURE_RAND_PRESS
@ GP_BRUSH_USE_STRENGTH_AT_STROKE
@ BRUSH_OVERLAY_SECONDARY
@ BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE
@ BRUSH_OVERLAY_PRIMARY
@ BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE
@ BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE
@ GP_BRUSH_FILL_FIT_DISABLE
@ GP_BRUSH_FILL_SHOW_EXTENDLINES
@ GP_BRUSH_OUTLINE_STROKE
@ GP_BRUSH_ERASER_KEEP_CAPS
@ GP_BRUSH_ACTIVE_LAYER_ONLY
@ GP_BRUSH_GROUP_RANDOM
@ GP_BRUSH_FILL_SHOW_HELPLINES
@ GP_BRUSH_OCCLUDE_ERASER
@ GP_BRUSH_FILL_STROKE_COLLIDE
@ GP_BRUSH_USE_STRENGTH_PRESSURE
@ GP_BRUSH_TRIM_STROKE
@ GP_BRUSH_STABILIZE_MOUSE_TEMP
@ GP_BRUSH_DISSABLE_LASSO
@ GP_BRUSH_FILL_AUTO_REMOVE_FILL_GUIDES
@ GP_BRUSH_FILL_INTERNAL_GAPS
@ GP_BRUSH_STABILIZE_MOUSE
@ GP_BRUSH_USE_PRESSURE
@ GP_BRUSH_GROUP_SETTINGS
@ GP_BRUSH_USE_CYCLIC_STROKE
@ GP_BRUSH_USE_JITTER_PRESSURE
@ GP_BRUSH_MATERIAL_PINNED
eBrushClothSimulationAreaType
@ BRUSH_CLOTH_SIMULATION_AREA_GLOBAL
@ BRUSH_CLOTH_SIMULATION_AREA_LOCAL
@ BRUSH_CLOTH_SIMULATION_AREA_DYNAMIC
signed char int8_t
Definition BKE_text.h:76
eBrushCurvesSculptDensityMode
@ BRUSH_CURVES_SCULPT_DENSITY_MODE_ADD
@ BRUSH_CURVES_SCULPT_DENSITY_MODE_AUTO
@ BRUSH_CURVES_SCULPT_DENSITY_MODE_REMOVE
eBrushClothForceFalloffType
@ BRUSH_CLOTH_FORCE_FALLOFF_PLANE
@ BRUSH_CLOTH_FORCE_FALLOFF_RADIAL
@ GP_SCULPT_FLAGMODE_APPLY_POSITION
@ GP_SCULPT_FLAGMODE_APPLY_UV
@ GP_SCULPT_FLAGMODE_APPLY_THICKNESS
@ GP_SCULPT_FLAGMODE_APPLY_STRENGTH
@ VPAINT_BRUSH_TYPE_DRAW
@ VPAINT_BRUSH_TYPE_SMEAR
@ VPAINT_BRUSH_TYPE_AVERAGE
@ VPAINT_BRUSH_TYPE_BLUR