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