Image cache rewrite to using generic movie cache
[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_defs.h"
36 #include "DNA_ID.h"
37 #include "DNA_color_types.h"  /* for color management */
38
39 struct PackedFile;
40 struct Scene;
41 struct anim;
42 struct ImBuf;
43 struct MovieCache;
44 struct RenderResult;
45 struct GPUTexture;
46
47
48 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
49 /* should be used in conjunction with an ID * to Image. */
50 typedef struct ImageUser {
51         struct Scene *scene;            /* to retrieve render result */
52
53         int framenr;                            /* movies, sequences: current to display */
54         int frames;                                     /* total amount of frames to use */
55         int offset, sfra;                       /* offset within movie, start frame in global time */
56         char fie_ima, cycl;             /* fields/image in movie, cyclic flag */
57         char ok, pad;
58
59         short multi_index, layer, pass;  /* listbase indices, for menu browsing or retrieve buffer */
60
61         short flag;
62         
63         int pad2;
64
65 } ImageUser;
66
67 /* iuser->flag */
68 #define IMA_ANIM_ALWAYS         1
69 #define IMA_ANIM_REFRESHED      2
70 /* #define IMA_DO_PREMUL        4 */
71 #define IMA_NEED_FRAME_RECALC   8
72
73 typedef struct Image {
74         ID id;
75         
76         char name[1024];                        /* file path, 1024 = FILE_MAX */
77         
78         struct MovieCache *cache;       /* not written in file */
79         struct GPUTexture *gputexture;  /* not written in file */
80         
81         /* sources from: */
82         struct anim *anim;
83         struct RenderResult *rr;
84
85         struct RenderResult *renders[8]; /* IMA_MAX_RENDER_SLOT */
86         short render_slot, last_render_slot;
87         
88         short ok, flag;
89         short source, type;
90         int lastframe;
91
92         /* texture page */
93         short tpageflag, totbind;
94         short xrep, yrep;
95         short twsta, twend;
96         unsigned int bindcode;  /* only for current image... */
97         unsigned int *repbind;  /* for repeat of parts of images */
98         
99         struct PackedFile *packedfile;
100         struct PreviewImage *preview;
101
102         /* game engine tile animation */
103         float lastupdate;
104         int lastused;
105         short animspeed;
106         short pad2;
107         
108         /* for generated images */
109         int gen_x, gen_y;
110         char gen_type, gen_flag;
111         short gen_depth;
112         
113         /* display aspect - for UV editing images resized for faster openGL display */
114         float aspx, aspy;
115
116         /* color management */
117         ColorManagedColorspaceSettings colorspace_settings;
118         char alpha_mode;
119
120         char pad[7];
121 } Image;
122
123
124 /* **************** IMAGE ********************* */
125
126 /* Image.flag */
127 enum {
128         IMA_FIELDS              = (1 << 0),
129         IMA_STD_FIELD           = (1 << 1),
130         IMA_DO_PREMUL           = (1 << 2),  /* deprecated, should not be used */
131         IMA_REFLECT             = (1 << 4),
132         IMA_NOCOLLECT           = (1 << 5),
133         //IMA_DONE_TAG          = (1 << 6),  // UNUSED
134         IMA_OLD_PREMUL          = (1 << 7),
135         // IMA_CM_PREDIVIDE     = (1 << 8),  /* deprecated, should not be used */
136         IMA_USED_FOR_RENDER     = (1 << 9),
137         IMA_USER_FRAME_IN_RANGE = (1 << 10), /* for image user, but these flags are mixed */
138         IMA_VIEW_AS_RENDER      = (1 << 11),
139         IMA_IGNORE_ALPHA        = (1 << 12),
140 };
141
142 #if (DNA_DEPRECATED_GCC_POISON == 1)
143 #pragma GCC poison IMA_DO_PREMUL
144 #endif
145
146 /* Image.tpageflag */
147 #define IMA_TILES                       1
148 #define IMA_TWINANIM            2
149 #define IMA_COLCYCLE            4       /* Depreciated */
150 #define IMA_MIPMAP_COMPLETE 8   /* all mipmap levels in OpenGL texture set? */
151 #define IMA_CLAMP_U                     16 
152 #define IMA_CLAMP_V                     32
153 #define IMA_TPAGE_REFRESH       64
154 #define IMA_GLBIND_IS_DATA      128 /* opengl image texture bound as non-color data */
155
156 /* ima->type and ima->source moved to BKE_image.h, for API */
157
158 /* render */
159 #define IMA_MAX_RENDER_TEXT             512
160 #define IMA_MAX_RENDER_SLOT             8
161
162 /* gen_flag */
163 #define IMA_GEN_FLOAT           1
164
165 /* alpha_mode */
166 enum {
167         IMA_ALPHA_STRAIGHT = 0,
168         IMA_ALPHA_PREMUL = 1,
169 };
170
171 #endif