DNA_image_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_color_types.h" /* for color management */
#include "DNA_defs.h"
 
#ifdef __cplusplus
namespace blender::bke {
struct ImageRuntime;
}  // namespace blender::bke
using ImageRuntimeHandle = blender::bke::ImageRuntime;
 
namespace blender::gpu {
class Texture;
}  // namespace blender::gpu
using GPUTexture = blender::gpu::Texture;
#else
typedef struct ImageRuntimeHandle ImageRuntimeHandle;
typedef struct GPUTexture GPUTexture;
#endif
 
struct MovieReader;
struct MovieCache;
struct PackedFile;
struct RenderResult;
struct Scene;

typedef struct ImageUser {
  struct Scene *scene;

  int framenr;
  int frames;
  int offset, sfra;
  char cycl;

  char multiview_eye;
  short pass;
 
  int tile;

  short multi_index, view, layer;
  short flag;
} ImageUser;
 
typedef struct ImageAnim {
  struct ImageAnim *next, *prev;
  struct MovieReader *anim;
} ImageAnim;
 
typedef struct ImageView {
  struct ImageView *next, *prev;
  char name[/*MAX_NAME*/ 64];
  char filepath[/*FILE_MAX*/ 1024];
} ImageView;
 
typedef struct ImagePackedFile {
  struct ImagePackedFile *next, *prev;
  struct PackedFile *packedfile;
 
  /* Which view and tile this ImagePackedFile represents. Normal images will use 0 and 1001
   * respectively when creating their ImagePackedFile. Must be provided for each packed image. */
  int view;
  int tile_number;
  char filepath[/*FILE_MAX*/ 1024];
} ImagePackedFile;
 
typedef struct RenderSlot {
  struct RenderSlot *next, *prev;
  char name[/*MAX_NAME*/ 64];
  struct RenderResult *render;
} RenderSlot;
 
typedef struct ImageTile_Runtime {
  int tilearray_layer;
  int _pad;
  int tilearray_offset[2];
  int tilearray_size[2];
} ImageTile_Runtime;
 
typedef struct ImageTile {
  struct ImageTile *next, *prev;
 
  struct ImageTile_Runtime runtime;
 
  int tile_number;
 
  /* for generated images */
  int gen_x, gen_y;
  char gen_type, gen_flag;
  short gen_depth;
  float gen_color[4];
 
  char label[64];
} ImageTile;

enum {
  IMA_ANIM_ALWAYS = 1 << 0,
  IMA_SHOW_SEQUENCER_SCENE = 1 << 1,
  // IMA_UNUSED_2 = 1 << 2,
  IMA_NEED_FRAME_RECALC = 1 << 3,
  IMA_SHOW_STEREO = 1 << 4,
  // IMA_UNUSED_5 = 1 << 5,
};
 
/* Used to get the correct gpu texture from an Image datablock. */
typedef enum eGPUTextureTarget {
  TEXTARGET_2D = 0,
  TEXTARGET_2D_ARRAY = 1,
  TEXTARGET_TILE_MAPPING = 2,
  TEXTARGET_COUNT = 3,
} eGPUTextureTarget;
 
typedef struct Image {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_IM;
#endif
 
  ID id;
  struct AnimData *adt;

  char filepath[/*FILE_MAX*/ 1024];

  struct MovieCache *cache;
  GPUTexture *gputexture[/*TEXTARGET_COUNT*/ 3][2];
 
  /* sources from: */
  ListBase anims;
  struct RenderResult *rr;
 
  ListBase renderslots;
  short render_slot, last_render_slot;
 
  int flag;
  short source, type;
  int lastframe;
 
  /* GPU texture flag. */
  int gpuframenr;
  short gpuflag;
  short gpu_pass;
  short gpu_layer;
  short gpu_view;
 
  /* Number of iterations to perform when extracting mask for uv seam fixing. */
  short seam_margin;
 
  char _pad2[2];

  struct PackedFile *packedfile DNA_DEPRECATED;
  struct ListBase packedfiles;
  struct PreviewImage *preview;
 
  int lastused;
 
  /* for generated images */
  int gen_x DNA_DEPRECATED, gen_y DNA_DEPRECATED;
  char gen_type DNA_DEPRECATED, gen_flag DNA_DEPRECATED;
  short gen_depth DNA_DEPRECATED;
  float gen_color[4] DNA_DEPRECATED;
 
  /* display aspect - for UV editing images resized for faster openGL display */
  float aspx, aspy;
 
  /* color management */
  ColorManagedColorspaceSettings colorspace_settings;
  char alpha_mode;
 
  char _pad;
 
  /* Multiview */
  char eye;
  char views_format;
 
  /* ImageTile list for UDIMs. */
  int active_tile_index;
  ListBase tiles;

  ListBase views;
  struct Stereo3dFormat *stereo3d_format;
 
  ImageRuntimeHandle *runtime;
} Image;
 
/* **************** IMAGE ********************* */

enum {
  IMA_HIGH_BITDEPTH = (1 << 0),
  IMA_FLAG_UNUSED_1 = (1 << 1), /* cleared */
#ifdef DNA_DEPRECATED_ALLOW
  IMA_DO_PREMUL = (1 << 2),
#endif
  IMA_FLAG_UNUSED_4 = (1 << 4), /* cleared */
  IMA_NOCOLLECT = (1 << 5),
  IMA_FLAG_UNUSED_6 = (1 << 6), /* cleared */
  IMA_OLD_PREMUL = (1 << 7),
  IMA_FLAG_UNUSED_8 = (1 << 8), /* cleared */
  IMA_USED_FOR_RENDER = (1 << 9),
  IMA_USER_FRAME_IN_RANGE = (1 << 10),
  IMA_VIEW_AS_RENDER = (1 << 11),
  IMA_FLAG_UNUSED_12 = (1 << 12), /* cleared */
  IMA_DEINTERLACE = (1 << 13),
  IMA_USE_VIEWS = (1 << 14),
  IMA_FLAG_UNUSED_15 = (1 << 15), /* cleared */
  IMA_FLAG_UNUSED_16 = (1 << 16), /* cleared */
};

enum {
  IMA_GPU_MIPMAP_COMPLETE = (1 << 0),
};
 
/* Image.source, where the image comes from */
typedef enum eImageSource {
  /* IMA_SRC_CHECK = 0, */ /* UNUSED */
  IMA_SRC_FILE = 1,
  IMA_SRC_SEQUENCE = 2,
  IMA_SRC_MOVIE = 3,
  IMA_SRC_GENERATED = 4,
  IMA_SRC_VIEWER = 5,
  IMA_SRC_TILED = 6,
} eImageSource;
 
/* Image.type, how to handle or generate the image */
typedef enum eImageType {
  IMA_TYPE_IMAGE = 0,
  IMA_TYPE_MULTILAYER = 1,
  /* generated */
  IMA_TYPE_UV_TEST = 2,
  /* viewers */
  IMA_TYPE_R_RESULT = 4,
  IMA_TYPE_COMPOSITE = 5,
} eImageType;

enum {
  IMA_GENTYPE_BLANK = 0,
  IMA_GENTYPE_GRID = 1,
  IMA_GENTYPE_GRID_COLOR = 2,
};

#define IMA_MAX_RENDER_TEXT_SIZE 512

enum {
  IMA_GEN_FLOAT = (1 << 0),
  IMA_GEN_TILE = (1 << 1),
};

enum {
  IMA_ALPHA_STRAIGHT = 0,
  IMA_ALPHA_PREMUL = 1,
  IMA_ALPHA_CHANNEL_PACKED = 2,
  IMA_ALPHA_IGNORE = 3,
};
 
/* Image gpu runtime defaults */
#define IMAGE_GPU_FRAME_NONE INT_MAX
#define IMAGE_GPU_PASS_NONE SHRT_MAX
#define IMAGE_GPU_LAYER_NONE SHRT_MAX
#define IMAGE_GPU_VIEW_NONE SHRT_MAX