BKE_icons.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2006-2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#ifdef __cplusplus
 
#  include <optional>
 
extern "C" {
#endif
 
#include "BLI_compiler_attrs.h"
#include "BLI_sys_types.h"
 
typedef void (*DrawInfoFreeFP)(void *drawinfo);
 
enum {
  ICON_DATA_ID = 0,
  ICON_DATA_IMBUF,
  ICON_DATA_PREVIEW,
  ICON_DATA_GEOM,
  ICON_DATA_STUDIOLIGHT,
  ICON_DATA_GPLAYER,
};
 
struct Icon {
  void *drawinfo;
  void *obj;
  char obj_type;
  char flag;
  short id_type;
  DrawInfoFreeFP drawinfo_free;
};
 
struct Icon_Geom {
  int icon_id;
  int coords_len;
  int coords_range[2];
  unsigned char (*coords)[2];
  unsigned char (*colors)[4];
  /* when not NULL, the memory of coords and colors is a sub-region of this pointer. */
  const void *mem;
};
 
typedef struct Icon Icon;
 
struct ID;
struct ImBuf;
struct PreviewImage;
struct StudioLight;
struct bGPDlayer;
 
void BKE_icons_init(int first_dyn_id);
 
int BKE_icon_id_ensure(struct ID *id);
 
int BKE_icon_gplayer_color_ensure(struct bGPDlayer *gpl);
 
int BKE_icon_preview_ensure(struct ID *id, struct PreviewImage *preview);
 
int BKE_icon_imbuf_create(struct ImBuf *ibuf) ATTR_WARN_UNUSED_RESULT;
struct ImBuf *BKE_icon_imbuf_get_buffer(int icon_id) ATTR_WARN_UNUSED_RESULT;
 
struct Icon *BKE_icon_get(int icon_id);
 
bool BKE_icon_is_preview(int icon_id);
bool BKE_icon_is_image(int icon_id);
 
void BKE_icon_set(int icon_id, struct Icon *icon);
 
void BKE_icon_id_delete(struct ID *id);
 
bool BKE_icon_delete(int icon_id);
bool BKE_icon_delete_unmanaged(int icon_id);
 
void BKE_icon_changed(int icon_id);
 
void BKE_icons_free(void);
 
void BKE_icons_deferred_free(void);
 
int BKE_icon_geom_ensure(struct Icon_Geom *geom);
struct Icon_Geom *BKE_icon_geom_from_memory(uchar *data, size_t data_len);
struct Icon_Geom *BKE_icon_geom_from_file(const char *filename);
 
struct ImBuf *BKE_icon_geom_rasterize(const struct Icon_Geom *geom,
                                      unsigned int size_x,
                                      unsigned int size_y);
void BKE_icon_geom_invert_lightness(struct Icon_Geom *geom);
 
int BKE_icon_ensure_studio_light(struct StudioLight *sl, int id_type);
 
#define ICON_RENDER_DEFAULT_HEIGHT 32
 
#ifdef __cplusplus
}
#endif