Resources
Builtin engine resource types and a manager for such resources.
Classes
-
TResourceHandle— Represents a handle to a resource. -
IResourceListener— Interface that allows the implementing class to be notified when the resources it is referencing change. -
Resource— Base class for all resources. -
ResourceMetaData— Class containing meta-information describing a resource. -
BuiltinResources— Holds references to built-in resources used by the core engine. -
ShaderInclude— Raw text resource that serves as an include file for shaders. -
PackageResourceMetaData— Contains meta-data for a resource stored in a Package. -
PackageResourceUserMetaData— Contains user-specified meta-data for a resource stored in a Package. -
PackageMetaData— Contains meta-data for the entirety of a Package (not individual resources). -
Package— Contains Resources in a virtual file system, along with their associated meta-data. -
PackageManager— Handles loading, unloading and saving of packages. -
PlainText— A resource containing plain text data. -
Resources— Manager for dealing with all engine resources. -
ScriptCode— Resource containing script source code. -
ScriptCodeImportOptions— Contains import options you may use to control how is a file containing script source code importer.
Structs
-
TResourceHandle::Bool_struct -
PackageHierarchy— Contains a hierarchy of folders and resources within a package. -
PackageHierarchy::Entry— Resource or folder entry in the package hierarchy. -
SavePackageOptions— Options used for controlling the Package::Save operation. -
AcquirePackageReadLockOptions— Options that control how are package read locks acquired. -
AcquirePackageWriteLockOptions— Options that control how are package write locks acquired. -
PackageManagerSavePackageOptions— Options that control package save operation. -
PackageReadLock— Information about an acquired package read lock. -
PackageWriteLock— Information about an acquired package write lock. -
ResourcePackagePath— Contains a path to a resource within a package. -
ResourceLoadOptions— Options that may be used to customize resource load operation. -
ResourceSaveOptions— Options that control resource save operation.
Enums
-
BuiltinMesh— Types of builtin meshes that are always available. -
BuiltinTexture— Types of builtin textures that are always available. -
BuiltinShader— Types of builtin shaders that are always available. -
PackageResourceFlag— Flags that can be set per-resource package meta-data. -
PackageHierarchy::EntryType— Type of entry within the package hierarchy. -
PackageResourceLoadState— Load state of a resource within the package. -
AcquirePackageLockResult— Potential resulting status codes when attempting to acquire a package lock.
Free functions
B3DStaticResourceCast
TResourceHandle<ResourceTypeLhs, IsWeakHandleLhs> B3DStaticResourceCast(const TResourceHandle<ResourceTypeRhs, IsWeakHandleRhs> &other)
B3DStaticResourceCast
TResourceHandle<ResourceTypeLhs, false> B3DStaticResourceCast(const TResourceHandle<ResourceTypeRhs, IsWeakHandleRhs> &other)
B3DStaticResourceCast
TResourceHandle<ResourceTypeLhs, IsWeakHandleLhs> B3DStaticResourceCast(const TResourceHandle<ResourceTypeRhs, IsWeakHandleRhs> &other)
Casts one resource handle to another.
B3DStaticResourceCast
TResourceHandle<ResourceTypeLhs, false> B3DStaticResourceCast(const TResourceHandle<ResourceTypeRhs, IsWeakHandleRhs> &other)
Casts one resource handle to another.
GetBuiltinResources
BuiltinResources &GetBuiltinResources()
Provides easy access to BuiltinResources.
Internal
Symbols intended for engine-internal use. Not part of the public API.
Classes
-
ResourceHandle— Represents a handle to a resource. -
WeakResourceHandle— Implementation of ResourceHandle for weak handles. -
StrongResourceHandle— Implementation of ResourceHandle for strong (non-weak) handles. -
ResourceListenerManager— Handles all active implementations of IResourceListener interface and notifies them when events they're listening to occur. -
BuiltinResourcesHelper— Provides various methods commonly used for managing builtin resources. -
EngineShaderIncludeHandler— Shader include handler for the engine. -
PlainTextImporter— Imports plain text files (.txt, .xml, .json). -
ScriptCodeImporter— Imports C# script source code files (.cs).
Structs
-
Package::ResourceInformation— Runtime information about a resource stored in the package. -
Resources::LoadedResourceInformation— Information about a loaded resource. -
Resources::InProgressLoadInformation— Information about an in-progress resource load. -
Resources::LoadProgress— Stores load progress for a single resource. -
ResourceHandleData— Data that is shared between all resource handles. -
RuntimePackageInformation— Information about a package managed by PackageManager.