Resource

Functions for managing resource types.

Namespace: dmResource
Include: #include <dmsdk/resource/resource.hpp>
TYPES
FDecryptResource Decrypts a file
FUNCTIONS
dmResource::Result AddFile(dmResource::HFactory factory, const char* path, uint32_t size, const void* resource) Adds a file to the resource system Any request for...
dmResource::Result Get(dmResource::HFactory factory, const char* name, void** resource) Get a resource from factory
dmResource::Result Get(dmResource::HFactory factory, dmhash_t name, void** resource) Get a resource from factory
 GetPath(dmResource::HFactory factory, const void* resource, uint64_t* hash) Returns the canonical path hash of a resource
bool PreloadHint(dmResource::HResourcePreloadHintInfo factory, const char* name) Hint the preloader what to load before Create is c...
void RegisterResourceDecryptionFunction(dmResource::FDecryptResource decrypt_resource) Registers a custom resource decryption function
void RegisterResourceReloadedCallback(dmResource::HFactory factory, dmResource::FResourceReloadedCallback callback, void* user_data) Function called when a resource has been reloaded.
void RegisterType()
void Release(dmResource::HFactory factory, void* resource) Release resource
dmResource::Result RemoveFile(dmResource::HFactory factory, const char* path) Removes a previously registered file from the reso...
void SetupType() Setup function pointers and context for a resource...

Functions

AddFile

dmResource::Result AddFile(dmResource::HFactory factory, const char* path, uint32_t size, const void* resource)

Adds a file to the resource system Any request for this path will go through any existing mounts first. If you wish to provide file overrides, please use the LiveUpdate feature for that. The file isn't persisted between sessions.

PARAMETERS

dmResource::HFactory factory Factory handle
const char* path The path of the resource
uint32_t size The size of the resource (in bytes)
const void* resource The resource payload

RETURNS

dmResource::Result on success.

Get

dmResource::Result Get(dmResource::HFactory factory, const char* name, void** resource)

Get a resource from factory

PARAMETERS

dmResource::HFactory factory Factory handle
const char* name Resource name
void** resource Created resource

RETURNS

dmResource::Result RESULT_OK on success

Get

dmResource::Result Get(dmResource::HFactory factory, dmhash_t name, void** resource)

Get a resource from factory

PARAMETERS

dmResource::HFactory factory Factory handle
dmhash_t name Resource name
void** resource Created resource

RETURNS

dmResource::Result RESULT_OK on success

GetPath

 GetPath(dmResource::HFactory factory, const void* resource, uint64_t* hash)

Returns the canonical path hash of a resource

PARAMETERS

dmResource::HFactory factory Factory handle
const void* resource Resource
uint64_t* hash Returned hash

RETURNS

on success

PreloadHint

bool PreloadHint(dmResource::HResourcePreloadHintInfo factory, const char* name)

Hint the preloader what to load before Create is called on the resource. The resources are not guaranteed to be loaded before Create is called. This function can be called from a worker thread.

PARAMETERS

dmResource::HResourcePreloadHintInfo factory Preloader handle
const char* name Resource name

RETURNS

bool if successfully invoking preloader.

RegisterResourceDecryptionFunction

void RegisterResourceDecryptionFunction(dmResource::FDecryptResource decrypt_resource)

Registers a custom resource decryption function

PARAMETERS

dmResource::FDecryptResource decrypt_resource The decryption function

RegisterResourceReloadedCallback

void RegisterResourceReloadedCallback(dmResource::HFactory factory, dmResource::FResourceReloadedCallback callback, void* user_data)

Function called when a resource has been reloaded.

PARAMETERS

dmResource::HFactory factory Handle of the factory to which the callback will be registered
dmResource::FResourceReloadedCallback callback Callback function to register
void* user_data User data that to

RegisterType

void RegisterType()

PARAMETERS

Release

void Release(dmResource::HFactory factory, void* resource)

Release resource

PARAMETERS

dmResource::HFactory factory Factory handle
void* resource Resource pointer

RemoveFile

dmResource::Result RemoveFile(dmResource::HFactory factory, const char* path)

Removes a previously registered file from the resource system

PARAMETERS

dmResource::HFactory factory Factory handle
const char* path The path of the resource

RETURNS

dmResource::Result on success.

SetupType

void SetupType()

Setup function pointers and context for a resource type

PARAMETERS

Types

FDecryptResource

Decrypts a file