Paint Struct Reference

#include <DNA_scene_types.h>

Public Attributes
struct Brush *	brush
struct AssetWeakReference *	brush_asset_reference
struct Brush *	eraser_brush
struct AssetWeakReference *	eraser_brush_asset_reference
ToolSystemBrushBindings	tool_brush_bindings
struct Palette *	palette
struct CurveMapping *	cavity_curve
void *	paint_cursor
unsigned char	paint_cursor_col [4]
int	flags
int	num_input_samples_deprecated
int	symmetry_flags
float	tile_offset [3]
char	_pad2 [4]
struct Paint_Runtime	runtime

Detailed Description

Paint Tool Base.

Definition at line 961 of file DNA_scene_types.h.

Member Data Documentation

_pad2

char Paint::_pad2[4]

Definition at line 1002 of file DNA_scene_types.h.

brush

struct Brush* Paint::brush

The active brush. Possibly null. Possibly stored in a separate Main data-base and not user- counted.

Definition at line 966 of file DNA_scene_types.h.

Referenced by BKE_paint_brush_for_read(), BKE_paint_brush_set(), BKE_paint_brush_set(), BKE_paint_brushes_ensure(), BKE_paint_copy(), paint_2d_new_stroke(), paint_brush_set_essentials_reference(), paint_brush_update_from_asset_reference(), scene_foreach_paint(), toolsystem_brush_type_binding_update(), and toolsystem_main_brush_binding_update_from_active().

brush_asset_reference

struct AssetWeakReference* Paint::brush_asset_reference

A weak asset reference to the brush, if not NULL. Used to attempt restoring the active brush from the AssetLibrary system, typically on file load.

Definition at line 973 of file DNA_scene_types.h.

Referenced by BKE_paint_blend_read_data(), BKE_paint_blend_write(), BKE_paint_brush_set(), BKE_paint_brush_set(), BKE_paint_brushes_ensure(), BKE_paint_copy(), BKE_paint_free(), blender::ed::sculpt_paint::brush_asset_delete_exec(), blender::ed::sculpt_paint::brush_asset_edit_metadata_exec(), blender::ed::sculpt_paint::brush_asset_edit_metadata_invoke(), blender::ed::sculpt_paint::brush_asset_edit_metadata_poll(), blender::ed::sculpt_paint::brush_asset_load_preview_exec(), blender::ed::sculpt_paint::brush_asset_revert_poll(), blender::ed::sculpt_paint::brush_asset_save_as_invoke(), blender::ed::sculpt_paint::brush_asset_save_as_poll(), blender::ed::sculpt_paint::brush_asset_save_exec(), blender::ed::sculpt_paint::brush_asset_save_poll(), paint_brush_set_essentials_reference(), paint_brush_update_from_asset_reference(), toolsystem_brush_type_binding_update(), and blender::ed::sculpt_paint::visit_active_library_catalogs_catalog_for_search_fn().

cavity_curve

struct CurveMapping* Paint::cavity_curve

Cavity curve.

Definition at line 983 of file DNA_scene_types.h.

Referenced by BKE_paint_blend_read_data(), BKE_paint_blend_write(), BKE_paint_cavity_curve_preset(), BKE_paint_copy(), BKE_paint_free(), BKE_paint_init(), do_version_curvemapping_walker(), and blender::ed::sculpt_paint::paint_stroke_new().

eraser_brush

struct Brush* Paint::eraser_brush

Default eraser brush and associated weak reference.

Definition at line 976 of file DNA_scene_types.h.

Referenced by BKE_paint_brushes_ensure(), BKE_paint_eraser_brush_for_read(), BKE_paint_eraser_brush_set(), blender::ed::sculpt_paint::greasepencil::EraseOperation::on_stroke_begin(), paint_eraser_brush_set_essentials_reference(), paint_eraser_brush_set_from_asset_reference(), and scene_foreach_paint().

eraser_brush_asset_reference

struct AssetWeakReference* Paint::eraser_brush_asset_reference

Definition at line 977 of file DNA_scene_types.h.

Referenced by BKE_paint_blend_read_data(), BKE_paint_blend_write(), BKE_paint_brushes_ensure(), BKE_paint_copy(), BKE_paint_eraser_brush_set(), BKE_paint_free(), paint_eraser_brush_set_essentials_reference(), and paint_eraser_brush_set_from_asset_reference().

flags

int Paint::flags

Enum ePaintFlags.

Definition at line 990 of file DNA_scene_types.h.

Referenced by BKE_paint_ensure(), BLO_update_defaults_startup_blend(), do_versions_after_linking_280(), blender::ed::sculpt_paint::paint_cursor_is_brush_cursor_enabled(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), sample_color_exec(), sample_color_invoke(), and sample_color_modal().

num_input_samples_deprecated

int Paint::num_input_samples_deprecated

Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to smooth the stroke. This value is deprecated. Refer to the Brush and #UnifiedPaintSetting values instead.

Definition at line 996 of file DNA_scene_types.h.

paint_cursor

void* Paint::paint_cursor

WM Paint cursor.

Definition at line 986 of file DNA_scene_types.h.

Referenced by BKE_paint_blend_read_data(), ED_paint_cursor_start(), and toggle_paint_cursor().

paint_cursor_col

unsigned char Paint::paint_cursor_col[4]

Definition at line 987 of file DNA_scene_types.h.

Referenced by BKE_paint_init(), blender::ed::sculpt_paint::curves_sculptmode_enter(), blender::ed::sculpt_paint::grease_pencil_brush_cursor_draw(), blender::ed::sculpt_paint::paint_draw_line_cursor(), and blender::ed::sculpt_paint::paint_draw_smooth_cursor().

palette

struct Palette* Paint::palette

Definition at line 981 of file DNA_scene_types.h.

Referenced by BKE_gpencil_palette_ensure(), BKE_paint_copy(), BKE_paint_palette(), BKE_paint_palette_set(), blender::ui::greasepencil::eyedropper_add_palette_color(), palette_color_add_exec(), palette_color_delete_exec(), palette_color_move_exec(), palette_join_exec(), palette_poll(), palette_sort_exec(), and scene_foreach_paint().

runtime

struct Paint_Runtime Paint::runtime

Definition at line 1004 of file DNA_scene_types.h.

Referenced by BKE_paint_brush_poll(), BKE_paint_brushes_validate(), BKE_paint_ensure(), BKE_paint_eraser_brush_set(), BKE_paint_use_unified_color(), blender::ed::sculpt_paint::vwpaint::brush_use_accumulate(), paint_brush_set_default_reference(), paint_brush_set_essentials_reference(), paint_brush_update_from_asset_reference(), paint_eraser_brush_set_essentials_reference(), paint_eraser_brush_set_from_asset_reference(), paint_runtime_init(), and toolsystem_brush_activate_from_toolref_for_object_paint().

symmetry_flags

int Paint::symmetry_flags

Flags used for symmetry.

Definition at line 999 of file DNA_scene_types.h.

Referenced by blo_do_versions_260(), calc_symmetry_feather(), blender::ed::sculpt_paint::cursor_draw_tiling_preview(), and blender::ed::sculpt_paint::do_tiled().

tile_offset

float Paint::tile_offset[3]

Definition at line 1001 of file DNA_scene_types.h.

Referenced by BKE_sculpt_toolsettings_data_ensure(), blender::ed::sculpt_paint::cursor_draw_tiling_preview(), and blender::ed::sculpt_paint::do_tiled().

tool_brush_bindings

ToolSystemBrushBindings Paint::tool_brush_bindings

Definition at line 979 of file DNA_scene_types.h.

Referenced by BKE_paint_blend_read_data(), BKE_paint_blend_write(), BKE_paint_copy(), BKE_paint_free(), toolsystem_brush_activate_from_toolref_for_object_paint(), toolsystem_brush_type_binding_lookup(), toolsystem_brush_type_binding_update(), and toolsystem_main_brush_binding_update_from_active().

---

The documentation for this struct was generated from the following file:

• DNA_scene_types.h