Blender  V3.3
Macros | Functions
BKE_preferences.h File Reference
#include "BLI_compiler_attrs.h"

Go to the source code of this file.

Macros

#define BKE_PREFS_ASSET_LIBRARY_DEFAULT_NAME   N_("User Library")
 

Functions

struct bUserAssetLibraryBKE_preferences_asset_library_add (struct UserDef *userdef, const char *name, const char *path) ATTR_NONNULL(1)
 
void BKE_preferences_asset_library_remove (struct UserDef *userdef, struct bUserAssetLibrary *library) ATTR_NONNULL()
 
void BKE_preferences_asset_library_name_set (struct UserDef *userdef, struct bUserAssetLibrary *library, const char *name) ATTR_NONNULL()
 
void BKE_preferences_asset_library_path_set (struct bUserAssetLibrary *library, const char *path) ATTR_NONNULL()
 
struct bUserAssetLibraryBKE_preferences_asset_library_find_from_index (const struct UserDef *userdef, int index) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
 
struct bUserAssetLibraryBKE_preferences_asset_library_find_from_name (const struct UserDef *userdef, const char *name) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
 
struct bUserAssetLibraryBKE_preferences_asset_library_containing_path (const struct UserDef *userdef, const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
 
int BKE_preferences_asset_library_get_index (const struct UserDef *userdef, const struct bUserAssetLibrary *library) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
 
void BKE_preferences_asset_library_default_add (struct UserDef *userdef) ATTR_NONNULL()
 

Macro Definition Documentation

◆ BKE_PREFS_ASSET_LIBRARY_DEFAULT_NAME

#define BKE_PREFS_ASSET_LIBRARY_DEFAULT_NAME   N_("User Library")

Name of the asset library added by default. Needs translation with DATA_() still.

Definition at line 19 of file BKE_preferences.h.

Function Documentation

◆ BKE_preferences_asset_library_add()

struct bUserAssetLibrary* BKE_preferences_asset_library_add ( struct UserDef userdef,
const char *  name,
const char *  path 
)

◆ BKE_preferences_asset_library_containing_path()

struct bUserAssetLibrary* BKE_preferences_asset_library_containing_path ( const struct UserDef userdef,
const char *  path 
)

Return the bUserAssetLibrary that contains the given file/directory path. The given path can be the library's top-level directory, or any path inside that directory.

When more than one asset libraries match, the first matching one is returned (no smartness when there nested asset libraries).

Return NULL when no such asset library is found.

Referenced by asset_bundle_install_poll(), and BKE_asset_library_find_suitable_root_path_from_path().

◆ BKE_preferences_asset_library_default_add()

void BKE_preferences_asset_library_default_add ( struct UserDef userdef)

◆ BKE_preferences_asset_library_find_from_index()

struct bUserAssetLibrary* BKE_preferences_asset_library_find_from_index ( const struct UserDef userdef,
int  index 
)

◆ BKE_preferences_asset_library_find_from_name()

struct bUserAssetLibrary* BKE_preferences_asset_library_find_from_name ( const struct UserDef userdef,
const char *  name 
)

◆ BKE_preferences_asset_library_get_index()

int BKE_preferences_asset_library_get_index ( const struct UserDef userdef,
const struct bUserAssetLibrary library 
)

◆ BKE_preferences_asset_library_name_set()

void BKE_preferences_asset_library_name_set ( struct UserDef userdef,
struct bUserAssetLibrary library,
const char *  name 
)

◆ BKE_preferences_asset_library_path_set()

void BKE_preferences_asset_library_path_set ( struct bUserAssetLibrary library,
const char *  path 
)

Set the library path, ensuring it is pointing to a directory. Single blend files can only act as "Current File" library; libraries on disk should always be directories. If the path does not exist, that's fine; it can created as directory if necessary later.

Definition at line 69 of file preferences.c.

References BLI_is_file(), BLI_path_parent_dir(), BLI_strncpy(), and library.

◆ BKE_preferences_asset_library_remove()

void BKE_preferences_asset_library_remove ( struct UserDef userdef,
struct bUserAssetLibrary library 
)

Unlink and free a library preference member.

Note
Free's library itself.

Definition at line 51 of file preferences.c.

References UserDef::asset_libraries, BLI_freelinkN(), and library.

Referenced by preferences_asset_library_remove_exec(), and blender::bke::tests::AssetCatalogTest::save_from_memory_into_existing_asset_lib().