IMB_thumbs.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include <cstdint>
 
struct ImBuf;

 
enum ThumbSize {
  THB_NORMAL,
  THB_LARGE,
  THB_FAIL,
};
 
enum ThumbSource : int8_t {
  THB_SOURCE_IMAGE,
  THB_SOURCE_MOVIE,
  THB_SOURCE_BLEND,
  THB_SOURCE_FONT,
  THB_SOURCE_OBJECT_IO,
};

#define THUMB_SIZE_MAX (100 * 1024 * 1024)
 
#define PREVIEW_RENDER_DEFAULT_HEIGHT 128
#define PREVIEW_RENDER_LARGE_HEIGHT 256

#define THUMB_DEFAULT_HASH "00000000000000000000000000000000"

ImBuf *IMB_thumb_create(const char *filepath, ThumbSize size, ThumbSource source, ImBuf *img);

ImBuf *IMB_thumb_read(const char *file_or_lib_path, ThumbSize size);

void IMB_thumb_delete(const char *file_or_lib_path, ThumbSize size);

ImBuf *IMB_thumb_manage(const char *file_or_lib_path, ThumbSize size, ThumbSource source);

void IMB_thumb_makedirs();

ImBuf *IMB_thumb_load_blend(const char *blen_path, const char *blen_group, const char *blen_id);

ImBuf *IMB_thumb_load_font(const char *filepath, unsigned int x, unsigned int y);
bool IMB_thumb_load_font_get_hash(char *r_hash);
 
ImBuf *IMB_font_preview(const char *filepath,
                        unsigned int width,
                        const float color[4],
                        const char *sample_text = nullptr);
 
/* Threading */
 
void IMB_thumb_locks_acquire();
void IMB_thumb_locks_release();
void IMB_thumb_path_lock(const char *path);
void IMB_thumb_path_unlock(const char *path);