use bool for rna funcs.
[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                                 return BLI_strdup("image_user");
163                 }
164         }
165         
166         return BLI_strdup("");
167 }
168
169 static EnumPropertyItem *rna_Image_source_itemf(bContext *UNUSED(C), PointerRNA *ptr,
170                                                 PropertyRNA *UNUSED(prop), int *free)
171 {
172         Image *ima = (Image *)ptr->data;
173         EnumPropertyItem *item = NULL;
174         int totitem = 0;
175         
176         if (ima->source == IMA_SRC_VIEWER) {
177                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
178         }
179         else {
180                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
181                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
182                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
183                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
184         }
185
186         RNA_enum_item_end(&item, &totitem);
187         *free = 1;
188
189         return item;
190 }
191
192 static int rna_Image_file_format_get(PointerRNA *ptr)
193 {
194         Image *image = (Image *)ptr->data;
195         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
196         int imtype = BKE_ftype_to_imtype(ibuf ? ibuf->ftype : 0);
197
198         BKE_image_release_ibuf(image, ibuf, NULL);
199
200         return imtype;
201 }
202
203 static void rna_Image_file_format_set(PointerRNA *ptr, int value)
204 {
205         Image *image = (Image *)ptr->data;
206         if (BKE_imtype_is_movie(value) == 0) { /* should be able to throw an error here */
207                 ImBuf *ibuf;
208                 int ftype = BKE_imtype_to_ftype(value);
209
210 #if 0
211                 ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
212                 if (ibuf)
213                         ibuf->ftype = ftype;
214 #endif
215
216                 /* to be safe change all buffer file types */
217                 /* TODO: this is never threadsafe */
218                 for (ibuf = image->ibufs.first; ibuf; ibuf = ibuf->next) {
219                         ibuf->ftype = ftype;
220                 }
221         }
222 }
223
224 static int rna_Image_has_data_get(PointerRNA *ptr)
225 {
226         Image *im = (Image *)ptr->data;
227
228         if (im->ibufs.first)
229                 return 1;
230
231         return 0;
232 }
233
234 static void rna_Image_size_get(PointerRNA *ptr, int *values)
235 {
236         Image *im = (Image *)ptr->data;
237         ImBuf *ibuf;
238         void *lock;
239
240         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
241         if (ibuf) {
242                 values[0] = ibuf->x;
243                 values[1] = ibuf->y;
244         }
245         else {
246                 values[0] = 0;
247                 values[1] = 0;
248         }
249
250         BKE_image_release_ibuf(im, ibuf, lock);
251 }
252
253 static void rna_Image_resolution_get(PointerRNA *ptr, float *values)
254 {
255         Image *im = (Image *)ptr->data;
256         ImBuf *ibuf;
257         void *lock;
258
259         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
260         if (ibuf) {
261                 values[0] = ibuf->ppm[0];
262                 values[1] = ibuf->ppm[1];
263         }
264         else {
265                 values[0] = 0;
266                 values[1] = 0;
267         }
268
269         BKE_image_release_ibuf(im, ibuf, lock);
270 }
271
272 static void rna_Image_resolution_set(PointerRNA *ptr, const float *values)
273 {
274         Image *im = (Image *)ptr->data;
275         ImBuf *ibuf;
276         void *lock;
277
278         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
279         if (ibuf) {
280                 ibuf->ppm[0] = values[0];
281                 ibuf->ppm[1] = values[1];
282         }
283
284         BKE_image_release_ibuf(im, ibuf, lock);
285 }
286
287 static int rna_Image_depth_get(PointerRNA *ptr)
288 {
289         Image *im = (Image *)ptr->data;
290         ImBuf *ibuf;
291         void *lock;
292         int planes;
293         
294         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
295
296         if (!ibuf)
297                 planes = 0;
298         else if (ibuf->rect_float)
299                 planes = ibuf->planes * 4;
300         else
301                 planes = ibuf->planes;
302
303         BKE_image_release_ibuf(im, ibuf, lock);
304
305         return planes;
306 }
307
308 static int rna_Image_frame_duration_get(PointerRNA *ptr)
309 {
310         Image *im = (Image *)ptr->data;
311
312         if (im->anim)
313                 return IMB_anim_get_duration(im->anim, IMB_TC_RECORD_RUN);
314         return 1;
315 }
316
317 static int rna_Image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
318 {
319         Image *ima = ptr->id.data;
320         ImBuf *ibuf;
321         void *lock;
322
323         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
324
325         if (ibuf)
326                 length[0] = ibuf->x * ibuf->y * ibuf->channels;
327         else
328                 length[0] = 0;
329
330         BKE_image_release_ibuf(ima, ibuf, lock);
331
332         return length[0];
333 }
334
335 static void rna_Image_pixels_get(PointerRNA *ptr, float *values)
336 {
337         Image *ima = ptr->id.data;
338         ImBuf *ibuf;
339         void *lock;
340         int i, size;
341
342         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
343
344         if (ibuf) {
345                 size = ibuf->x * ibuf->y * ibuf->channels;
346
347                 if (ibuf->rect_float) {
348                         memcpy(values, ibuf->rect_float, sizeof(float) * size);
349                 }
350                 else {
351                         for (i = 0; i < size; i++)
352                                 values[i] = ((unsigned char *)ibuf->rect)[i] * (1.0f / 255.0f);
353                 }
354         }
355
356         BKE_image_release_ibuf(ima, ibuf, lock);
357 }
358
359 static void rna_Image_pixels_set(PointerRNA *ptr, const float *values)
360 {
361         Image *ima = ptr->id.data;
362         ImBuf *ibuf;
363         void *lock;
364         int i, size;
365
366         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
367
368         if (ibuf) {
369                 size = ibuf->x * ibuf->y * ibuf->channels;
370
371                 if (ibuf->rect_float) {
372                         memcpy(ibuf->rect_float, values, sizeof(float) * size);
373                 }
374                 else {
375                         for (i = 0; i < size; i++)
376                                 ((unsigned char *)ibuf->rect)[i] = FTOCHAR(values[i]);
377                 }
378
379                 ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID;
380         }
381
382         BKE_image_release_ibuf(ima, ibuf, lock);
383 }
384
385 static int rna_Image_channels_get(PointerRNA *ptr)
386 {
387         Image *im = (Image *)ptr->data;
388         ImBuf *ibuf;
389         void *lock;
390         int channels = 0;
391
392         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
393         if (ibuf)
394                 channels = ibuf->channels;
395
396         BKE_image_release_ibuf(im, ibuf, lock);
397
398         return channels;
399 }
400
401 static int rna_Image_is_float_get(PointerRNA *ptr)
402 {
403         Image *im = (Image *)ptr->data;
404         ImBuf *ibuf;
405         void *lock;
406         int is_float = FALSE;
407
408         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
409         if (ibuf)
410                 is_float = ibuf->rect_float != NULL;
411
412         BKE_image_release_ibuf(im, ibuf, lock);
413
414         return is_float;
415 }
416
417 #else
418
419 static void rna_def_imageuser(BlenderRNA *brna)
420 {
421         StructRNA *srna;
422         PropertyRNA *prop;
423
424         srna = RNA_def_struct(brna, "ImageUser", NULL);
425         RNA_def_struct_ui_text(srna, "Image User",
426                                "Parameters defining how an Image datablock is used by another datablock");
427         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
428
429         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
430         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
431         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
432         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
433         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
434
435         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
436         RNA_def_property_int_sdna(prop, NULL, "framenr");
437         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
438         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in image sequence or movie");
439
440         /* animation */
441         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
442         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
443         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
444         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
445         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
446
447         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
448         RNA_def_property_int_sdna(prop, NULL, "frames");
449         RNA_def_property_range(prop, 0, MAXFRAMEF);
450         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
451         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
452         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
453
454         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
455         RNA_def_property_int_sdna(prop, NULL, "offset");
456         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
457         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
458
459         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
460         RNA_def_property_int_sdna(prop, NULL, "sfra");
461         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
462         RNA_def_property_ui_text(prop, "Start Frame",
463                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
464         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
465         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
466
467         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
468         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
469         RNA_def_property_range(prop, 1, 200);
470         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
471         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
472         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
473
474         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
475         RNA_def_property_int_sdna(prop, NULL, "layer");
476         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
477         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
478
479         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
480         RNA_def_property_int_sdna(prop, NULL, "pass");
481         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
482         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
483 }
484
485 static void rna_def_image(BlenderRNA *brna)
486 {
487         StructRNA *srna;
488         PropertyRNA *prop;
489         static const EnumPropertyItem prop_type_items[] = {
490                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
491                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
492                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
493                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
494                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
495                 {0, NULL, 0, NULL, NULL}
496         };
497         static const EnumPropertyItem prop_mapping_items[] = {
498                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
499                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
500                 {0, NULL, 0, NULL, NULL}
501         };
502         static const EnumPropertyItem prop_field_order_items[] = {
503                 {0, "EVEN", 0, "Upper First", "Upper field first"},
504                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
505                 {0, NULL, 0, NULL, NULL}
506         };
507         static const EnumPropertyItem alpha_mode_items[] = {
508                 {IMA_ALPHA_STRAIGHT, "STRAIGHT", 0, "Straight", "Transparent RGB and alpha pixels are unmodified"},
509                 {IMA_ALPHA_PREMUL, "PREMUL", 0, "Premultiplied", "Transparent RGB pixels are multiplied by the alpha channel"},
510                 {0, NULL, 0, NULL, NULL}
511         };
512
513         srna = RNA_def_struct(brna, "Image", "ID");
514         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image");
515         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
516
517         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
518         RNA_def_property_string_sdna(prop, NULL, "name");
519         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name");
520         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
521
522         /* eek. this is horrible but needed so we can save to a new name without blanking the data :( */
523         prop = RNA_def_property(srna, "filepath_raw", 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 (without data refreshing)");
526
527         prop = RNA_def_property(srna, "file_format", PROP_ENUM, PROP_NONE);
528         RNA_def_property_enum_items(prop, image_type_items);
529         RNA_def_property_enum_funcs(prop, "rna_Image_file_format_get", "rna_Image_file_format_set", NULL);
530         RNA_def_property_ui_text(prop, "File Format", "Format used for re-saving this file");
531
532         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
533         RNA_def_property_enum_items(prop, image_source_items);
534         RNA_def_property_enum_funcs(prop, NULL, "rna_Image_source_set", "rna_Image_source_itemf");
535         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
536         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
537
538         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
539         RNA_def_property_enum_items(prop, prop_type_items);
540         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
541         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
542         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
543
544         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
545         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
546         RNA_def_property_ui_text(prop, "Packed File", "");
547         
548         prop = RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
549         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
550         RNA_def_property_enum_items(prop, prop_field_order_items);
551         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
552         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
553         
554         /* booleans */
555         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
556         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
557         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
558         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
559         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
560         
561
562         prop = RNA_def_property(srna, "view_as_render", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_VIEW_AS_RENDER);
564         RNA_def_property_ui_text(prop, "View as Render", "Apply render part of display transformation when displaying this image on the screen");
565         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
566
567         prop = RNA_def_property(srna, "use_alpha", PROP_BOOLEAN, PROP_NONE);
568         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", IMA_IGNORE_ALPHA);
569         RNA_def_property_ui_text(prop, "Use Alpha", "Use the alpha channel information from the image or make image fully opaque");
570         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
571
572         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
574         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
575         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
576
577         /* generated image (image_generated_change_cb) */
578         prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
579         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
580         RNA_def_property_enum_items(prop, image_generated_type_items);
581         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
582         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
583         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
584         
585         prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
586         RNA_def_property_int_sdna(prop, NULL, "gen_x");
587         RNA_def_property_range(prop, 1, 65536);
588         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
589         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
590         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
591         
592         prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
593         RNA_def_property_int_sdna(prop, NULL, "gen_y");
594         RNA_def_property_range(prop, 1, 65536);
595         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
596         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
597         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
598         
599         prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
600         RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
601         RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating point buffer");
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         /* realtime properties */
606         prop = RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
607         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
608         RNA_def_property_enum_items(prop, prop_mapping_items);
609         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
610         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
611
612         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
613         RNA_def_property_float_sdna(prop, NULL, "aspx");
614         RNA_def_property_array(prop, 2);
615         RNA_def_property_range(prop, 0.1f, 5000.0f);
616         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
617         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
618
619         prop = RNA_def_property(srna, "use_animation", PROP_BOOLEAN, PROP_NONE);
620         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
621         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
622         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
623
624         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
625         RNA_def_property_int_sdna(prop, NULL, "twsta");
626         RNA_def_property_range(prop, 0, 128);
627         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
628         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
629
630         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_NONE);
631         RNA_def_property_int_sdna(prop, NULL, "twend");
632         RNA_def_property_range(prop, 0, 128);
633         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
634         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
635
636         prop = RNA_def_property(srna, "fps", PROP_INT, PROP_NONE);
637         RNA_def_property_int_sdna(prop, NULL, "animspeed");
638         RNA_def_property_range(prop, 1, 100);
639         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
640         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
641
642         prop = RNA_def_property(srna, "use_tiles", PROP_BOOLEAN, PROP_NONE);
643         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
644         RNA_def_property_ui_text(prop, "Tiles",
645                                  "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
646         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
647
648         prop = RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
649         RNA_def_property_int_sdna(prop, NULL, "xrep");
650         RNA_def_property_range(prop, 1, 16);
651         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
652         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
653
654         prop = RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
655         RNA_def_property_int_sdna(prop, NULL, "yrep");
656         RNA_def_property_range(prop, 1, 16);
657         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
658         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
659
660         prop = RNA_def_property(srna, "use_clamp_x", PROP_BOOLEAN, PROP_NONE);
661         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
662         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
663         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
664
665         prop = RNA_def_property(srna, "use_clamp_y", PROP_BOOLEAN, PROP_NONE);
666         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
667         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
668         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
669
670         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
671         RNA_def_property_int_sdna(prop, NULL, "bindcode");
672         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
673         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
674         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
675
676         prop = RNA_def_property(srna, "render_slot", PROP_INT, PROP_UNSIGNED);
677         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT - 1);
678         RNA_def_property_ui_text(prop, "Render Slot", "The current render slot displayed, only for viewer type images");
679         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
680
681         /*
682          * Image.has_data and Image.depth are temporary,
683          * Update import_obj.py when they are replaced (Arystan)
684          */
685         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
686         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
687         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
688         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
689
690         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
691         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
692         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
693         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
694
695         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
696                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
697         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
698         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
699
700         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
701         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
702
703         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
704         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
705         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
706         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
707
708         /* NOTE about pixels/channels/is_floa:
709          * this properties describes how image is stored internally (inside of ImBuf),
710          * not how it was saved to disk or how it'll be saved on disk
711          */
712         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
713         RNA_def_property_flag(prop, PROP_DYNAMIC);
714         RNA_def_property_multi_array(prop, 1, NULL);
715         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
716         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
717         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
718
719         prop = RNA_def_property(srna, "channels", PROP_INT, PROP_UNSIGNED);
720         RNA_def_property_int_funcs(prop, "rna_Image_channels_get", NULL, NULL);
721         RNA_def_property_ui_text(prop, "Channels", "Number of channels in pixels buffer");
722         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
723
724         prop = RNA_def_property(srna, "is_float", PROP_BOOLEAN, PROP_NONE);
725         RNA_def_property_boolean_funcs(prop, "rna_Image_is_float_get", NULL);
726         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
727         RNA_def_property_ui_text(prop, "Is Float", "True if this image is stored in float buffer");
728
729         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
730         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
731         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
732         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
733
734         prop = RNA_def_property(srna, "alpha_mode", PROP_ENUM, PROP_NONE);
735         RNA_def_property_enum_items(prop, alpha_mode_items);
736         RNA_def_property_ui_text(prop, "Alpha Mode", "Representation of alpha information in the RGBA pixels");
737         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
738
739         RNA_api_image(srna);
740 }
741
742 void RNA_def_image(BlenderRNA *brna)
743 {
744         rna_def_image(brna);
745         rna_def_imageuser(brna);
746 }
747
748 #endif