ED_asset_list.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <string>
 
#include "BLI_function_ref.hh"
 
struct AssetHandle;
struct AssetLibraryReference;
struct bContext;
struct ID;
struct ImBuf;
struct wmNotifier;
struct wmRegionListenerParams;
namespace blender::asset_system {
class AssetLibrary;
class AssetRepresentation;
}  // namespace blender::asset_system
 
namespace blender::ed::asset::list {
 
void asset_reading_region_listen_fn(const wmRegionListenerParams *params);
 
asset_system::AssetLibrary *library_get_once_available(
    const AssetLibraryReference &library_reference);
 
using AssetListHandleIterFn = FunctionRef<bool(AssetHandle)>;
using AssetListIterFn = FunctionRef<bool(asset_system::AssetRepresentation &)>;
 
void iterate(const AssetLibraryReference &library_reference,
             AssetListHandleIterFn fn,
             FunctionRef<bool(asset_system::AssetRepresentation &)> prefilter_fn = nullptr);
void iterate(const AssetLibraryReference &library_reference, AssetListIterFn fn);
 
void storage_fetch(const AssetLibraryReference *library_reference, const bContext *C);
bool is_loaded(const AssetLibraryReference *library_reference);
void previews_fetch(const AssetLibraryReference *library_reference, const bContext *C);
void clear(const AssetLibraryReference *library_reference, const bContext *C);
void clear_all_library(const bContext *C);
bool storage_has_list_for_library(const AssetLibraryReference *library_reference);
void storage_tag_main_data_dirty();
void storage_id_remap(ID *id_old, ID *id_new);
void storage_exit();
 
AssetHandle asset_handle_get_by_index(const AssetLibraryReference *library_reference,
                                      int asset_index);
asset_system::AssetRepresentation *asset_get_by_index(
    const AssetLibraryReference &library_reference, int asset_index);
 
bool asset_image_is_loading(const AssetLibraryReference *library_reference,
                            const AssetHandle *asset_handle);
void asset_preview_ensure_requested(const bContext &C,
                                    const AssetLibraryReference *library_reference,
                                    AssetHandle *asset_handle);
ImBuf *asset_image_get(const AssetHandle *asset_handle);
 
bool listen(const wmNotifier *notifier);
int size(const AssetLibraryReference *library_reference);
 
}  // namespace blender::ed::asset::list