920e709069
When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608
145 lines
3.8 KiB
C++
145 lines
3.8 KiB
C++
/* 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;
|
|
struct GPUTexture;
|
|
struct ID;
|
|
struct ImBuf;
|
|
struct PreviewImage;
|
|
|
|
enum ThumbSource : int8_t;
|
|
|
|
namespace blender::bke {
|
|
|
|
struct PreviewDeferredLoadingData;
|
|
|
|
struct PreviewImageRuntime {
|
|
/** Used by previews outside of ID context. */
|
|
int icon_id = 0;
|
|
int16_t tag = 0;
|
|
|
|
std::array<GPUTexture *, NUM_ICON_SIZES> gputexture = {};
|
|
|
|
/** Used to store data to defer the loading of the preview. If empty, loading is not deferred. */
|
|
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();
|
|
|
|
/**
|
|
* Free the preview image for use in list.
|
|
*/
|
|
void BKE_previewimg_freefunc(void *link);
|
|
|
|
/**
|
|
* Free the preview image.
|
|
*/
|
|
void BKE_previewimg_free(PreviewImage **prv);
|
|
|
|
/**
|
|
* Clear the preview image or icon, but does not free it.
|
|
*/
|
|
void BKE_previewimg_clear(PreviewImage *prv);
|
|
|
|
/**
|
|
* Clear the preview image or icon at a specific size.
|
|
*/
|
|
void BKE_previewimg_clear_single(PreviewImage *prv, enum eIconSizes size);
|
|
|
|
/**
|
|
* Get the preview from any pointer.
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
* Trigger deferred loading of a custom image file into the preview buffer.
|
|
*/
|
|
void BKE_previewimg_id_custom_set(ID *id, const char *filepath);
|
|
|
|
/**
|
|
* Free the preview image belonging to the id.
|
|
*/
|
|
void BKE_previewimg_id_free(ID *id);
|
|
|
|
/**
|
|
* Create a new preview image.
|
|
*/
|
|
PreviewImage *BKE_previewimg_create();
|
|
|
|
/**
|
|
* Create a copy of the preview image.
|
|
*/
|
|
PreviewImage *BKE_previewimg_copy(const PreviewImage *prv);
|
|
|
|
/**
|
|
* Duplicate preview image from \a id and clear icon_id,
|
|
* to be used by data-block copy functions.
|
|
*/
|
|
void BKE_previewimg_id_copy(ID *new_id, const ID *old_id);
|
|
|
|
/**
|
|
* Retrieve existing or create new preview image.
|
|
*/
|
|
PreviewImage *BKE_previewimg_id_ensure(ID *id);
|
|
|
|
/**
|
|
* Handle deferred (lazy) loading/generation of preview image, if needed.
|
|
* For now, only used with file thumbnails.
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
* Create an #ImBuf holding a copy of the preview image buffer in \a prv.
|
|
* \note The returned image buffer has to be freed (#IMB_freeImBuf()).
|
|
*/
|
|
ImBuf *BKE_previewimg_to_imbuf(PreviewImage *prv, int size);
|
|
|
|
void BKE_previewimg_finish(PreviewImage *prv, int size);
|
|
bool BKE_previewimg_is_finished(const PreviewImage *prv, int size);
|
|
|
|
PreviewImage *BKE_previewimg_cached_get(const char *name);
|
|
|
|
/**
|
|
* Generate an empty #PreviewImage, if not yet existing.
|
|
*/
|
|
PreviewImage *BKE_previewimg_cached_ensure(const char *name);
|
|
|
|
/**
|
|
* Generate a #PreviewImage from given `filepath`, using thumbnails management, if not yet
|
|
* existing. Does not actually generate the preview, #BKE_previewimg_ensure() must be called for
|
|
* that.
|
|
*/
|
|
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);
|