Julian Eisel
9183f9f860
Adds some basic high-level explanations for editor/UI level asset APIs. Also moves one such comment from the source file to the header file, so it's in the same file as other API comments.
52 lines
1.9 KiB
C++
52 lines
1.9 KiB
C++
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup edasset
|
|
*
|
|
* Asset-handle is a temporary design, not part of the core asset system design.
|
|
*
|
|
* Currently asset-list items are just file directory items (#FileDirEntry). So an asset-handle
|
|
* just wraps a pointer to this. We try to abstract away the fact that it's just a file entry,
|
|
* although that doesn't always work (see #rna_def_asset_handle()).
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "DNA_ID_enums.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct AssetHandle;
|
|
struct AssetLibraryReference;
|
|
struct bContext;
|
|
|
|
const char *ED_asset_handle_get_name(const struct AssetHandle *asset);
|
|
struct AssetMetaData *ED_asset_handle_get_metadata(const struct AssetHandle *asset);
|
|
struct ID *ED_asset_handle_get_local_id(const struct AssetHandle *asset);
|
|
ID_Type ED_asset_handle_get_id_type(const struct AssetHandle *asset);
|
|
int ED_asset_handle_get_preview_icon_id(const struct AssetHandle *asset);
|
|
void ED_asset_handle_get_full_library_path(const struct bContext *C,
|
|
const struct AssetLibraryReference *asset_library_ref,
|
|
const struct AssetHandle *asset,
|
|
char r_full_lib_path[]);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|