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