NcEngine
Functions
Assets.h File Reference
#include "ncasset/AssetType.h"
#include "ncengine/asset/AssetViews.h"
#include <span>

Go to the source code of this file.

Functions

bool nc::asset::LoadAudioClipAsset (const std::string &path)
 
bool nc::asset::LoadAudioClipAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadAudioClipAsset (const std::string &path)
 
void nc::asset::UnloadAllAudioClipAssets ()
 
auto nc::asset::AcquireAudioClipAsset (const std::string &path) -> AudioClipView
 
auto nc::asset::AcquireAudioClipAsset (AssetId id) -> AudioClipView
 
bool nc::asset::LoadMeshColliderAsset (const std::string &path)
 
bool nc::asset::LoadMeshColliderAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadMeshColliderAsset (const std::string &path)
 
void nc::asset::UnloadAllMeshColliderAssets ()
 
auto nc::asset::AcquireMeshColliderAsset (const std::string &path) -> MeshColliderView
 
auto nc::asset::AcquireMeshColliderAsset (AssetId id) -> MeshColliderView
 
bool nc::asset::LoadConvexHullAsset (const std::string &path)
 
bool nc::asset::LoadConvexHullAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadConvexHullAsset (const std::string &path)
 
void nc::asset::UnloadAllConvexHullAssets ()
 
auto nc::asset::AcquireConvexHullAsset (const std::string &path) -> ConvexHullView
 
auto nc::asset::AcquireConvexHullAsset (AssetId id) -> ConvexHullView
 
bool nc::asset::LoadCubeMapAsset (const std::string &path)
 
bool nc::asset::LoadCubeMapAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadCubeMapAsset (const std::string &paths)
 
void nc::asset::UnloadAllCubeMapAssets ()
 
auto nc::asset::AcquireCubeMapAsset (const std::string &path) -> CubeMapView
 
auto nc::asset::AcquireCubeMapAsset (AssetId id) -> CubeMapView
 
bool nc::asset::LoadMeshAsset (const std::string &path)
 
bool nc::asset::LoadMeshAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadMeshAsset (const std::string &path)
 
void nc::asset::UnloadAllMeshAssets ()
 
auto nc::asset::AcquireMeshAsset (const std::string &path) -> MeshView
 
auto nc::asset::AcquireMeshAsset (AssetId id) -> MeshView
 
bool nc::asset::LoadTextureAsset (const std::string &path)
 
bool nc::asset::LoadTextureAssets (std::span< const std::string > paths)
 
bool nc::asset::LoadTextureFromMemory (const std::string &key, Texture texture)
 
bool nc::asset::LoadTextureFromRGBA (const std::string &key, std::span< const uint8_t > rgbaData, uint32_t width, uint32_t height, TextureFormat format=TextureFormat::RGBA8_UNORM)
 
bool nc::asset::UnloadTextureAsset (const std::string &path)
 
void nc::asset::UnloadAllTextureAssets ()
 
auto nc::asset::AcquireTextureAsset (const std::string &path) -> TextureView
 
auto nc::asset::AcquireTextureAsset (AssetId id) -> TextureView
 
bool nc::asset::LoadSkeletalAnimationAsset (const std::string &path)
 
bool nc::asset::LoadSkeletalAnimationAssets (std::span< const std::string > paths)
 
bool nc::asset::UnloadSkeletalAnimationAsset (const std::string &path)
 
void nc::asset::UnloadAllSkeletalAnimationAssets ()
 
auto nc::asset::AcquireSkeletalAnimationAsset (const std::string &path) -> SkeletalAnimationView
 
auto nc::asset::AcquireSkeletalAnimationAsset (AssetId id) -> SkeletalAnimationView
 
bool nc::asset::LoadFont (const FontInfo &font)
 
bool nc::asset::LoadFonts (std::span< const FontInfo > font)
 
bool nc::asset::UnloadFont (const FontInfo &font)
 
void nc::asset::UnloadAllFonts ()
 
auto nc::asset::AcquireFont (const FontInfo &font) -> FontView
 

Detailed Description

Copyright
Jaremie Romer and McCallister Romer 2025

Function Documentation

◆ LoadAudioClipAsset()

bool nc::asset::LoadAudioClipAsset ( const std::string &  path)

Assets must be loaded before dependent objects are created and should be unloaded only when they are no longer in use.

Paths should be relative to directories specified in the config. Passing true for isExternal allows paths to be absolute or relative to the executable. Duplicate loads are ignored. Supported file types: .nca

◆ LoadConvexHullAsset()

bool nc::asset::LoadConvexHullAsset ( const std::string &  path)

Supported file types: .nca

◆ LoadCubeMapAsset()

bool nc::asset::LoadCubeMapAsset ( const std::string &  path)

Supported file types: .nca

Note
Unloading textures invalidates all CubeMapViews. It is intended to be done on scene change.

◆ LoadFont()

bool nc::asset::LoadFont ( const FontInfo &  font)

Supported file types: .ttf

◆ LoadMeshAsset()

bool nc::asset::LoadMeshAsset ( const std::string &  path)

Supported file types: .nca

Note
Unloading meshes invalidates all MeshViews. It is intended to be done on scene change.

◆ LoadMeshColliderAsset()

bool nc::asset::LoadMeshColliderAsset ( const std::string &  path)

Supported file types: .nca

◆ LoadSkeletalAnimationAsset()

bool nc::asset::LoadSkeletalAnimationAsset ( const std::string &  path)

Supported file types: .nca

Note
Unloading skeletal animations invalidates all SkeletalAnimations. It is intended to be done on scene change.

◆ LoadTextureAsset()

bool nc::asset::LoadTextureAsset ( const std::string &  path)

Supported file types: .nca, raw texture data

Note
Unloading textures invalidates all TextureViews. It is intended to be done on scene change.