fc8807d0f7cfc831e129401acbb5132be0280368
[blender.git] / source / blender / makesdna / DNA_image_types.h
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_image_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef DNA_IMAGE_TYPES_H
33 #define DNA_IMAGE_TYPES_H
34
35 #include "DNA_ID.h"
36
37 struct PackedFile;
38 struct Scene;
39 struct anim;
40 struct ImBuf;
41 struct RenderResult;
42 struct GPUTexture;
43
44
45 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
46 /* should be used in conjunction with an ID * to Image. */
47 typedef struct ImageUser {
48         struct Scene *scene;            /* to retrieve render result */
49
50         int framenr;                            /* movies, sequences: current to display */
51         int frames;                                     /* total amount of frames to use */
52         int offset, sfra;                       /* offset within movie, start frame in global time */
53         char fie_ima, cycl;             /* fields/image in movie, cyclic flag */
54         char ok, pad;
55
56         short multi_index, layer, pass;  /* listbase indices, for menu browsing or retrieve buffer */
57
58         short flag;
59         
60         int pad2;
61
62 } ImageUser;
63
64 /* iuser->flag */
65 #define IMA_ANIM_ALWAYS         1
66 #define IMA_ANIM_REFRESHED      2
67 /* #define IMA_DO_PREMUL        4 */
68
69 typedef struct Image {
70         ID id;
71         
72         char name[240];                 /* file path */
73         
74         ListBase ibufs;                                 /* not written in file */
75         struct GPUTexture *gputexture;  /* not written in file */
76         
77         /* sources from: */
78         struct anim *anim;
79         struct RenderResult *rr;
80
81         struct RenderResult *renders[8]; /* IMA_MAX_RENDER_SLOT */
82         short render_slot, last_render_slot;
83         
84         short ok, flag;
85         short source, type;
86         int lastframe;
87
88         /* texture page */
89         short tpageflag, totbind;
90         short xrep, yrep;
91         short twsta, twend;
92         unsigned int bindcode;  /* only for current image... */
93         unsigned int *repbind;  /* for repeat of parts of images */
94         
95         struct PackedFile * packedfile;
96         struct PreviewImage * preview;
97
98         /* game engine tile animation */
99         float lastupdate;
100         int lastused;
101         short animspeed;
102         
103         /* for generated images */
104         short gen_x, gen_y;
105         char gen_type, gen_flag;
106         
107         /* display aspect - for UV editing images resized for faster openGL display */
108         float aspx, aspy;
109 } Image;
110
111
112 /* **************** IMAGE ********************* */
113
114 /* Image.flag */
115 #define IMA_FIELDS              1
116 #define IMA_STD_FIELD   2
117 #define IMA_DO_PREMUL   4
118
119 #define IMA_REFLECT             16
120 #define IMA_NOCOLLECT   32
121 #define IMA_DEPRECATED  64
122 #define IMA_OLD_PREMUL  128
123
124 /* Image.tpageflag */
125 #define IMA_TILES                       1
126 #define IMA_TWINANIM            2
127 #define IMA_COLCYCLE            4       /* Depreciated */
128 #define IMA_MIPMAP_COMPLETE 8   /* all mipmap levels in OpenGL texture set? */
129 #define IMA_CLAMP_U                     16 
130 #define IMA_CLAMP_V                     32
131 #define IMA_TPAGE_REFRESH       64
132
133 /* ima->type and ima->source moved to BKE_image.h, for API */
134
135 /* render */
136 #define IMA_MAX_RENDER_TEXT             512
137 #define IMA_MAX_RENDER_SLOT             8
138
139 /* gen_flag */
140 #define IMA_GEN_FLOAT           1
141
142 #endif
143