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