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