Blender V5.3
DNA_image_types.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "DNA_ID.h"
12#include "DNA_color_types.h" /* for color management */
13#include "DNA_defs.h"
14#include "DNA_scene_enums.h"
15
16#include "BLI_enum_flags.hh"
17
18namespace blender {
19
20namespace bke {
21struct ImageRuntime;
22} // namespace bke
23
24struct ImBufCache;
25struct MovieReader;
26struct PackedFile;
27struct RenderResult;
28struct Scene;
29
31enum eImageUser_Flag : short {
34 // IMA_UNUSED_2 = 1 << 2,
37 // IMA_UNUSED_5 = 1 << 5,
39};
41
42
43enum eImage_Flag : int {
45 IMA_FLAG_UNUSED_1 = (1 << 1), /* cleared */
46#ifdef DNA_DEPRECATED_ALLOW
47 IMA_DO_PREMUL = (1 << 2),
48#endif
49 IMA_FLAG_UNUSED_4 = (1 << 4), /* cleared */
50 IMA_NOCOLLECT = (1 << 5),
51 IMA_FLAG_UNUSED_6 = (1 << 6), /* cleared */
52 IMA_OLD_PREMUL = (1 << 7),
53 IMA_FLAG_UNUSED_8 = (1 << 8), /* cleared */
56 // IMA_USER_FRAME_IN_RANGE = (1 << 10),
57 IMA_VIEW_AS_RENDER = (1 << 11),
58 IMA_FLAG_UNUSED_12 = (1 << 12), /* cleared */
59 IMA_DEINTERLACE = (1 << 13),
60 IMA_USE_VIEWS = (1 << 14),
61 IMA_FLAG_UNUSED_15 = (1 << 15), /* cleared */
62 IMA_FLAG_UNUSED_16 = (1 << 16), /* cleared */
65};
67
68/* Image.source, where the image comes from */
69enum eImageSource : short {
70 /* IMA_SRC_CHECK = 0, */ /* UNUSED */
77};
78
79/* Image.type, how to handle or generate the image */
80enum eImageType : short {
83 /* generated */
85 /* viewers */
88};
89
96
98#define IMA_MAX_RENDER_TEXT_SIZE 512
99
101enum eImage_GenFlag : char {
102 IMA_GEN_FLOAT = (1 << 0),
103 IMA_GEN_TILE = (1 << 1),
104};
106
107
114
119struct ImageUser {
121 struct Scene *scene = nullptr;
122
124 int framenr = 0;
126 int frames = 0;
128 int offset = 0, sfra = 0;
130 char cycl = 0;
131
134 short pass = 0;
135
136 int tile = 0;
137
139 short multi_index = 0, view = 0, layer = 0;
141};
142
143struct ImageAnim {
144 struct ImageAnim *next = nullptr, *prev = nullptr;
145 struct MovieReader *anim = nullptr;
146};
147
148struct ImageView {
149 struct ImageView *next = nullptr, *prev = nullptr;
150 char name[/*MAX_NAME*/ 64] = "";
151 char filepath[/*FILE_MAX*/ 1024] = "";
152};
153
155 struct ImagePackedFile *next = nullptr, *prev = nullptr;
156 struct PackedFile *packedfile = nullptr;
157
158 /* Which view and tile this ImagePackedFile represents. Normal images will use 0 and 1001
159 * respectively when creating their ImagePackedFile. Must be provided for each packed image. */
160 int view = 0;
161 int tile_number = 0;
162 char filepath[/*FILE_MAX*/ 1024] = "";
163};
164
166 struct RenderSlot *next = nullptr, *prev = nullptr;
167 char name[/*MAX_NAME*/ 64] = "";
168 struct RenderResult *render = nullptr;
169};
170
173 int _pad = {};
174 int tilearray_offset[2] = {};
175 int tilearray_size[2] = {};
176};
177
178struct ImageTile {
179 struct ImageTile *next = nullptr, *prev = nullptr;
180
182
183 int tile_number = 0;
184
185 /* for generated images */
186 int gen_x = 0, gen_y = 0;
189 short gen_depth = 0;
190 float gen_color[4] = {};
191
192 char label[64] = "";
193};
194
195struct Image {
196#ifdef __cplusplus
198 static constexpr ID_Type id_type = ID_IM;
199#endif
200
202 struct AnimData *adt = nullptr;
203
205 char filepath[/*FILE_MAX*/ 1024] = "";
206
207 /* sources from: */
208 ListBaseT<ImageAnim> anims = {nullptr, nullptr};
209 struct RenderResult *rr = nullptr;
210
211 ListBaseT<RenderSlot> renderslots = {nullptr, nullptr};
213
217 int lastframe = 0;
218
219 /* Number of iterations to perform when extracting mask for uv seam fixing. */
220 short seam_margin = 8;
221
222 char _pad2[6] = {};
223
226 ListBaseT<ImagePackedFile> packedfiles = {nullptr, nullptr};
227 struct PreviewImage *preview = nullptr;
228
229 ListBaseT<ImagePackedFile> autosave_packedfiles = {nullptr, nullptr};
230
231 char _pad3[4] = {};
232
233 /* for generated images */
240
241 /* display aspect - for UV editing images resized for faster openGL display */
242 float aspx = 1.0, aspy = 1.0;
243
244 /* color management */
247
248 char _pad = {};
249
250 /* Multiview */
252 char eye = 0;
254
255 /* ImageTile list for UDIMs. */
257 ListBaseT<ImageTile> tiles = {nullptr, nullptr};
258
259 ListBaseT<ImageView> views = {nullptr, nullptr};
261
263};
264
265} // namespace blender
#define ENUM_OPERATORS(_enum_type)
ID and Library types, which are fundamental for SDNA.
#define DNA_DEPRECATED
Definition DNA_defs.h:21
BMesh Iterators.
@ IMA_USED_FOR_RENDER
@ IMA_AUTOSAVE_TEMPPACK
@ IMA_TYPE_MULTILAYER
@ IMA_ALPHA_CHANNEL_PACKED
@ IMA_GENTYPE_GRID_COLOR
@ IMA_NEED_FRAME_RECALC
@ IMA_SHOW_SEQUENCER_SCENE
@ IMA_USER_FRAME_IN_RANGE
struct ImageAnim * next
struct MovieReader * anim
struct ImageAnim * prev
struct PackedFile * packedfile
struct ImagePackedFile * prev
struct ImagePackedFile * next
struct ImageTile * next
eImageGenType gen_type
eImage_GenFlag gen_flag
struct ImageTile_Runtime runtime
struct ImageTile * prev
eImageUser_Flag flag
struct Scene * scene
struct ImageView * prev
struct ImageView * next
ColorManagedColorspaceSettings colorspace_settings
DNA_DEPRECATED float gen_color[4]
DNA_DEPRECATED short gen_depth
eImageAlphaMode alpha_mode
ListBaseT< ImageAnim > anims
DNA_DEPRECATED int gen_x
struct PreviewImage * preview
eImageFormat_ViewsFormat views_format
char filepath[1024]
struct Stereo3dFormat * stereo3d_format
eImageSource source
struct RenderResult * rr
ListBaseT< ImageView > views
DNA_DEPRECATED eImage_GenFlag gen_flag
struct AnimData * adt
ListBaseT< ImageTile > tiles
ListBaseT< RenderSlot > renderslots
bke::ImageRuntime * runtime
DNA_DEPRECATED int gen_y
ListBaseT< ImagePackedFile > autosave_packedfiles
DNA_DEPRECATED struct PackedFile * packedfile
ListBaseT< ImagePackedFile > packedfiles
DNA_DEPRECATED eImageGenType gen_type
struct RenderSlot * prev
struct RenderResult * render
struct RenderSlot * next