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