Blender V5.0
rna_shader_fx.cc
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#include <cfloat>
10#include <climits>
11#include <cstdlib>
12
14#include "DNA_shader_fx_types.h"
15
16#include "BLI_math_rotation.h"
17
18#include "BLT_translation.hh"
19
20#include "BKE_animsys.h"
21
22#include "RNA_define.hh"
23#include "RNA_enum_types.hh"
24
25#include "rna_internal.hh"
26
27#include "WM_api.hh"
28#include "WM_types.hh"
29
31 {eShaderFxType_Blur, "FX_BLUR", ICON_SHADERFX, "Blur", "Apply Gaussian Blur to object"},
33 "FX_COLORIZE",
34 ICON_SHADERFX,
35 "Colorize",
36 "Apply different tint effects"},
37 {eShaderFxType_Flip, "FX_FLIP", ICON_SHADERFX, "Flip", "Flip image"},
38 {eShaderFxType_Glow, "FX_GLOW", ICON_SHADERFX, "Glow", "Create a glow effect"},
39 {eShaderFxType_Pixel, "FX_PIXEL", ICON_SHADERFX, "Pixelate", "Pixelate image"},
40 {eShaderFxType_Rim, "FX_RIM", ICON_SHADERFX, "Rim", "Add a rim to the image"},
41 {eShaderFxType_Shadow, "FX_SHADOW", ICON_SHADERFX, "Shadow", "Create a shadow effect"},
42 {eShaderFxType_Swirl, "FX_SWIRL", ICON_SHADERFX, "Swirl", "Create a rotation distortion"},
44 "FX_WAVE",
45 ICON_SHADERFX,
46 "Wave Distortion",
47 "Apply sinusoidal deformation"},
48 {0, nullptr, 0, nullptr, nullptr},
49};
50
52 {eShaderFxRimMode_Normal, "NORMAL", 0, "Regular", ""},
53 {eShaderFxRimMode_Overlay, "OVERLAY", 0, "Overlay", ""},
54 {eShaderFxRimMode_Add, "ADD", 0, "Add", ""},
55 {eShaderFxRimMode_Subtract, "SUBTRACT", 0, "Subtract", ""},
56 {eShaderFxRimMode_Multiply, "MULTIPLY", 0, "Multiply", ""},
57 {eShaderFxRimMode_Divide, "DIVIDE", 0, "Divide", ""},
58 {0, nullptr, 0, nullptr, nullptr}};
59
61 {eShaderFxGlowMode_Luminance, "LUMINANCE", 0, "Luminance", ""},
62 {eShaderFxGlowMode_Color, "COLOR", 0, "Color", ""},
63 {0, nullptr, 0, nullptr, nullptr}};
64
66 {eShaderFxColorizeMode_GrayScale, "GRAYSCALE", 0, "Gray Scale", ""},
67 {eShaderFxColorizeMode_Sepia, "SEPIA", 0, "Sepia", ""},
68 {eShaderFxColorizeMode_Duotone, "DUOTONE", 0, "Duotone", ""},
69 {eShaderFxColorizeMode_Transparent, "TRANSPARENT", 0, "Transparent", ""},
70 {eShaderFxColorizeMode_Custom, "CUSTOM", 0, "Custom", ""},
71 {0, nullptr, 0, nullptr, nullptr}};
72
74 {eGplBlendMode_Regular, "REGULAR", 0, "Regular", ""},
75 {eGplBlendMode_Add, "ADD", 0, "Add", ""},
76 {eGplBlendMode_Subtract, "SUBTRACT", 0, "Subtract", ""},
77 {eGplBlendMode_Multiply, "MULTIPLY", 0, "Multiply", ""},
78 {eGplBlendMode_Divide, "DIVIDE", 0, "Divide", ""},
79 {0, nullptr, 0, nullptr, nullptr}};
80
81#ifdef RNA_RUNTIME
82
83# include <fmt/format.h>
84
85# include "BKE_shader_fx.h"
86
87# include "DEG_depsgraph.hh"
88# include "DEG_depsgraph_build.hh"
89
90static StructRNA *rna_ShaderFx_refine(PointerRNA *ptr)
91{
92 ShaderFxData *md = (ShaderFxData *)ptr->data;
93
94 switch ((ShaderFxType)md->type) {
96 return &RNA_ShaderFxBlur;
98 return &RNA_ShaderFxColorize;
100 return &RNA_ShaderFxWave;
102 return &RNA_ShaderFxPixel;
104 return &RNA_ShaderFxRim;
106 return &RNA_ShaderFxShadow;
108 return &RNA_ShaderFxSwirl;
110 return &RNA_ShaderFxFlip;
112 return &RNA_ShaderFxGlow;
113 /* Default */
116 default:
117 return &RNA_ShaderFx;
118 }
119
120 return &RNA_ShaderFx;
121}
122
123static void rna_ShaderFx_name_set(PointerRNA *ptr, const char *value)
124{
125 ShaderFxData *gmd = static_cast<ShaderFxData *>(ptr->data);
126 char oldname[sizeof(gmd->name)];
127
128 /* make a copy of the old name first */
129 STRNCPY(oldname, gmd->name);
130
131 /* copy the new name into the name slot */
132 STRNCPY_UTF8(gmd->name, value);
133
134 /* make sure the name is truly unique */
135 if (ptr->owner_id) {
136 Object *ob = (Object *)ptr->owner_id;
137 BKE_shaderfx_unique_name(&ob->shader_fx, gmd);
138 }
139
140 /* fix all the animation data which may link to this */
141 BKE_animdata_fix_paths_rename_all(nullptr, "shader_effects", oldname, gmd->name);
142}
143
144static std::optional<std::string> rna_ShaderFx_path(const PointerRNA *ptr)
145{
146 const ShaderFxData *gmd = static_cast<ShaderFxData *>(ptr->data);
147 char name_esc[sizeof(gmd->name) * 2];
148
149 BLI_str_escape(name_esc, gmd->name, sizeof(name_esc));
150 return fmt::format("shader_effects[\"{}\"]", name_esc);
151}
152
153static void rna_ShaderFx_update(Main * /*bmain*/, Scene * /*scene*/, PointerRNA *ptr)
154{
157}
158
159static void rna_ShaderFx_dependency_update(Main *bmain, Scene *scene, PointerRNA *ptr)
160{
161 rna_ShaderFx_update(bmain, scene, ptr);
163}
164
165/* Objects */
166
167static void shaderfx_object_set(Object *self, Object **ob_p, int type, PointerRNA value)
168{
169 Object *ob = static_cast<Object *>(value.data);
170
171 if (!self || ob != self) {
172 if (!ob || type == OB_EMPTY || ob->type == type) {
173 id_lib_extern((ID *)ob);
174 *ob_p = ob;
175 }
176 }
177}
178
179# define RNA_FX_OBJECT_SET(_type, _prop, _obtype) \
180 static void rna_##_type##ShaderFx_##_prop##_set( \
181 PointerRNA *ptr, PointerRNA value, ReportList * /*reports*/) \
182 { \
183 _type##ShaderFxData *tmd = (_type##ShaderFxData *)ptr->data; \
184 shaderfx_object_set((Object *)ptr->owner_id, &tmd->_prop, _obtype, value); \
185 }
186
187RNA_FX_OBJECT_SET(Shadow, object, OB_EMPTY);
188RNA_FX_OBJECT_SET(Swirl, object, OB_EMPTY);
189
190# undef RNA_FX_OBJECT_SET
191
192#else
193
195{
196 StructRNA *srna;
197 PropertyRNA *prop;
198
199 srna = RNA_def_struct(brna, "ShaderFxBlur", "ShaderFx");
200 RNA_def_struct_ui_text(srna, "Gaussian Blur Effect", "Gaussian Blur effect");
201 RNA_def_struct_sdna(srna, "BlurShaderFxData");
202 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
203
205
206 prop = RNA_def_property(srna, "size", PROP_FLOAT, PROP_XYZ);
207 RNA_def_property_float_sdna(prop, nullptr, "radius");
208 RNA_def_property_range(prop, 0.0f, FLT_MAX);
209 RNA_def_property_ui_text(prop, "Size", "Factor of Blur");
210 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
211
212 prop = RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
213 RNA_def_property_int_sdna(prop, nullptr, "samples");
214 RNA_def_property_range(prop, 0, 32);
215 RNA_def_property_ui_range(prop, 0, 32, 2, -1);
217 RNA_def_property_ui_text(prop, "Samples", "Number of Blur Samples (zero, disable blur)");
218 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
219
220 prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
221 RNA_def_property_float_sdna(prop, nullptr, "rotation");
223 RNA_def_property_ui_text(prop, "Rotation", "Rotation of the effect");
224 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
225
226 prop = RNA_def_property(srna, "use_dof_mode", PROP_BOOLEAN, PROP_NONE);
227 RNA_def_property_boolean_sdna(prop, nullptr, "flag", FX_BLUR_DOF_MODE);
228 RNA_def_property_ui_text(prop, "Use as Depth Of Field", "Blur using camera depth of field");
229 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
230
232}
233
235{
236 StructRNA *srna;
237 PropertyRNA *prop;
238
239 srna = RNA_def_struct(brna, "ShaderFxColorize", "ShaderFx");
240 RNA_def_struct_ui_text(srna, "Colorize Effect", "Colorize effect");
241 RNA_def_struct_sdna(srna, "ColorizeShaderFxData");
242 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
243
245
246 prop = RNA_def_property(srna, "factor", PROP_FLOAT, PROP_NONE);
247 RNA_def_property_float_sdna(prop, nullptr, "factor");
248 RNA_def_property_range(prop, 0, 1.0);
249 RNA_def_property_ui_text(prop, "Factor", "Mix factor");
250 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
251
252 prop = RNA_def_property(srna, "low_color", PROP_FLOAT, PROP_COLOR);
253 RNA_def_property_range(prop, 0.0, 1.0);
254 RNA_def_property_float_sdna(prop, nullptr, "low_color");
255 RNA_def_property_array(prop, 4);
256 RNA_def_property_ui_text(prop, "Low Color", "First color used for effect");
257 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
258
259 prop = RNA_def_property(srna, "high_color", PROP_FLOAT, PROP_COLOR);
260 RNA_def_property_range(prop, 0.0, 1.0);
261 RNA_def_property_float_sdna(prop, nullptr, "high_color");
262 RNA_def_property_array(prop, 4);
263 RNA_def_property_ui_text(prop, "High Color", "Second color used for effect");
264 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
265
266 prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
267 RNA_def_property_enum_sdna(prop, nullptr, "mode");
269 RNA_def_property_ui_text(prop, "Mode", "Effect mode");
270 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
271
273}
274
276{
277 StructRNA *srna;
278 PropertyRNA *prop;
279
280 static const EnumPropertyItem prop_shaderfx_wave_type_items[] = {
281 {0, "HORIZONTAL", 0, "Horizontal", ""},
282 {1, "VERTICAL", 0, "Vertical", ""},
283 {0, nullptr, 0, nullptr, nullptr}};
284
285 srna = RNA_def_struct(brna, "ShaderFxWave", "ShaderFx");
286 RNA_def_struct_ui_text(srna, "Wave Deformation Effect", "Wave Deformation effect");
287 RNA_def_struct_sdna(srna, "WaveShaderFxData");
288 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
289
291
292 prop = RNA_def_property(srna, "orientation", PROP_ENUM, PROP_NONE);
293 RNA_def_property_enum_sdna(prop, nullptr, "orientation");
294 RNA_def_property_enum_items(prop, prop_shaderfx_wave_type_items);
295 RNA_def_property_ui_text(prop, "Orientation", "Direction of the wave");
296 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
297
298 prop = RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
299 RNA_def_property_float_sdna(prop, nullptr, "amplitude");
301 RNA_def_property_ui_text(prop, "Amplitude", "Amplitude of Wave");
302 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
303
304 prop = RNA_def_property(srna, "period", PROP_FLOAT, PROP_NONE);
305 RNA_def_property_float_sdna(prop, nullptr, "period");
307 RNA_def_property_ui_text(prop, "Period", "Period of Wave");
308 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
309
310 prop = RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
311 RNA_def_property_float_sdna(prop, nullptr, "phase");
313 RNA_def_property_ui_text(prop, "Phase", "Phase Shift of Wave");
314 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
315
317}
318
320{
321 StructRNA *srna;
322 PropertyRNA *prop;
323
324 srna = RNA_def_struct(brna, "ShaderFxPixel", "ShaderFx");
325 RNA_def_struct_ui_text(srna, "Pixelate Effect", "Pixelate effect");
326 RNA_def_struct_sdna(srna, "PixelShaderFxData");
327 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
328
330
331 prop = RNA_def_property(srna, "size", PROP_INT, PROP_PIXEL);
332 RNA_def_property_int_sdna(prop, nullptr, "size");
333 RNA_def_property_range(prop, 1, SHRT_MAX);
334 RNA_def_property_array(prop, 2);
335 RNA_def_property_ui_text(prop, "Size", "Pixel size");
336 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
337
338 prop = RNA_def_property(srna, "use_antialiasing", PROP_BOOLEAN, PROP_NONE);
340 RNA_def_property_ui_text(prop, "Antialiasing", "Antialias pixels");
341 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
342
344}
345
347{
348 StructRNA *srna;
349 PropertyRNA *prop;
350
351 srna = RNA_def_struct(brna, "ShaderFxRim", "ShaderFx");
352 RNA_def_struct_ui_text(srna, "Rim Effect", "Rim effect");
353 RNA_def_struct_sdna(srna, "RimShaderFxData");
354 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
355
357
358 prop = RNA_def_property(srna, "offset", PROP_INT, PROP_PIXEL);
359 RNA_def_property_int_sdna(prop, nullptr, "offset");
360 RNA_def_property_range(prop, SHRT_MIN, SHRT_MAX);
361 RNA_def_property_ui_text(prop, "Offset", "Offset of the rim");
362 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
363
364 prop = RNA_def_property(srna, "rim_color", PROP_FLOAT, PROP_COLOR);
365 RNA_def_property_range(prop, 0.0, 1.0);
366 RNA_def_property_float_sdna(prop, nullptr, "rim_rgb");
367 RNA_def_property_array(prop, 3);
368 RNA_def_property_ui_text(prop, "Rim Color", "Color used for Rim");
369 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
370
371 prop = RNA_def_property(srna, "mask_color", PROP_FLOAT, PROP_COLOR);
372 RNA_def_property_range(prop, 0.0, 1.0);
373 RNA_def_property_float_sdna(prop, nullptr, "mask_rgb");
374 RNA_def_property_array(prop, 3);
375 RNA_def_property_ui_text(prop, "Mask Color", "Color that must be kept");
376 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
377
378 prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
379 RNA_def_property_enum_sdna(prop, nullptr, "mode");
381 RNA_def_property_ui_text(prop, "Mode", "Blend mode");
382 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
383
384 prop = RNA_def_property(srna, "blur", PROP_INT, PROP_PIXEL);
385 RNA_def_property_int_sdna(prop, nullptr, "blur");
386 RNA_def_property_range(prop, 0, SHRT_MAX);
388 prop, "Blur", "Number of pixels for blurring rim (set to 0 to disable)");
389 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
390
391 prop = RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
392 RNA_def_property_int_sdna(prop, nullptr, "samples");
393 RNA_def_property_range(prop, 0, 32);
394 RNA_def_property_ui_range(prop, 0, 32, 2, -1);
396 RNA_def_property_ui_text(prop, "Samples", "Number of Blur Samples (zero, disable blur)");
397 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
398
400}
401
403{
404 static const EnumPropertyItem prop_shaderfx_shadow_type_items[] = {
405 {0, "HORIZONTAL", 0, "Horizontal", ""},
406 {1, "VERTICAL", 0, "Vertical", ""},
407 {0, nullptr, 0, nullptr, nullptr}};
408
409 StructRNA *srna;
410 PropertyRNA *prop;
411
412 srna = RNA_def_struct(brna, "ShaderFxShadow", "ShaderFx");
413 RNA_def_struct_ui_text(srna, "Shadow Effect", "Shadow effect");
414 RNA_def_struct_sdna(srna, "ShadowShaderFxData");
415 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
416
418
419 prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
420 RNA_def_property_ui_text(prop, "Object", "Object to determine center of rotation");
421 RNA_def_property_pointer_funcs(prop, nullptr, "rna_ShadowShaderFx_object_set", nullptr, nullptr);
423 RNA_def_property_update(prop, 0, "rna_ShaderFx_dependency_update");
424
425 prop = RNA_def_property(srna, "offset", PROP_INT, PROP_PIXEL);
426 RNA_def_property_int_sdna(prop, nullptr, "offset");
427 RNA_def_property_range(prop, SHRT_MIN, SHRT_MAX);
428 RNA_def_property_ui_text(prop, "Offset", "Offset of the shadow");
429 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
430
431 prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
432 RNA_def_property_float_sdna(prop, nullptr, "scale");
434 RNA_def_property_ui_text(prop, "Scale", "Scale of the shadow");
435 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
436
437 prop = RNA_def_property(srna, "shadow_color", PROP_FLOAT, PROP_COLOR);
438 RNA_def_property_range(prop, 0.0, 1.0);
439 RNA_def_property_float_sdna(prop, nullptr, "shadow_rgba");
440 RNA_def_property_array(prop, 4);
441 RNA_def_property_ui_text(prop, "Shadow Color", "Color used for Shadow");
442 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
443
444 prop = RNA_def_property(srna, "orientation", PROP_ENUM, PROP_NONE);
445 RNA_def_property_enum_sdna(prop, nullptr, "orientation");
446 RNA_def_property_enum_items(prop, prop_shaderfx_shadow_type_items);
447 RNA_def_property_ui_text(prop, "Orientation", "Direction of the wave");
448 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
449
450 prop = RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
451 RNA_def_property_float_sdna(prop, nullptr, "amplitude");
453 RNA_def_property_ui_text(prop, "Amplitude", "Amplitude of Wave");
454 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
455
456 prop = RNA_def_property(srna, "period", PROP_FLOAT, PROP_NONE);
457 RNA_def_property_float_sdna(prop, nullptr, "period");
459 RNA_def_property_ui_text(prop, "Period", "Period of Wave");
460 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
461
462 prop = RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
463 RNA_def_property_float_sdna(prop, nullptr, "phase");
465 RNA_def_property_ui_text(prop, "Phase", "Phase Shift of Wave");
466 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
467
468 prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
469 RNA_def_property_float_sdna(prop, nullptr, "rotation");
470 RNA_def_property_range(prop, DEG2RAD(-360), DEG2RAD(360));
471 RNA_def_property_ui_range(prop, DEG2RAD(-360), DEG2RAD(360), 5, 2);
472 RNA_def_property_ui_text(prop, "Rotation", "Rotation around center or object");
473 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
474
475 prop = RNA_def_property(srna, "blur", PROP_INT, PROP_PIXEL);
476 RNA_def_property_int_sdna(prop, nullptr, "blur");
477 RNA_def_property_range(prop, 0, SHRT_MAX);
479 prop, "Blur", "Number of pixels for blurring shadow (set to 0 to disable)");
480 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
481
482 prop = RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
483 RNA_def_property_int_sdna(prop, nullptr, "samples");
484 RNA_def_property_range(prop, 0, 32);
485 RNA_def_property_ui_range(prop, 0, 32, 2, -1);
487 RNA_def_property_ui_text(prop, "Samples", "Number of Blur Samples (zero, disable blur)");
488 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
489
490 prop = RNA_def_property(srna, "use_object", PROP_BOOLEAN, PROP_NONE);
492 RNA_def_property_ui_text(prop, "Use Object", "Use object as center of rotation");
493 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
494
495 prop = RNA_def_property(srna, "use_wave", PROP_BOOLEAN, PROP_NONE);
497 RNA_def_property_ui_text(prop, "Wave", "Use wave effect");
499 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
500
502}
503
505{
506 StructRNA *srna;
507 PropertyRNA *prop;
508
509 srna = RNA_def_struct(brna, "ShaderFxGlow", "ShaderFx");
510 RNA_def_struct_ui_text(srna, "Glow Effect", "Glow effect");
511 RNA_def_struct_sdna(srna, "GlowShaderFxData");
512 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
513
515
516 prop = RNA_def_property(srna, "glow_color", PROP_FLOAT, PROP_COLOR);
517 RNA_def_property_range(prop, 0.0, 1.0);
518 RNA_def_property_float_sdna(prop, nullptr, "glow_color");
519 RNA_def_property_array(prop, 3);
520 RNA_def_property_ui_text(prop, "Glow Color", "Color used for generated glow");
521 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
522
523 prop = RNA_def_property(srna, "opacity", PROP_FLOAT, PROP_FACTOR);
524 RNA_def_property_float_sdna(prop, nullptr, "glow_color[3]");
525 RNA_def_property_range(prop, 0.0, 1.0f);
526 RNA_def_property_ui_text(prop, "Opacity", "Effect Opacity");
527 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
528
529 prop = RNA_def_property(srna, "select_color", PROP_FLOAT, PROP_COLOR);
530 RNA_def_property_range(prop, 0.0, 1.0);
531 RNA_def_property_float_sdna(prop, nullptr, "select_color");
532 RNA_def_property_array(prop, 3);
533 RNA_def_property_ui_text(prop, "Select Color", "Color selected to apply glow");
534 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
535
536 prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
537 RNA_def_property_enum_sdna(prop, nullptr, "mode");
539 RNA_def_property_ui_text(prop, "Mode", "Glow mode");
540 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
541
542 prop = RNA_def_property(srna, "threshold", PROP_FLOAT, PROP_FACTOR);
543 RNA_def_property_float_sdna(prop, nullptr, "threshold");
544 RNA_def_property_range(prop, 0.0f, 1.0f);
545 RNA_def_property_ui_range(prop, 0.0f, 1.0f, 0.1f, 3);
546 RNA_def_property_ui_text(prop, "Threshold", "Limit to select color for glow effect");
547 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
548
549 /* Use blur fields to make compatible with blur filter */
550 prop = RNA_def_property(srna, "size", PROP_FLOAT, PROP_XYZ);
551 RNA_def_property_float_sdna(prop, nullptr, "blur");
552 RNA_def_property_range(prop, 0.0f, FLT_MAX);
553 RNA_def_property_ui_text(prop, "Size", "Size of the effect");
554 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
555
556 prop = RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
557 RNA_def_property_int_sdna(prop, nullptr, "samples");
558 RNA_def_property_range(prop, 1, 32);
559 RNA_def_property_ui_range(prop, 1, 32, 2, -1);
561 RNA_def_property_ui_text(prop, "Samples", "Number of Blur Samples");
562 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
563
564 prop = RNA_def_property(srna, "use_glow_under", PROP_BOOLEAN, PROP_NONE);
565 RNA_def_property_boolean_sdna(prop, nullptr, "flag", FX_GLOW_USE_ALPHA);
567 prop, "Glow Under", "Glow only areas with alpha (not supported with Regular blend mode)");
568 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
569
570 prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
571 RNA_def_property_float_sdna(prop, nullptr, "rotation");
573 RNA_def_property_ui_text(prop, "Rotation", "Rotation of the effect");
574 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
575
576 /* blend mode */
577 prop = RNA_def_property(srna, "blend_mode", PROP_ENUM, PROP_NONE);
578 RNA_def_property_enum_sdna(prop, nullptr, "blend_mode");
580 RNA_def_property_ui_text(prop, "Blend Mode", "Blend mode");
581 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
582
584}
585
587{
588 StructRNA *srna;
589 PropertyRNA *prop;
590
591 srna = RNA_def_struct(brna, "ShaderFxSwirl", "ShaderFx");
592 RNA_def_struct_ui_text(srna, "Swirl Effect", "Swirl effect");
593 RNA_def_struct_sdna(srna, "SwirlShaderFxData");
594 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
595
597
598 prop = RNA_def_property(srna, "radius", PROP_INT, PROP_PIXEL);
599 RNA_def_property_int_sdna(prop, nullptr, "radius");
600 RNA_def_property_range(prop, 0, SHRT_MAX);
601 RNA_def_property_ui_text(prop, "Radius", "Radius to apply");
602 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
603
604 prop = RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
605 RNA_def_property_float_sdna(prop, nullptr, "angle");
606 RNA_def_property_range(prop, DEG2RAD(-5 * 360), DEG2RAD(5 * 360));
607 RNA_def_property_ui_range(prop, DEG2RAD(-5 * 360), DEG2RAD(5 * 360), 5, 2);
608 RNA_def_property_ui_text(prop, "Angle", "Angle of rotation");
609 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
610
611 prop = RNA_def_property(srna, "use_transparent", PROP_BOOLEAN, PROP_NONE);
613 RNA_def_property_ui_text(prop, "Transparent", "Make image transparent outside of radius");
614 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
615
616 prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
617 RNA_def_property_ui_text(prop, "Object", "Object to determine center location");
618 RNA_def_property_pointer_funcs(prop, nullptr, "rna_SwirlShaderFx_object_set", nullptr, nullptr);
620 RNA_def_property_update(prop, 0, "rna_ShaderFx_dependency_update");
621
623}
624
626{
627 StructRNA *srna;
628 PropertyRNA *prop;
629
630 srna = RNA_def_struct(brna, "ShaderFxFlip", "ShaderFx");
631 RNA_def_struct_ui_text(srna, "Flip Effect", "Flip effect");
632 RNA_def_struct_sdna(srna, "FlipShaderFxData");
633 RNA_def_struct_ui_icon(srna, ICON_SHADERFX);
634
636
637 prop = RNA_def_property(srna, "use_flip_x", PROP_BOOLEAN, PROP_NONE);
639 RNA_def_property_ui_text(prop, "Horizontal", "Flip image horizontally");
640 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
641
642 prop = RNA_def_property(srna, "use_flip_y", PROP_BOOLEAN, PROP_NONE);
643 RNA_def_property_boolean_sdna(prop, nullptr, "flag", FX_FLIP_VERTICAL);
644 RNA_def_property_ui_text(prop, "Vertical", "Flip image vertically");
645 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
646
648}
649
651{
652 StructRNA *srna;
653 PropertyRNA *prop;
654
655 /* data */
656 srna = RNA_def_struct(brna, "ShaderFx", nullptr);
657 RNA_def_struct_ui_text(srna, "ShaderFx", "Effect affecting the Grease Pencil object");
658 RNA_def_struct_refine_func(srna, "rna_ShaderFx_refine");
659 RNA_def_struct_path_func(srna, "rna_ShaderFx_path");
660 RNA_def_struct_sdna(srna, "ShaderFxData");
661
662 /* strings */
663 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
664 RNA_def_property_string_funcs(prop, nullptr, nullptr, "rna_ShaderFx_name_set");
665 RNA_def_property_ui_text(prop, "Name", "Effect name");
668
669 /* enums */
670 prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
672 RNA_def_property_enum_sdna(prop, nullptr, "type");
674 RNA_def_property_ui_text(prop, "Type", "");
675 RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_ID); /* Abused, for "Light"... */
676
677 /* flags */
678 prop = RNA_def_property(srna, "show_viewport", PROP_BOOLEAN, PROP_NONE);
680 RNA_def_property_ui_text(prop, "Realtime", "Display effect in viewport");
683 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
684 RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_ON, 1);
685
686 prop = RNA_def_property(srna, "show_render", PROP_BOOLEAN, PROP_NONE);
689 RNA_def_property_ui_text(prop, "Render", "Use effect during render");
690 RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_ON, 1);
692
693 prop = RNA_def_property(srna, "show_in_editmode", PROP_BOOLEAN, PROP_NONE);
695 RNA_def_property_ui_text(prop, "Edit Mode", "Display effect in Edit mode");
696 RNA_def_property_update(prop, NC_OBJECT | ND_SHADERFX, "rna_ShaderFx_update");
697 RNA_def_property_ui_icon(prop, ICON_EDITMODE_HLT, 0);
698
699 prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
701 RNA_def_property_boolean_sdna(prop, nullptr, "ui_expand_flag", 0);
703 RNA_def_property_ui_text(prop, "Expanded", "Set effect expansion in the user interface");
704 RNA_def_property_ui_icon(prop, ICON_RIGHTARROW, 1);
705
706 /* types */
716}
717
718#endif
void BKE_animdata_fix_paths_rename_all(struct ID *ref_id, const char *prefix, const char *oldName, const char *newName)
void id_lib_extern(ID *id)
Definition lib_id.cc:290
void BKE_shaderfx_unique_name(struct ListBase *shaders, struct ShaderFxData *fx)
Definition shader_fx.cc:115
#define DEG2RAD(_deg)
char * STRNCPY(char(&dst)[N], const char *src)
Definition BLI_string.h:693
size_t BLI_str_escape(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
#define STRNCPY_UTF8(dst, src)
#define BLT_I18NCONTEXT_ID_ID
#define BLT_I18NCONTEXT_ID_GPENCIL
void DEG_id_tag_update(ID *id, unsigned int flags)
void DEG_relations_tag_update(Main *bmain)
@ ID_RECALC_GEOMETRY
Definition DNA_ID.h:1074
@ eGplBlendMode_Regular
@ eGplBlendMode_Multiply
@ eGplBlendMode_Subtract
@ OB_EMPTY
@ FX_BLUR_DOF_MODE
@ FX_SHADOW_USE_OBJECT
@ FX_SHADOW_USE_WAVE
@ eShaderFxMode_Realtime
@ eShaderFxMode_Editmode
@ eShaderFxMode_Render
@ eShaderFxGlowMode_Luminance
@ eShaderFxGlowMode_Color
@ eShaderFxColorizeMode_Custom
@ eShaderFxColorizeMode_GrayScale
@ eShaderFxColorizeMode_Transparent
@ eShaderFxColorizeMode_Duotone
@ eShaderFxColorizeMode_Sepia
@ FX_SWIRL_MAKE_TRANSPARENT
@ eShaderFxRimMode_Multiply
@ eShaderFxRimMode_Add
@ eShaderFxRimMode_Normal
@ eShaderFxRimMode_Overlay
@ eShaderFxRimMode_Subtract
@ eShaderFxRimMode_Divide
@ FX_PIXEL_FILTER_NEAREST
@ FX_FLIP_HORIZONTAL
@ FX_FLIP_VERTICAL
@ FX_GLOW_USE_ALPHA
@ eShaderFxType_Pixel
@ eShaderFxType_Rim
@ eShaderFxType_None
@ eShaderFxType_Swirl
@ eShaderFxType_Glow
@ eShaderFxType_Flip
@ NUM_SHADER_FX_TYPES
@ eShaderFxType_Blur
@ eShaderFxType_Shadow
@ eShaderFxType_Colorize
@ eShaderFxType_Wave
@ PROP_FLOAT
Definition RNA_types.hh:164
@ PROP_BOOLEAN
Definition RNA_types.hh:162
@ PROP_ENUM
Definition RNA_types.hh:166
@ PROP_INT
Definition RNA_types.hh:163
@ PROP_STRING
Definition RNA_types.hh:165
@ PROP_POINTER
Definition RNA_types.hh:167
@ PROPOVERRIDE_OVERRIDABLE_LIBRARY
Definition RNA_types.hh:503
@ PROP_EDITABLE
Definition RNA_types.hh:306
@ PROP_LIB_EXCEPTION
Definition RNA_types.hh:312
@ PROP_NO_DEG_UPDATE
Definition RNA_types.hh:439
@ PROP_ID_SELF_CHECK
Definition RNA_types.hh:370
@ PROP_XYZ
Definition RNA_types.hh:269
@ PROP_COLOR
Definition RNA_types.hh:260
@ PROP_PIXEL
Definition RNA_types.hh:248
@ PROP_ANGLE
Definition RNA_types.hh:252
@ PROP_NONE
Definition RNA_types.hh:233
@ PROP_FACTOR
Definition RNA_types.hh:251
#define NA_RENAME
Definition WM_types.hh:588
#define ND_SHADERFX
Definition WM_types.hh:471
#define NC_OBJECT
Definition WM_types.hh:379
PyObject * self
void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop)
void RNA_def_struct_refine_func(StructRNA *srna, const char *refine)
void RNA_define_lib_overridable(const bool make_overridable)
void RNA_def_struct_path_func(StructRNA *srna, const char *path)
void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set)
void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description)
void RNA_def_property_ui_icon(PropertyRNA *prop, int icon, int consecutive)
void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description)
void RNA_def_property_int_default(PropertyRNA *prop, int value)
void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item)
void RNA_def_struct_sdna(StructRNA *srna, const char *structname)
void RNA_def_property_array(PropertyRNA *prop, int length)
void RNA_def_property_range(PropertyRNA *prop, double min, double max)
void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *func)
PropertyRNA * RNA_def_property(StructOrFunctionRNA *cont_, const char *identifier, int type, int subtype)
StructRNA * RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from)
void RNA_def_property_clear_flag(PropertyRNA *prop, PropertyFlag flag)
void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *type_fn, const char *poll)
void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_def_struct_ui_icon(StructRNA *srna, int icon)
void RNA_def_property_translation_context(PropertyRNA *prop, const char *context)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision)
void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
void RNA_def_property_override_flag(PropertyRNA *prop, PropertyOverrideFlag flag)
static void rna_def_shader_fx_wave(BlenderRNA *brna)
static void rna_def_shader_fx_glow(BlenderRNA *brna)
static void rna_def_shader_fx_flip(BlenderRNA *brna)
static void rna_def_shader_fx_pixel(BlenderRNA *brna)
static void rna_def_shader_fx_swirl(BlenderRNA *brna)
void RNA_def_shader_fx(BlenderRNA *brna)
static void rna_def_shader_fx_blur(BlenderRNA *brna)
static void rna_def_shader_fx_colorize(BlenderRNA *brna)
static const EnumPropertyItem rna_enum_shaderfx_colorize_modes_items[]
const EnumPropertyItem rna_enum_object_shaderfx_type_items[]
static void rna_def_shader_fx_rim(BlenderRNA *brna)
static void rna_def_shader_fx_shadow(BlenderRNA *brna)
static const EnumPropertyItem rna_enum_glow_blend_modes_items[]
static const EnumPropertyItem rna_enum_shaderfx_rim_modes_items[]
static const EnumPropertyItem rna_enum_shaderfx_glow_modes_items[]
#define FLT_MAX
Definition stdcycles.h:14
Definition DNA_ID.h:414
void * data
Definition RNA_types.hh:53
void WM_main_add_notifier(uint type, void *reference)
PointerRNA * ptr
Definition wm_files.cc:4238