BKE_icons.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2006-2007 Blender Foundation.
 * All rights reserved.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "BLI_compiler_attrs.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 BlendDataReader;
struct BlendWriter;
struct ID;
struct ImBuf;
struct PreviewImage;
struct StudioLight;
struct bGPDlayer;
 
enum eIconSizes;
 
void BKE_icons_init(int first_dyn_id);
 
/* return icon id for library object or create new icon if not found */
int BKE_icon_id_ensure(struct ID *id);
 
/* return icon id for Grease Pencil layer (color preview) or create new icon if not found */
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;
 
/* retrieve icon for id */
struct Icon *BKE_icon_get(const int icon_id);
 
/* set icon for id if not already defined */
/* used for inserting the internal icons */
void BKE_icon_set(const int icon_id, struct Icon *icon);
 
/* remove icon and free data if library object becomes invalid */
void BKE_icon_id_delete(struct ID *id);
 
bool BKE_icon_delete(const int icon_id);
bool BKE_icon_delete_unmanaged(const int icon_id);
 
/* report changes - icon needs to be recalculated */
void BKE_icon_changed(const int icon_id);
 
/* free all icons */
void BKE_icons_free(void);
 
/* free all icons marked for deferred deletion */
void BKE_icons_deferred_free(void);
 
/* free the preview image for use in list */
void BKE_previewimg_freefunc(void *link);
 
/* free the preview image */
void BKE_previewimg_free(struct PreviewImage **prv);
 
/* clear the preview image or icon, but does not free it */
void BKE_previewimg_clear(struct PreviewImage *prv);
 
/* clear the preview image or icon at a specific size */
void BKE_previewimg_clear_single(struct PreviewImage *prv, enum eIconSizes size);
 
/* get the preview from any pointer */
struct PreviewImage **BKE_previewimg_id_get_p(const struct ID *id);
struct PreviewImage *BKE_previewimg_id_get(const struct ID *id);
 
bool BKE_previewimg_id_supports_jobs(const struct ID *id);
 
/* Trigger deferred loading of a custom image file into the preview buffer. */
void BKE_previewimg_id_custom_set(struct ID *id, const char *path);
 
/* free the preview image belonging to the id */
void BKE_previewimg_id_free(struct ID *id);
 
/* create a new preview image */
struct PreviewImage *BKE_previewimg_create(void);
 
/* create a copy of the preview image */
struct PreviewImage *BKE_previewimg_copy(const struct PreviewImage *prv);
 
void BKE_previewimg_id_copy(struct ID *new_id, const struct ID *old_id);
 
/* retrieve existing or create new preview image */
struct PreviewImage *BKE_previewimg_id_ensure(struct ID *id);
 
void BKE_previewimg_ensure(struct PreviewImage *prv, const int size);
 
struct ImBuf *BKE_previewimg_to_imbuf(struct PreviewImage *prv, const int size);
 
void BKE_previewimg_finish(struct PreviewImage *prv, const int size);
bool BKE_previewimg_is_finished(const struct PreviewImage *prv, const int size);
 
struct PreviewImage *BKE_previewimg_cached_get(const char *name);
 
struct PreviewImage *BKE_previewimg_cached_ensure(const char *name);
 
struct PreviewImage *BKE_previewimg_cached_thumbnail_read(const char *name,
                                                          const char *path,
                                                          const int source,
                                                          bool force_update);
 
void BKE_previewimg_cached_release(const char *name);
 
void BKE_previewimg_deferred_release(struct PreviewImage *prv);
 
void BKE_previewimg_blend_write(struct BlendWriter *writer, const struct PreviewImage *prv);
void BKE_previewimg_blend_read(struct BlendDataReader *reader, struct PreviewImage *prv);
 
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,
                                      const unsigned int size_x,
                                      const 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