BKE_preview_image.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2006-2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <array>
#include <memory>
#include <optional>
 
#include "DNA_ID_enums.h"
 
struct BlendDataReader;
struct BlendWriter;
namespace blender::gpu {
class Texture;
}
struct ID;
struct ImBuf;
struct PreviewImage;
 
enum ThumbSource : int8_t;
 
namespace blender::bke {
 
struct PreviewDeferredLoadingData;
 
struct PreviewImageRuntime {
  int icon_id = 0;
  int16_t tag = 0;
 
  std::array<blender::gpu::Texture *, NUM_ICON_SIZES> gputexture = {};

  std::unique_ptr<PreviewDeferredLoadingData> deferred_loading_data;
  PreviewImageRuntime();
  PreviewImageRuntime(const PreviewImageRuntime &other);
  ~PreviewImageRuntime();
};
 
}  // namespace blender::bke
 
void BKE_preview_images_init();
void BKE_preview_images_free();

void BKE_previewimg_freefunc(void *link);

void BKE_previewimg_free(PreviewImage **prv);

void BKE_previewimg_clear(PreviewImage *prv);

void BKE_previewimg_clear_single(PreviewImage *prv, enum eIconSizes size);

PreviewImage **BKE_previewimg_id_get_p(const ID *id);
PreviewImage *BKE_previewimg_id_get(const ID *id);
 
bool BKE_previewimg_id_supports_jobs(const ID *id);

void BKE_previewimg_id_custom_set(ID *id, const char *filepath);

void BKE_previewimg_id_free(ID *id);

PreviewImage *BKE_previewimg_create();

PreviewImage *BKE_previewimg_copy(const PreviewImage *prv);

void BKE_previewimg_id_copy(ID *new_id, const ID *old_id);

PreviewImage *BKE_previewimg_id_ensure(ID *id);

void BKE_previewimg_ensure(PreviewImage *prv, int size);
 
const char *BKE_previewimg_deferred_filepath_get(const PreviewImage *prv);
std::optional<int> BKE_previewimg_deferred_thumb_source_get(const PreviewImage *prv);

ImBuf *BKE_previewimg_to_imbuf(const PreviewImage *prv, int size);
 
void BKE_previewimg_finish(PreviewImage *prv, int size);
bool BKE_previewimg_is_finished(const PreviewImage *prv, int size);
bool BKE_previewimg_is_invalid(const PreviewImage *prv);
 
PreviewImage *BKE_previewimg_cached_get(const char *name);

PreviewImage *BKE_previewimg_cached_ensure(const char *name);

PreviewImage *BKE_previewimg_cached_thumbnail_read(const char *name,
                                                   const char *filepath,
                                                   int source,
                                                   bool force_update);
 
void BKE_previewimg_cached_release(const char *name);
 
void BKE_previewimg_deferred_release(PreviewImage *prv);
 
void BKE_previewimg_blend_write(BlendWriter *writer, const PreviewImage *prv);
void BKE_previewimg_blend_read(BlendDataReader *reader, PreviewImage *prv);