Cleanup: commas at the end of enums
[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 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         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         char name[64];  /* 64 = MAX_NAME */
84 } RenderSlot;
85
86 /* iuser->flag */
87 #define IMA_ANIM_ALWAYS         (1 << 0)
88 #define IMA_ANIM_REFRESHED      (1 << 1)
89 /* #define IMA_DO_PREMUL        (1 << 2) */
90 #define IMA_NEED_FRAME_RECALC   (1 << 3)
91 #define IMA_SHOW_STEREO         (1 << 4)
92
93 enum {
94         TEXTARGET_TEXTURE_2D = 0,
95         TEXTARGET_TEXTURE_CUBE_MAP = 1,
96         TEXTARGET_COUNT = 2,
97 };
98
99 typedef struct Image {
100         ID id;
101
102         char name[1024];                        /* file path, 1024 = FILE_MAX */
103
104         struct MovieCache *cache;       /* not written in file */
105         struct GPUTexture *gputexture[2]; /* not written in file 2 = TEXTARGET_COUNT */
106
107         /* sources from: */
108         ListBase anims;
109         struct RenderResult *rr;
110
111         struct RenderResult *renders[8]; /* IMA_MAX_RENDER_SLOT */
112         short render_slot, last_render_slot;
113
114         int flag;
115         short source, type;
116         int lastframe;
117
118         /* texture page */
119         short tpageflag, totbind;
120         short xrep, yrep;
121         short twsta, twend;
122         unsigned int bindcode[2]; /* only for current image... 2 = TEXTARGET_COUNT */
123         char pad1[4];
124         unsigned int *repbind;  /* for repeat of parts of images */
125
126         struct PackedFile *packedfile DNA_DEPRECATED; /* deprecated */
127         struct ListBase packedfiles;
128         struct PreviewImage *preview;
129
130         /* game engine tile animation */
131         float lastupdate;
132         int lastused;
133         short animspeed;
134
135         short ok;
136
137         /* for generated images */
138         int gen_x, gen_y;
139         char gen_type, gen_flag;
140         short gen_depth;
141         float gen_color[4];
142
143         /* display aspect - for UV editing images resized for faster openGL display */
144         float aspx, aspy;
145
146         /* color management */
147         ColorManagedColorspaceSettings colorspace_settings;
148         char alpha_mode;
149
150         char pad[5];
151
152         /* Multiview */
153         char eye; /* for viewer node stereoscopy */
154         char views_format;
155         ListBase views;  /* ImageView */
156         struct Stereo3dFormat *stereo3d_format;
157
158         RenderSlot render_slots[8];  /* 8 = IMA_MAX_RENDER_SLOT */
159 } Image;
160
161
162 /* **************** IMAGE ********************* */
163
164 /* Image.flag */
165 enum {
166         IMA_FIELDS              = (1 << 0),
167         IMA_STD_FIELD           = (1 << 1),
168 #ifdef DNA_DEPRECATED
169         IMA_DO_PREMUL           = (1 << 2),  /* deprecated, should not be used */
170 #endif
171         IMA_REFLECT             = (1 << 4),
172         IMA_NOCOLLECT           = (1 << 5),
173         //IMA_DONE_TAG          = (1 << 6),  // UNUSED
174         IMA_OLD_PREMUL          = (1 << 7),
175         // IMA_CM_PREDIVIDE     = (1 << 8),  /* deprecated, should not be used */
176         IMA_USED_FOR_RENDER     = (1 << 9),
177         IMA_USER_FRAME_IN_RANGE = (1 << 10), /* for image user, but these flags are mixed */
178         IMA_VIEW_AS_RENDER      = (1 << 11),
179         IMA_IGNORE_ALPHA        = (1 << 12),
180         IMA_DEINTERLACE         = (1 << 13),
181         IMA_USE_VIEWS           = (1 << 14),
182         // IMA_IS_STEREO        = (1 << 15), /* deprecated */
183         // IMA_IS_MULTIVIEW     = (1 << 16), /* deprecated */
184 };
185
186 /* Image.tpageflag */
187 #define IMA_TILES           (1 << 0)
188 #define IMA_TWINANIM        (1 << 1)
189 #define IMA_COLCYCLE        (1 << 2)    /* Depreciated */
190 #define IMA_MIPMAP_COMPLETE (1 << 3)   /* all mipmap levels in OpenGL texture set? */
191 #define IMA_CLAMP_U         (1 << 4)
192 #define IMA_CLAMP_V         (1 << 5)
193 #define IMA_TPAGE_REFRESH   (1 << 6)
194 #define IMA_GLBIND_IS_DATA  (1 << 7) /* opengl image texture bound as non-color data */
195
196 /* ima->type and ima->source moved to BKE_image.h, for API */
197
198 /* render */
199 #define IMA_MAX_RENDER_TEXT     (1 << 9)
200 #define IMA_MAX_RENDER_SLOT     (1 << 3)
201
202 /* gen_flag */
203 #define IMA_GEN_FLOAT           1
204
205 /* alpha_mode */
206 enum {
207         IMA_ALPHA_STRAIGHT = 0,
208         IMA_ALPHA_PREMUL = 1,
209 };
210
211 #endif