Merge branch 'master' into blende2.8
[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 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 _pad, cycl;                /* cyclic flag */
55         char ok;
56
57         char multiview_eye;                     /* multiview current eye - for internal use of drawing routines */
58         short pass;
59         short pad;
60
61         short multi_index, view, layer;  /* listbase indices, for menu browsing or retrieve buffer */
62         short flag;
63 } ImageUser;
64
65 typedef struct ImageAnim {
66         struct ImageAnim *next, *prev;
67         struct anim *anim;
68 } ImageAnim;
69
70 typedef struct ImageView {
71         struct ImageView *next, *prev;
72         char name[64];                  /* MAX_NAME */
73         char filepath[1024];    /* 1024 = FILE_MAX */
74 } ImageView;
75
76 typedef struct ImagePackedFile {
77         struct ImagePackedFile *next, *prev;
78         struct PackedFile *packedfile;
79         char filepath[1024];    /* 1024 = FILE_MAX */
80 } ImagePackedFile;
81
82 typedef struct RenderSlot {
83         struct RenderSlot *next, *prev;
84         char name[64];  /* 64 = MAX_NAME */
85         struct RenderResult *render;
86 } RenderSlot;
87
88 /* iuser->flag */
89 #define IMA_ANIM_ALWAYS         (1 << 0)
90 #define IMA_ANIM_REFRESHED      (1 << 1)
91 /* #define IMA_DO_PREMUL        (1 << 2) */
92 #define IMA_NEED_FRAME_RECALC   (1 << 3)
93 #define IMA_SHOW_STEREO         (1 << 4)
94
95 enum {
96         TEXTARGET_TEXTURE_2D = 0,
97         TEXTARGET_TEXTURE_CUBE_MAP = 1,
98         TEXTARGET_COUNT = 2
99 };
100
101 typedef struct Image {
102         ID id;
103
104         char name[1024];                        /* file path, 1024 = FILE_MAX */
105
106         struct MovieCache *cache;       /* not written in file */
107         struct GPUTexture *gputexture[2]; /* not written in file 2 = TEXTARGET_COUNT */
108
109         /* sources from: */
110         ListBase anims;
111         struct RenderResult *rr;
112
113         ListBase renderslots;
114         short render_slot, last_render_slot;
115
116         int flag;
117         short source, type;
118         int lastframe;
119
120         /* texture page */
121         short tpageflag;
122         short pad2;
123         unsigned int pad3;
124
125         struct PackedFile *packedfile DNA_DEPRECATED; /* deprecated */
126         struct ListBase packedfiles;
127         struct PreviewImage *preview;
128
129         int lastused;
130         short ok;
131         short pad4[3];
132
133         /* for generated images */
134         int gen_x, gen_y;
135         char gen_type, gen_flag;
136         short gen_depth;
137         float gen_color[4];
138
139         /* display aspect - for UV editing images resized for faster openGL display */
140         float aspx, aspy;
141
142         /* color management */
143         ColorManagedColorspaceSettings colorspace_settings;
144         char alpha_mode;
145
146         char pad[5];
147
148         /* Multiview */
149         char eye; /* for viewer node stereoscopy */
150         char views_format;
151         ListBase views;  /* ImageView */
152         struct Stereo3dFormat *stereo3d_format;
153 } Image;
154
155
156 /* **************** IMAGE ********************* */
157
158 /* Image.flag */
159 enum {
160         // IMA_FIELDS              = (1 << 0),
161         // IMA_STD_FIELD           = (1 << 1),
162 #ifdef DNA_DEPRECATED
163         IMA_DO_PREMUL           = (1 << 2),  /* deprecated, should not be used */
164 #endif
165         //IMA_REFLECT             = (1 << 4), /* deprecated */
166         IMA_NOCOLLECT           = (1 << 5),
167         //IMA_DONE_TAG          = (1 << 6),  // UNUSED
168         IMA_OLD_PREMUL          = (1 << 7),
169         // IMA_CM_PREDIVIDE     = (1 << 8),  /* deprecated, should not be used */
170         IMA_USED_FOR_RENDER     = (1 << 9),
171         IMA_USER_FRAME_IN_RANGE = (1 << 10), /* for image user, but these flags are mixed */
172         IMA_VIEW_AS_RENDER      = (1 << 11),
173         IMA_IGNORE_ALPHA        = (1 << 12),
174         IMA_DEINTERLACE         = (1 << 13),
175         IMA_USE_VIEWS           = (1 << 14),
176         // IMA_IS_STEREO        = (1 << 15), /* deprecated */
177         // IMA_IS_MULTIVIEW     = (1 << 16), /* deprecated */
178 };
179
180 /* Image.tpageflag */
181 //#define IMA_TILES                     (1 << 0) /* Deprecated */
182 //#define IMA_TWINANIM          (1 << 1) /* Deprecated */
183 #define IMA_COLCYCLE            (1 << 2)        /* Deprecated */
184 #define IMA_MIPMAP_COMPLETE (1 << 3)   /* all mipmap levels in OpenGL texture set? */
185 //#define IMA_CLAMP_U           (1 << 4) /* Deprecated */
186 //#define IMA_CLAMP_V           (1 << 5) /* Deprecated */
187 #define IMA_TPAGE_REFRESH       (1 << 6)
188 #define IMA_GLBIND_IS_DATA      (1 << 7) /* opengl image texture bound as non-color data */
189
190 /* ima->type and ima->source moved to BKE_image.h, for API */
191
192 /* render */
193 #define IMA_MAX_RENDER_TEXT             (1 << 9)
194
195 /* gen_flag */
196 #define IMA_GEN_FLOAT           1
197
198 /* alpha_mode */
199 enum {
200         IMA_ALPHA_STRAIGHT = 0,
201         IMA_ALPHA_PREMUL = 1,
202 };
203
204 #endif