Merged changes in the trunk up to revision 54992.
[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 #include "DNA_color_types.h"  /* for color management */
37
38 struct PackedFile;
39 struct Scene;
40 struct anim;
41 struct ImBuf;
42 struct RenderResult;
43 struct GPUTexture;
44
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, pad;
56
57         short multi_index, layer, pass;  /* listbase indices, for menu browsing or retrieve buffer */
58
59         short flag;
60         
61         int pad2;
62
63 } ImageUser;
64
65 /* iuser->flag */
66 #define IMA_ANIM_ALWAYS         1
67 #define IMA_ANIM_REFRESHED      2
68 /* #define IMA_DO_PREMUL        4 */
69 #define IMA_NEED_FRAME_RECALC   8
70
71 typedef struct Image {
72         ID id;
73         
74         char name[1024];                        /* file path, 1024 = FILE_MAX */
75         
76         ListBase ibufs;                                 /* not written in file */
77         struct GPUTexture *gputexture;  /* not written in file */
78         
79         /* sources from: */
80         struct anim *anim;
81         struct RenderResult *rr;
82
83         struct RenderResult *renders[8]; /* IMA_MAX_RENDER_SLOT */
84         short render_slot, last_render_slot;
85         
86         short ok, flag;
87         short source, type;
88         int lastframe;
89
90         /* texture page */
91         short tpageflag, totbind;
92         short xrep, yrep;
93         short twsta, twend;
94         unsigned int bindcode;  /* only for current image... */
95         unsigned int *repbind;  /* for repeat of parts of images */
96         
97         struct PackedFile *packedfile;
98         struct PreviewImage *preview;
99
100         /* game engine tile animation */
101         float lastupdate;
102         int lastused;
103         short animspeed;
104         short pad2;
105         
106         /* for generated images */
107         int gen_x, gen_y;
108         char gen_type, gen_flag;
109         char gen_pad[2];
110         
111         /* display aspect - for UV editing images resized for faster openGL display */
112         float aspx, aspy;
113
114         /* color management */
115         ColorManagedColorspaceSettings colorspace_settings;
116         char alpha_mode;
117
118         char pad[7];
119 } Image;
120
121
122 /* **************** IMAGE ********************* */
123
124 /* Image.flag */
125 #define IMA_FIELDS                      1
126 #define IMA_STD_FIELD           2
127 #define IMA_DO_PREMUL           4    /* deprecated, should not be used */
128 #define IMA_REFLECT                     16
129 #define IMA_NOCOLLECT           32
130 #define IMA_DONE_TAG            64
131 #define IMA_OLD_PREMUL          128
132 /*#define IMA_CM_PREDIVIDE      256*/  /* deprecated, should not be used */
133 #define IMA_USED_FOR_RENDER     512
134 #define IMA_USER_FRAME_IN_RANGE 1024 /* for image user, but these flags are mixed */
135 #define IMA_VIEW_AS_RENDER      2048
136 #define IMA_IGNORE_ALPHA        4096
137
138 /* Image.tpageflag */
139 #define IMA_TILES                       1
140 #define IMA_TWINANIM            2
141 #define IMA_COLCYCLE            4       /* Depreciated */
142 #define IMA_MIPMAP_COMPLETE 8   /* all mipmap levels in OpenGL texture set? */
143 #define IMA_CLAMP_U                     16 
144 #define IMA_CLAMP_V                     32
145 #define IMA_TPAGE_REFRESH       64
146 #define IMA_GLBIND_IS_DATA      128 /* opengl image texture bound as non-color data */
147
148 /* ima->type and ima->source moved to BKE_image.h, for API */
149
150 /* render */
151 #define IMA_MAX_RENDER_TEXT             512
152 #define IMA_MAX_RENDER_SLOT             8
153
154 /* gen_flag */
155 #define IMA_GEN_FLOAT           1
156
157 /* alpha_mode */
158 enum {
159         IMA_ALPHA_STRAIGHT = 0,
160         IMA_ALPHA_PREMUL = 1,
161 };
162
163 #endif