Merging r50147 through r50148 from trunk into soc-2011-tomato
[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
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31 #include "RNA_enum_types.h"
32
33 #include "rna_internal.h"
34
35 #include "DNA_image_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "BKE_context.h"
39 #include "BKE_depsgraph.h"
40 #include "BKE_image.h"
41
42 #include "WM_types.h"
43 #include "WM_api.h"
44
45 static EnumPropertyItem image_source_items[] = {
46         {IMA_SRC_FILE, "FILE", 0, "Single Image", "Single image file"},
47         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
48         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
49         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
50         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
51         {0, NULL, 0, NULL, NULL}
52 };
53
54 #ifdef RNA_RUNTIME
55
56 #include "IMB_imbuf.h"
57 #include "IMB_imbuf_types.h"
58
59 static void rna_Image_animated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
60 {
61         Image *ima = (Image *)ptr->data;
62         int nr;
63
64         if (ima->flag & IMA_TWINANIM) {
65                 nr = ima->xrep * ima->yrep;
66                 if (ima->twsta >= nr) ima->twsta = 1;
67                 if (ima->twend >= nr) ima->twend = nr - 1;
68                 if (ima->twsta > ima->twend) ima->twsta = 1;
69         }
70 }
71
72 static int rna_Image_dirty_get(PointerRNA *ptr)
73 {
74         Image *ima = (Image *)ptr->data;
75         ImBuf *ibuf;
76
77         for (ibuf = ima->ibufs.first; ibuf; ibuf = ibuf->next)
78                 if (ibuf->userflags & IB_BITMAPDIRTY)
79                         return 1;
80         
81         return 0;
82 }
83
84 static void rna_Image_source_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
85 {
86         Image *ima = ptr->id.data;
87         BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
88         DAG_id_tag_update(&ima->id, 0);
89 }
90
91 static void rna_Image_fields_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
92 {
93         Image *ima = ptr->id.data;
94         ImBuf *ibuf;
95         void *lock;
96
97         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
98
99         if (ibuf) {
100                 short nr = 0;
101
102                 if (!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr = 1;
103                 if ((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr = 1;
104
105                 if (nr)
106                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
107         }
108
109         BKE_image_release_ibuf(ima, lock);
110 }
111
112 static void rna_Image_free_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
113 {
114         Image *ima = ptr->id.data;
115         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
116         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
117         DAG_id_tag_update(&ima->id, 0);
118 }
119
120
121 static void rna_Image_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
122 {
123         Image *ima = ptr->id.data;
124         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
125         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
126         DAG_id_tag_update(&ima->id, 0);
127 }
128
129 static void rna_Image_generated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
130 {
131         Image *ima = ptr->id.data;
132         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
133 }
134
135 static void rna_ImageUser_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
136 {
137         ImageUser *iuser = ptr->data;
138
139         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
140 }
141
142
143 char *rna_ImageUser_path(PointerRNA *ptr)
144 {
145         if (ptr->id.data) {
146                 /* ImageUser *iuser= ptr->data; */
147                 
148                 switch (GS(((ID *)ptr->id.data)->name)) {
149                         case ID_TE:
150                                 return BLI_strdup("image_user");
151                 }
152         }
153         
154         return BLI_strdup("");
155 }
156
157 static EnumPropertyItem *rna_Image_source_itemf(bContext *UNUSED(C), PointerRNA *ptr,
158                                                 PropertyRNA *UNUSED(prop), int *free)
159 {
160         Image *ima = (Image *)ptr->data;
161         EnumPropertyItem *item = NULL;
162         int totitem = 0;
163         
164         if (ima->source == IMA_SRC_VIEWER) {
165                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
166         }
167         else {
168                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
169                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
170                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
171                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
172         }
173
174         RNA_enum_item_end(&item, &totitem);
175         *free = 1;
176
177         return item;
178 }
179
180 static int rna_Image_file_format_get(PointerRNA *ptr)
181 {
182         Image *image = (Image *)ptr->data;
183         ImBuf *ibuf = BKE_image_get_ibuf(image, NULL);
184         return BKE_ftype_to_imtype(ibuf ? ibuf->ftype : 0);
185 }
186
187 static void rna_Image_file_format_set(PointerRNA *ptr, int value)
188 {
189         Image *image = (Image *)ptr->data;
190         if (BKE_imtype_is_movie(value) == 0) { /* should be able to throw an error here */
191                 ImBuf *ibuf;
192                 int ftype = BKE_imtype_to_ftype(value);
193
194 #if 0
195                 ibuf = BKE_image_get_ibuf(image, NULL);
196                 if (ibuf)
197                         ibuf->ftype = ftype;
198 #endif
199
200                 /* to be safe change all buffer file types */
201                 for (ibuf = image->ibufs.first; ibuf; ibuf = ibuf->next) {
202                         ibuf->ftype = ftype;
203                 }
204         }
205 }
206
207 static int rna_Image_has_data_get(PointerRNA *ptr)
208 {
209         Image *im = (Image *)ptr->data;
210
211         if (im->ibufs.first)
212                 return 1;
213
214         return 0;
215 }
216
217 static void rna_Image_size_get(PointerRNA *ptr, int *values)
218 {
219         Image *im = (Image *)ptr->data;
220         ImBuf *ibuf;
221         void *lock;
222
223         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
224         if (ibuf) {
225                 values[0] = ibuf->x;
226                 values[1] = ibuf->y;
227         }
228         else {
229                 values[0] = 0;
230                 values[1] = 0;
231         }
232
233         BKE_image_release_ibuf(im, lock);
234 }
235
236 static void rna_Image_resolution_get(PointerRNA *ptr, float *values)
237 {
238         Image *im = (Image *)ptr->data;
239         ImBuf *ibuf;
240         void *lock;
241
242         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
243         if (ibuf) {
244                 values[0] = ibuf->ppm[0];
245                 values[1] = ibuf->ppm[1];
246         }
247         else {
248                 values[0] = 0;
249                 values[1] = 0;
250         }
251
252         BKE_image_release_ibuf(im, lock);
253 }
254
255 static void rna_Image_resolution_set(PointerRNA *ptr, const float *values)
256 {
257         Image *im = (Image *)ptr->data;
258         ImBuf *ibuf;
259         void *lock;
260
261         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
262         if (ibuf) {
263                 ibuf->ppm[0] = values[0];
264                 ibuf->ppm[1] = values[1];
265         }
266
267         BKE_image_release_ibuf(im, lock);
268 }
269
270 static int rna_Image_depth_get(PointerRNA *ptr)
271 {
272         Image *im = (Image *)ptr->data;
273         ImBuf *ibuf;
274         void *lock;
275         int planes;
276         
277         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
278
279         if (!ibuf)
280                 planes = 0;
281         else if (ibuf->rect_float)
282                 planes = ibuf->planes * 4;
283         else
284                 planes = ibuf->planes;
285
286         BKE_image_release_ibuf(im, lock);
287
288         return planes;
289 }
290
291 static int rna_Image_frame_duration_get(PointerRNA *ptr)
292 {
293         Image *im = (Image *)ptr->data;
294
295         if (im->anim)
296                 return IMB_anim_get_duration(im->anim, IMB_TC_RECORD_RUN);
297         return 1;
298 }
299
300 static int rna_Image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
301 {
302         Image *ima = ptr->id.data;
303         ImBuf *ibuf;
304         void *lock;
305
306         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
307
308         if (ibuf)
309                 length[0] = ibuf->x * ibuf->y * ibuf->channels;
310         else
311                 length[0] = 0;
312
313         BKE_image_release_ibuf(ima, lock);
314
315         return length[0];
316 }
317
318 static void rna_Image_pixels_get(PointerRNA *ptr, float *values)
319 {
320         Image *ima = ptr->id.data;
321         ImBuf *ibuf;
322         void *lock;
323         int i, size;
324
325         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
326
327         if (ibuf) {
328                 size = ibuf->x * ibuf->y * ibuf->channels;
329
330                 if (ibuf->rect_float) {
331                         memcpy(values, ibuf->rect_float, sizeof(float) * size);
332                 }
333                 else {
334                         for (i = 0; i < size; i++)
335                                 values[i] = ((unsigned char *)ibuf->rect)[i] * (1.0f / 255.0f);
336                 }
337         }
338
339         BKE_image_release_ibuf(ima, lock);
340 }
341
342 static void rna_Image_pixels_set(PointerRNA *ptr, const float *values)
343 {
344         Image *ima = ptr->id.data;
345         ImBuf *ibuf;
346         void *lock;
347         int i, size;
348
349         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
350
351         if (ibuf) {
352                 size = ibuf->x * ibuf->y * ibuf->channels;
353
354                 if (ibuf->rect_float) {
355                         memcpy(ibuf->rect_float, values, sizeof(float) * size);
356                 }
357                 else {
358                         for (i = 0; i < size; i++)
359                                 ((unsigned char *)ibuf->rect)[i] = FTOCHAR(values[i]);
360                 }
361
362                 ibuf->userflags |= IB_BITMAPDIRTY;
363         }
364
365         BKE_image_release_ibuf(ima, lock);
366 }
367
368 #else
369
370 static void rna_def_imageuser(BlenderRNA *brna)
371 {
372         StructRNA *srna;
373         PropertyRNA *prop;
374
375         srna = RNA_def_struct(brna, "ImageUser", NULL);
376         RNA_def_struct_ui_text(srna, "Image User",
377                                "Parameters defining how an Image datablock is used by another datablock");
378         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
379
380         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
381         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
382         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
383         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
384
385         /* animation */
386         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
387         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
388         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
389         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
390
391         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
392         RNA_def_property_int_sdna(prop, NULL, "frames");
393         RNA_def_property_range(prop, 0, MAXFRAMEF);
394         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
395         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
396
397         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
398         RNA_def_property_int_sdna(prop, NULL, "offset");
399         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
400         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
401         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
402
403         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
404         RNA_def_property_int_sdna(prop, NULL, "sfra");
405         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
406         RNA_def_property_ui_text(prop, "Start Frame",
407                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
408         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
409
410         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
411         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
412         RNA_def_property_range(prop, 1, 200);
413         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
414         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
415
416         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
417         RNA_def_property_int_sdna(prop, NULL, "layer");
418         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
419         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
420
421         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
422         RNA_def_property_int_sdna(prop, NULL, "pass");
423         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
424         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
425 }
426
427 static void rna_def_image(BlenderRNA *brna)
428 {
429         StructRNA *srna;
430         PropertyRNA *prop;
431         static const EnumPropertyItem prop_type_items[] = {
432                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
433                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
434                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
435                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
436                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
437                 {0, NULL, 0, NULL, NULL}
438         };
439         static const EnumPropertyItem prop_generated_type_items[] = {
440                 {0, "BLANK", 0, "Blank", "Generate a blank image"},
441                 {1, "UV_GRID", 0, "UV Grid", "Generated grid to test UV mappings"},
442                 {2, "COLOR_GRID", 0, "Color Grid", "Generated improved UV grid to test UV mappings"},
443                 {0, NULL, 0, NULL, NULL}
444         };
445         static const EnumPropertyItem prop_mapping_items[] = {
446                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
447                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
448                 {0, NULL, 0, NULL, NULL}
449         };
450         static const EnumPropertyItem prop_field_order_items[] = {
451                 {0, "EVEN", 0, "Upper First", "Upper field first"},
452                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
453                 {0, NULL, 0, NULL, NULL}
454         };
455
456         srna = RNA_def_struct(brna, "Image", "ID");
457         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image");
458         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
459
460         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
461         RNA_def_property_string_sdna(prop, NULL, "name");
462         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name");
463         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
464
465         /* eek. this is horrible but needed so we can save to a new name without blanking the data :( */
466         prop = RNA_def_property(srna, "filepath_raw", PROP_STRING, PROP_FILEPATH);
467         RNA_def_property_string_sdna(prop, NULL, "name");
468         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name (without data refreshing)");
469
470         prop = RNA_def_property(srna, "file_format", PROP_ENUM, PROP_NONE);
471         RNA_def_property_enum_items(prop, image_type_items);
472         RNA_def_property_enum_funcs(prop, "rna_Image_file_format_get", "rna_Image_file_format_set", NULL);
473         RNA_def_property_ui_text(prop, "File Format", "Format used for re-saving this file");
474
475         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
476         RNA_def_property_enum_items(prop, image_source_items);
477         RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Image_source_itemf");
478         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
479         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_source_update");
480
481         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
482         RNA_def_property_enum_items(prop, prop_type_items);
483         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
484         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
485         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
486
487         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
488         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
489         RNA_def_property_ui_text(prop, "Packed File", "");
490         
491         prop = RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
492         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
493         RNA_def_property_enum_items(prop, prop_field_order_items);
494         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
495         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
496         
497         /* booleans */
498         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
499         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
500         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
501         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
502
503         prop = RNA_def_property(srna, "use_premultiply", PROP_BOOLEAN, PROP_NONE);
504         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DO_PREMUL);
505         RNA_def_property_ui_text(prop, "Premultiply", "Convert RGB from key alpha to premultiplied alpha");
506         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_free_update");
507         
508         prop = RNA_def_property(srna, "use_color_unpremultiply", PROP_BOOLEAN, PROP_NONE);
509         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_CM_PREDIVIDE);
510         RNA_def_property_ui_text(prop, "Color Unpremultiply",
511                                  "For premultiplied alpha images, do color space conversion on colors without alpha, "
512                                  "to avoid fringing for images with light backgrounds");
513         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_free_update");
514
515         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
516         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
517         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
518         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
519
520         /* generated image (image_generated_change_cb) */
521         prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
522         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
523         RNA_def_property_enum_items(prop, prop_generated_type_items);
524         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
525         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
526
527         prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
528         RNA_def_property_int_sdna(prop, NULL, "gen_x");
529         RNA_def_property_range(prop, 1, 16384);
530         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
531         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
532
533         prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
534         RNA_def_property_int_sdna(prop, NULL, "gen_y");
535         RNA_def_property_range(prop, 1, 16384);
536         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
537         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
538
539         prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
540         RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
541         RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating point buffer");
542         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
543
544         /* realtime properties */
545         prop = RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
546         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
547         RNA_def_property_enum_items(prop, prop_mapping_items);
548         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
549         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
550
551         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
552         RNA_def_property_float_sdna(prop, NULL, "aspx");
553         RNA_def_property_array(prop, 2);
554         RNA_def_property_range(prop, 0.1f, 5000.0f);
555         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
556         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
557
558         prop = RNA_def_property(srna, "use_animation", PROP_BOOLEAN, PROP_NONE);
559         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
560         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
561         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
562
563         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
564         RNA_def_property_int_sdna(prop, NULL, "twsta");
565         RNA_def_property_range(prop, 0, 128);
566         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
567         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
568
569         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_NONE);
570         RNA_def_property_int_sdna(prop, NULL, "twend");
571         RNA_def_property_range(prop, 0, 128);
572         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
573         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
574
575         prop = RNA_def_property(srna, "fps", PROP_INT, PROP_NONE);
576         RNA_def_property_int_sdna(prop, NULL, "animspeed");
577         RNA_def_property_range(prop, 1, 100);
578         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
579         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
580
581         prop = RNA_def_property(srna, "use_tiles", PROP_BOOLEAN, PROP_NONE);
582         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
583         RNA_def_property_ui_text(prop, "Tiles",
584                                  "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
585         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
586
587         prop = RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
588         RNA_def_property_int_sdna(prop, NULL, "xrep");
589         RNA_def_property_range(prop, 1, 16);
590         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
591         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
592
593         prop = RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
594         RNA_def_property_int_sdna(prop, NULL, "yrep");
595         RNA_def_property_range(prop, 1, 16);
596         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
597         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
598
599         prop = RNA_def_property(srna, "use_clamp_x", PROP_BOOLEAN, PROP_NONE);
600         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
601         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
602         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
603
604         prop = RNA_def_property(srna, "use_clamp_y", PROP_BOOLEAN, PROP_NONE);
605         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
606         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
607         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
608
609         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
610         RNA_def_property_int_sdna(prop, NULL, "bindcode");
611         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
612         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
613         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
614
615         prop = RNA_def_property(srna, "render_slot", PROP_INT, PROP_UNSIGNED);
616         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT - 1);
617         RNA_def_property_ui_text(prop, "Render Slot", "The current render slot displayed, only for viewer type images");
618         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
619
620         /*
621          * Image.has_data and Image.depth are temporary,
622          * Update import_obj.py when they are replaced (Arystan)
623          */
624         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
625         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
626         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
627         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
628
629         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
630         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
631         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
632         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
633
634         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
635                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
636         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
637         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
638
639         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
640         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
641
642         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
643         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
644         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
645         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
646
647         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
648         RNA_def_property_flag(prop, PROP_DYNAMIC);
649         RNA_def_property_multi_array(prop, 1, NULL);
650         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
651         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
652         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
653
654         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
655         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
656         RNA_def_property_struct_type(prop, "ColorManagedColorspaceSettings");
657         RNA_def_property_ui_text(prop, "Colorspace Settings", "Input color space settings");
658
659         RNA_api_image(srna);
660 }
661
662 void RNA_def_image(BlenderRNA *brna)
663 {
664         rna_def_image(brna);
665         rna_def_imageuser(brna);
666 }
667
668 #endif