73 lines
1.8 KiB
C
73 lines
1.8 KiB
C
/**
|
|
* Copyright (c) 2023 Dominic Masters
|
|
*
|
|
* This software is released under the MIT License.
|
|
* https://opensource.org/licenses/MIT
|
|
*/
|
|
|
|
#pragma once
|
|
#include "dawn.h"
|
|
|
|
/**
|
|
* Initializes the asset manager.
|
|
*/
|
|
void assetInit();
|
|
|
|
/**
|
|
* Opens an asset by its filename (within the asset archive). Asset paths should
|
|
* always use the unix forward slash '/' as a path separator.
|
|
*
|
|
* @param path The path to the asset within the archive.
|
|
*/
|
|
void assetOpen(const char_t *path);
|
|
|
|
/**
|
|
* Returns the size of the asset.
|
|
*
|
|
* @return The size of the asset.
|
|
*/
|
|
size_t assetGetSize();
|
|
|
|
/**
|
|
* Reads the asset into the buffer.
|
|
*
|
|
* @param buffer The buffer to read the asset into.
|
|
* @param bufferSize The size of the buffer.
|
|
* @return The amount of data read.
|
|
*/
|
|
size_t assetRead(uint8_t *buffer, size_t bufferSize);
|
|
|
|
/**
|
|
* Reads ahead in the buffer until either the end of the buffer, or the
|
|
* specified character is found. Return value will be -1 if the character was
|
|
* not found.
|
|
*
|
|
* Buffer can be NULL if you just want to skip ahead.
|
|
*
|
|
* Returned value will be either the amount of data read into the buffer, which
|
|
* excludes the extra 1 character that was read from the asset. If the character
|
|
* was not found, -1 will be returned.
|
|
*
|
|
* @param buffer Buffer to read into.
|
|
* @param c Character to read until.
|
|
* @param maxLength Maximum length to read.
|
|
* @return -1 if the character was not found, otherwise the amount of data read.
|
|
*/
|
|
size_t assetReadUntil(uint8_t *buffer, const char_t c, const size_t maxLength);
|
|
|
|
/**
|
|
* Skips ahead in the buffer by the specified length.
|
|
*
|
|
* @param length The length to skip ahead by.
|
|
*/
|
|
void assetSkip(const size_t length);
|
|
|
|
/**
|
|
* Closes the asset.
|
|
*/
|
|
void assetClose();
|
|
|
|
/**
|
|
* Destroys and cleans up the asset manager.
|
|
*/
|
|
void assetDispose(); |