Multi-View and Stereo 3D
[blender-staging.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 MovieCache;
43 struct RenderResult;
44 struct GPUTexture;
45
46 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
47 /* should be used in conjunction with an ID * to Image. */
48 typedef struct ImageUser {
49         struct Scene *scene;            /* to retrieve render result */
50
51         int framenr;                            /* movies, sequences: current to display */
52         int frames;                                     /* total amount of frames to use */
53         int offset, sfra;                       /* offset within movie, start frame in global time */
54         char fie_ima, cycl;             /* fields/image in movie, cyclic flag */
55         char ok;
56
57         char multiview_eye;                     /* multiview current eye - for internal use of drawing routines */
58
59         short multi_index, view, layer, pass;    /* listbase indices, for menu browsing or retrieve buffer */
60
61         short flag;
62         short passtype;
63
64 } ImageUser;
65
66 typedef struct ImageAnim {
67         struct ImageAnim *next, *prev;
68         struct anim *anim;
69 } ImageAnim;
70
71 typedef struct ImageView {
72         struct ImageView *next, *prev;
73         char name[64];                  /* MAX_NAME */
74         char filepath[1024];    /* 1024 = FILE_MAX */
75 } ImageView;
76
77 typedef struct ImagePackedFile {
78         struct ImagePackedFile *next, *prev;
79         struct PackedFile *packedfile;
80         char filepath[1024];    /* 1024 = FILE_MAX */
81 } ImagePackedFile;
82
83 typedef struct RenderSlot {
84         char name[64];  /* 64 = MAX_NAME */
85 } RenderSlot;
86
87 /* iuser->flag */
88 #define IMA_ANIM_ALWAYS         1
89 #define IMA_ANIM_REFRESHED      2
90 /* #define IMA_DO_PREMUL        4 */
91 #define IMA_NEED_FRAME_RECALC   8
92 #define IMA_SHOW_STEREO         16
93
94 typedef struct Image {
95         ID id;
96         
97         char name[1024];                        /* file path, 1024 = FILE_MAX */
98         
99         struct MovieCache *cache;       /* not written in file */
100         struct GPUTexture *gputexture;  /* not written in file */
101         
102         /* sources from: */
103         ListBase anims;
104         struct RenderResult *rr;
105
106         struct RenderResult *renders[8]; /* IMA_MAX_RENDER_SLOT */
107         short render_slot, last_render_slot;
108
109         int flag;
110         short source, type;
111         int lastframe;
112
113         /* texture page */
114         short tpageflag, totbind;
115         short xrep, yrep;
116         short twsta, twend;
117         unsigned int bindcode;  /* only for current image... */
118         unsigned int *repbind;  /* for repeat of parts of images */
119         
120         struct PackedFile *packedfile; /* deprecated */
121         struct ListBase packedfiles;
122         struct PreviewImage *preview;
123
124         /* game engine tile animation */
125         float lastupdate;
126         int lastused;
127         short animspeed;
128
129         short ok;
130         
131         /* for generated images */
132         int gen_x, gen_y;
133         char gen_type, gen_flag;
134         short gen_depth;
135         float gen_color[4];
136         
137         /* display aspect - for UV editing images resized for faster openGL display */
138         float aspx, aspy;
139
140         /* color management */
141         ColorManagedColorspaceSettings colorspace_settings;
142         char alpha_mode;
143
144         char pad[5];
145
146         /* Multiview */
147         char eye; /* for viewer node stereoscopy */
148         char views_format;
149         ListBase views;
150         struct Stereo3dFormat *stereo3d_format;
151
152         RenderSlot render_slots[8];  /* 8 = IMA_MAX_RENDER_SLOT */
153 } Image;
154
155
156 /* **************** IMAGE ********************* */
157
158 /* Image.flag */
159 enum {
160         IMA_FIELDS              = (1 << 0),
161         IMA_STD_FIELD           = (1 << 1),
162         IMA_DO_PREMUL           = (1 << 2),  /* deprecated, should not be used */
163         IMA_REFLECT             = (1 << 4),
164         IMA_NOCOLLECT           = (1 << 5),
165         //IMA_DONE_TAG          = (1 << 6),  // UNUSED
166         IMA_OLD_PREMUL          = (1 << 7),
167         // IMA_CM_PREDIVIDE     = (1 << 8),  /* deprecated, should not be used */
168         IMA_USED_FOR_RENDER     = (1 << 9),
169         IMA_USER_FRAME_IN_RANGE = (1 << 10), /* for image user, but these flags are mixed */
170         IMA_VIEW_AS_RENDER      = (1 << 11),
171         IMA_IGNORE_ALPHA        = (1 << 12),
172         IMA_DEINTERLACE         = (1 << 13),
173         IMA_USE_VIEWS           = (1 << 14),
174         IMA_IS_STEREO           = (1 << 15),
175         IMA_IS_MULTIVIEW        = (1 << 16), /* similar to stereo, but a more general case */
176 };
177
178 #if (DNA_DEPRECATED_GCC_POISON == 1)
179 #pragma GCC poison IMA_DO_PREMUL
180 #endif
181
182 /* Image.tpageflag */
183 #define IMA_TILES                       1
184 #define IMA_TWINANIM            2
185 #define IMA_COLCYCLE            4       /* Depreciated */
186 #define IMA_MIPMAP_COMPLETE 8   /* all mipmap levels in OpenGL texture set? */
187 #define IMA_CLAMP_U                     16 
188 #define IMA_CLAMP_V                     32
189 #define IMA_TPAGE_REFRESH       64
190 #define IMA_GLBIND_IS_DATA      128 /* opengl image texture bound as non-color data */
191
192 /* ima->type and ima->source moved to BKE_image.h, for API */
193
194 /* render */
195 #define IMA_MAX_RENDER_TEXT             512
196 #define IMA_MAX_RENDER_SLOT             8
197
198 /* gen_flag */
199 #define IMA_GEN_FLOAT           1
200
201 /* alpha_mode */
202 enum {
203         IMA_ALPHA_STRAIGHT = 0,
204         IMA_ALPHA_PREMUL = 1,
205 };
206
207 #endif