c901abc834ead898685c5f5b03fe5b6b71ca4e46
[blender.git] / source / blender / makesrna / intern / rna_image.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Brecht Van Lommel
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_image.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "DNA_image_types.h"
30 #include "DNA_scene_types.h"
31
32 #include "BLI_utildefines.h"
33
34 #include "BKE_context.h"
35 #include "BKE_depsgraph.h"
36 #include "BKE_image.h"
37
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "rna_internal.h"
42
43 #include "WM_types.h"
44 #include "WM_api.h"
45
46 EnumPropertyItem image_generated_type_items[] = {
47         {IMA_GENTYPE_BLANK, "BLANK", 0, "Blank", "Generate a blank image"},
48         {IMA_GENTYPE_GRID, "UV_GRID", 0, "UV Grid", "Generated grid to test UV mappings"},
49         {IMA_GENTYPE_GRID_COLOR, "COLOR_GRID", 0, "Color Grid", "Generated improved UV grid to test UV mappings"},
50         {0, NULL, 0, NULL, NULL}
51 };
52
53 static EnumPropertyItem image_source_items[] = {
54         {IMA_SRC_FILE, "FILE", 0, "Single Image", "Single image file"},
55         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
56         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
57         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
58         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
59         {0, NULL, 0, NULL, NULL}
60 };
61
62 #ifdef RNA_RUNTIME
63
64 #include "IMB_imbuf.h"
65 #include "IMB_imbuf_types.h"
66
67 static void rna_Image_animated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
68 {
69         Image *ima = (Image *)ptr->data;
70         int nr;
71
72         if (ima->flag & IMA_TWINANIM) {
73                 nr = ima->xrep * ima->yrep;
74                 if (ima->twsta >= nr) ima->twsta = 1;
75                 if (ima->twend >= nr) ima->twend = nr - 1;
76                 if (ima->twsta > ima->twend) ima->twsta = 1;
77         }
78 }
79
80 static int rna_Image_dirty_get(PointerRNA *ptr)
81 {
82         Image *ima = (Image *)ptr->data;
83         ImBuf *ibuf;
84
85         for (ibuf = ima->ibufs.first; ibuf; ibuf = ibuf->next)
86                 if (ibuf->userflags & IB_BITMAPDIRTY)
87                         return 1;
88         
89         return 0;
90 }
91
92 static void rna_Image_source_set(PointerRNA *ptr, int value)
93 {
94         Image *ima = ptr->id.data;
95
96         if (value != ima->source) {
97                 ima->source = value;
98                 BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
99                 DAG_id_tag_update(&ima->id, 0);
100         }
101 }
102
103 static void rna_Image_fields_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
104 {
105         Image *ima = ptr->id.data;
106         ImBuf *ibuf;
107         void *lock;
108
109         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
110
111         if (ibuf) {
112                 short nr = 0;
113
114                 if (!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr = 1;
115                 if ((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr = 1;
116
117                 if (nr)
118                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
119         }
120
121         BKE_image_release_ibuf(ima, ibuf, lock);
122 }
123
124 static void rna_Image_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
125 {
126         Image *ima = ptr->id.data;
127         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
128         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
129         DAG_id_tag_update(&ima->id, 0);
130 }
131
132 static void rna_Image_generated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
133 {
134         Image *ima = ptr->id.data;
135         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
136 }
137
138 static void rna_Image_colormanage_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
139 {
140         Image *ima = ptr->id.data;
141         BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
142         DAG_id_tag_update(&ima->id, 0);
143         WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
144         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
145 }
146
147 static void rna_ImageUser_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
148 {
149         ImageUser *iuser = ptr->data;
150
151         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
152 }
153
154
155 static char *rna_ImageUser_path(PointerRNA *ptr)
156 {
157         if (ptr->id.data) {
158                 /* ImageUser *iuser = ptr->data; */
159                 
160                 switch (GS(((ID *)ptr->id.data)->name)) {
161                         case ID_TE:
162                         {
163                                 return BLI_strdup("image_user");
164                         }
165                         case ID_NT:
166                         {
167                                 return rna_Node_ImageUser_path(ptr);
168                         }
169                 }
170         }
171         
172         return BLI_strdup("");
173 }
174
175 static EnumPropertyItem *rna_Image_source_itemf(bContext *UNUSED(C), PointerRNA *ptr,
176                                                 PropertyRNA *UNUSED(prop), int *free)
177 {
178         Image *ima = (Image *)ptr->data;
179         EnumPropertyItem *item = NULL;
180         int totitem = 0;
181         
182         if (ima->source == IMA_SRC_VIEWER) {
183                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
184         }
185         else {
186                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
187                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
188                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
189                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
190         }
191
192         RNA_enum_item_end(&item, &totitem);
193         *free = 1;
194
195         return item;
196 }
197
198 static int rna_Image_file_format_get(PointerRNA *ptr)
199 {
200         Image *image = (Image *)ptr->data;
201         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
202         int imtype = BKE_ftype_to_imtype(ibuf ? ibuf->ftype : 0);
203
204         BKE_image_release_ibuf(image, ibuf, NULL);
205
206         return imtype;
207 }
208
209 static void rna_Image_file_format_set(PointerRNA *ptr, int value)
210 {
211         Image *image = (Image *)ptr->data;
212         if (BKE_imtype_is_movie(value) == 0) { /* should be able to throw an error here */
213                 ImBuf *ibuf;
214                 int ftype = BKE_imtype_to_ftype(value);
215
216 #if 0
217                 ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
218                 if (ibuf)
219                         ibuf->ftype = ftype;
220 #endif
221
222                 /* to be safe change all buffer file types */
223                 /* TODO: this is never threadsafe */
224                 for (ibuf = image->ibufs.first; ibuf; ibuf = ibuf->next) {
225                         ibuf->ftype = ftype;
226                 }
227         }
228 }
229
230 static int rna_Image_has_data_get(PointerRNA *ptr)
231 {
232         Image *im = (Image *)ptr->data;
233
234         if (im->ibufs.first)
235                 return 1;
236
237         return 0;
238 }
239
240 static void rna_Image_size_get(PointerRNA *ptr, int *values)
241 {
242         Image *im = (Image *)ptr->data;
243         ImBuf *ibuf;
244         void *lock;
245
246         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
247         if (ibuf) {
248                 values[0] = ibuf->x;
249                 values[1] = ibuf->y;
250         }
251         else {
252                 values[0] = 0;
253                 values[1] = 0;
254         }
255
256         BKE_image_release_ibuf(im, ibuf, lock);
257 }
258
259 static void rna_Image_resolution_get(PointerRNA *ptr, float *values)
260 {
261         Image *im = (Image *)ptr->data;
262         ImBuf *ibuf;
263         void *lock;
264
265         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
266         if (ibuf) {
267                 values[0] = ibuf->ppm[0];
268                 values[1] = ibuf->ppm[1];
269         }
270         else {
271                 values[0] = 0;
272                 values[1] = 0;
273         }
274
275         BKE_image_release_ibuf(im, ibuf, lock);
276 }
277
278 static void rna_Image_resolution_set(PointerRNA *ptr, const float *values)
279 {
280         Image *im = (Image *)ptr->data;
281         ImBuf *ibuf;
282         void *lock;
283
284         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
285         if (ibuf) {
286                 ibuf->ppm[0] = values[0];
287                 ibuf->ppm[1] = values[1];
288         }
289
290         BKE_image_release_ibuf(im, ibuf, lock);
291 }
292
293 static int rna_Image_depth_get(PointerRNA *ptr)
294 {
295         Image *im = (Image *)ptr->data;
296         ImBuf *ibuf;
297         void *lock;
298         int planes;
299         
300         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
301
302         if (!ibuf)
303                 planes = 0;
304         else if (ibuf->rect_float)
305                 planes = ibuf->planes * 4;
306         else
307                 planes = ibuf->planes;
308
309         BKE_image_release_ibuf(im, ibuf, lock);
310
311         return planes;
312 }
313
314 static int rna_Image_frame_duration_get(PointerRNA *ptr)
315 {
316         Image *im = (Image *)ptr->data;
317
318         if (im->anim)
319                 return IMB_anim_get_duration(im->anim, IMB_TC_RECORD_RUN);
320         return 1;
321 }
322
323 static int rna_Image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
324 {
325         Image *ima = ptr->id.data;
326         ImBuf *ibuf;
327         void *lock;
328
329         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
330
331         if (ibuf)
332                 length[0] = ibuf->x * ibuf->y * ibuf->channels;
333         else
334                 length[0] = 0;
335
336         BKE_image_release_ibuf(ima, ibuf, lock);
337
338         return length[0];
339 }
340
341 static void rna_Image_pixels_get(PointerRNA *ptr, float *values)
342 {
343         Image *ima = ptr->id.data;
344         ImBuf *ibuf;
345         void *lock;
346         int i, size;
347
348         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
349
350         if (ibuf) {
351                 size = ibuf->x * ibuf->y * ibuf->channels;
352
353                 if (ibuf->rect_float) {
354                         memcpy(values, ibuf->rect_float, sizeof(float) * size);
355                 }
356                 else {
357                         for (i = 0; i < size; i++)
358                                 values[i] = ((unsigned char *)ibuf->rect)[i] * (1.0f / 255.0f);
359                 }
360         }
361
362         BKE_image_release_ibuf(ima, ibuf, lock);
363 }
364
365 static void rna_Image_pixels_set(PointerRNA *ptr, const float *values)
366 {
367         Image *ima = ptr->id.data;
368         ImBuf *ibuf;
369         void *lock;
370         int i, size;
371
372         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
373
374         if (ibuf) {
375                 size = ibuf->x * ibuf->y * ibuf->channels;
376
377                 if (ibuf->rect_float) {
378                         memcpy(ibuf->rect_float, values, sizeof(float) * size);
379                 }
380                 else {
381                         for (i = 0; i < size; i++)
382                                 ((unsigned char *)ibuf->rect)[i] = FTOCHAR(values[i]);
383                 }
384
385                 ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID;
386         }
387
388         BKE_image_release_ibuf(ima, ibuf, lock);
389 }
390
391 static int rna_Image_channels_get(PointerRNA *ptr)
392 {
393         Image *im = (Image *)ptr->data;
394         ImBuf *ibuf;
395         void *lock;
396         int channels = 0;
397
398         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
399         if (ibuf)
400                 channels = ibuf->channels;
401
402         BKE_image_release_ibuf(im, ibuf, lock);
403
404         return channels;
405 }
406
407 static int rna_Image_is_float_get(PointerRNA *ptr)
408 {
409         Image *im = (Image *)ptr->data;
410         ImBuf *ibuf;
411         void *lock;
412         int is_float = FALSE;
413
414         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
415         if (ibuf)
416                 is_float = ibuf->rect_float != NULL;
417
418         BKE_image_release_ibuf(im, ibuf, lock);
419
420         return is_float;
421 }
422
423 #else
424
425 static void rna_def_imageuser(BlenderRNA *brna)
426 {
427         StructRNA *srna;
428         PropertyRNA *prop;
429
430         srna = RNA_def_struct(brna, "ImageUser", NULL);
431         RNA_def_struct_ui_text(srna, "Image User",
432                                "Parameters defining how an Image datablock is used by another datablock");
433         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
434
435         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
436         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
437         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
438         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
439         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
440
441         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
442         RNA_def_property_int_sdna(prop, NULL, "framenr");
443         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
444         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in image sequence or movie");
445
446         /* animation */
447         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
448         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
449         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
450         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
451         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
452
453         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
454         RNA_def_property_int_sdna(prop, NULL, "frames");
455         RNA_def_property_range(prop, 0, MAXFRAMEF);
456         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
457         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
458         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
459
460         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
461         RNA_def_property_int_sdna(prop, NULL, "offset");
462         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
463         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
464
465         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
466         RNA_def_property_int_sdna(prop, NULL, "sfra");
467         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
468         RNA_def_property_ui_text(prop, "Start Frame",
469                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
470         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
471         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
472
473         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
474         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
475         RNA_def_property_range(prop, 1, 200);
476         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
477         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
478         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
479
480         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
481         RNA_def_property_int_sdna(prop, NULL, "layer");
482         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
483         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
484
485         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
486         RNA_def_property_int_sdna(prop, NULL, "pass");
487         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
488         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
489 }
490
491 static void rna_def_image(BlenderRNA *brna)
492 {
493         StructRNA *srna;
494         PropertyRNA *prop;
495         static const EnumPropertyItem prop_type_items[] = {
496                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
497                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
498                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
499                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
500                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
501                 {0, NULL, 0, NULL, NULL}
502         };
503         static const EnumPropertyItem prop_mapping_items[] = {
504                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
505                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
506                 {0, NULL, 0, NULL, NULL}
507         };
508         static const EnumPropertyItem prop_field_order_items[] = {
509                 {0, "EVEN", 0, "Upper First", "Upper field first"},
510                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
511                 {0, NULL, 0, NULL, NULL}
512         };
513         static const EnumPropertyItem alpha_mode_items[] = {
514                 {IMA_ALPHA_STRAIGHT, "STRAIGHT", 0, "Straight", "Transparent RGB and alpha pixels are unmodified"},
515                 {IMA_ALPHA_PREMUL, "PREMUL", 0, "Premultiplied", "Transparent RGB pixels are multiplied by the alpha channel"},
516                 {0, NULL, 0, NULL, NULL}
517         };
518
519         srna = RNA_def_struct(brna, "Image", "ID");
520         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image");
521         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
522
523         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
524         RNA_def_property_string_sdna(prop, NULL, "name");
525         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name");
526         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
527
528         /* eek. this is horrible but needed so we can save to a new name without blanking the data :( */
529         prop = RNA_def_property(srna, "filepath_raw", PROP_STRING, PROP_FILEPATH);
530         RNA_def_property_string_sdna(prop, NULL, "name");
531         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name (without data refreshing)");
532
533         prop = RNA_def_property(srna, "file_format", PROP_ENUM, PROP_NONE);
534         RNA_def_property_enum_items(prop, image_type_items);
535         RNA_def_property_enum_funcs(prop, "rna_Image_file_format_get", "rna_Image_file_format_set", NULL);
536         RNA_def_property_ui_text(prop, "File Format", "Format used for re-saving this file");
537
538         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
539         RNA_def_property_enum_items(prop, image_source_items);
540         RNA_def_property_enum_funcs(prop, NULL, "rna_Image_source_set", "rna_Image_source_itemf");
541         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
542         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
543
544         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
545         RNA_def_property_enum_items(prop, prop_type_items);
546         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
547         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
548         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
549
550         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
551         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
552         RNA_def_property_ui_text(prop, "Packed File", "");
553         
554         prop = RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
555         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
556         RNA_def_property_enum_items(prop, prop_field_order_items);
557         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
558         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
559         
560         /* booleans */
561         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
562         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
563         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
564         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
565         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
566         
567
568         prop = RNA_def_property(srna, "use_view_as_render", PROP_BOOLEAN, PROP_NONE);
569         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_VIEW_AS_RENDER);
570         RNA_def_property_ui_text(prop, "View as Render", "Apply render part of display transformation when displaying this image on the screen");
571         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
572
573         prop = RNA_def_property(srna, "use_alpha", PROP_BOOLEAN, PROP_NONE);
574         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", IMA_IGNORE_ALPHA);
575         RNA_def_property_ui_text(prop, "Use Alpha", "Use the alpha channel information from the image or make image fully opaque");
576         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
577
578         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
579         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
580         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
581         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
582
583         /* generated image (image_generated_change_cb) */
584         prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
585         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
586         RNA_def_property_enum_items(prop, image_generated_type_items);
587         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
588         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
589         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
590         
591         prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
592         RNA_def_property_int_sdna(prop, NULL, "gen_x");
593         RNA_def_property_range(prop, 1, 65536);
594         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
595         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
596         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
597         
598         prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
599         RNA_def_property_int_sdna(prop, NULL, "gen_y");
600         RNA_def_property_range(prop, 1, 65536);
601         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
602         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
603         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
604         
605         prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
606         RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
607         RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating point buffer");
608         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
609         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
610
611         /* realtime properties */
612         prop = RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
613         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
614         RNA_def_property_enum_items(prop, prop_mapping_items);
615         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
616         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
617
618         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
619         RNA_def_property_float_sdna(prop, NULL, "aspx");
620         RNA_def_property_array(prop, 2);
621         RNA_def_property_range(prop, 0.1f, FLT_MAX);
622         RNA_def_property_ui_range(prop, 0.1f, 5000.f, 1, 2);
623         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
624         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
625
626         prop = RNA_def_property(srna, "use_animation", PROP_BOOLEAN, PROP_NONE);
627         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
628         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
629         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
630
631         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
632         RNA_def_property_int_sdna(prop, NULL, "twsta");
633         RNA_def_property_range(prop, 0, 128);
634         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
635         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
636
637         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_NONE);
638         RNA_def_property_int_sdna(prop, NULL, "twend");
639         RNA_def_property_range(prop, 0, 128);
640         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
641         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
642
643         prop = RNA_def_property(srna, "fps", PROP_INT, PROP_NONE);
644         RNA_def_property_int_sdna(prop, NULL, "animspeed");
645         RNA_def_property_range(prop, 1, 100);
646         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
647         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
648
649         prop = RNA_def_property(srna, "use_tiles", PROP_BOOLEAN, PROP_NONE);
650         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
651         RNA_def_property_ui_text(prop, "Tiles",
652                                  "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
653         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
654
655         prop = RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
656         RNA_def_property_int_sdna(prop, NULL, "xrep");
657         RNA_def_property_range(prop, 1, 16);
658         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
659         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
660
661         prop = RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
662         RNA_def_property_int_sdna(prop, NULL, "yrep");
663         RNA_def_property_range(prop, 1, 16);
664         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
665         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
666
667         prop = RNA_def_property(srna, "use_clamp_x", PROP_BOOLEAN, PROP_NONE);
668         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
669         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
670         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
671
672         prop = RNA_def_property(srna, "use_clamp_y", PROP_BOOLEAN, PROP_NONE);
673         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
674         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
675         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
676
677         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
678         RNA_def_property_int_sdna(prop, NULL, "bindcode");
679         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
680         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
681         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
682
683         prop = RNA_def_property(srna, "render_slot", PROP_INT, PROP_UNSIGNED);
684         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT - 1);
685         RNA_def_property_ui_text(prop, "Render Slot", "The current render slot displayed, only for viewer type images");
686         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
687
688         /*
689          * Image.has_data and Image.depth are temporary,
690          * Update import_obj.py when they are replaced (Arystan)
691          */
692         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
693         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
694         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
695         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
696
697         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
698         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
699         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
700         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
701
702         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
703                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
704         RNA_def_property_subtype(prop, PROP_PIXEL);
705         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
706         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
707
708         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
709         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
710
711         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
712         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
713         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
714         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
715
716         /* NOTE about pixels/channels/is_floa:
717          * this properties describes how image is stored internally (inside of ImBuf),
718          * not how it was saved to disk or how it'll be saved on disk
719          */
720         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
721         RNA_def_property_flag(prop, PROP_DYNAMIC);
722         RNA_def_property_multi_array(prop, 1, NULL);
723         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
724         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
725         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
726
727         prop = RNA_def_property(srna, "channels", PROP_INT, PROP_UNSIGNED);
728         RNA_def_property_int_funcs(prop, "rna_Image_channels_get", NULL, NULL);
729         RNA_def_property_ui_text(prop, "Channels", "Number of channels in pixels buffer");
730         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
731
732         prop = RNA_def_property(srna, "is_float", PROP_BOOLEAN, PROP_NONE);
733         RNA_def_property_boolean_funcs(prop, "rna_Image_is_float_get", NULL);
734         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
735         RNA_def_property_ui_text(prop, "Is Float", "True if this image is stored in float buffer");
736
737         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
738         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
739         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
740         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
741
742         prop = RNA_def_property(srna, "alpha_mode", PROP_ENUM, PROP_NONE);
743         RNA_def_property_enum_items(prop, alpha_mode_items);
744         RNA_def_property_ui_text(prop, "Alpha Mode", "Representation of alpha information in the RGBA pixels");
745         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
746
747         RNA_api_image(srna);
748 }
749
750 void RNA_def_image(BlenderRNA *brna)
751 {
752         rna_def_image(brna);
753         rna_def_imageuser(brna);
754 }
755
756 #endif