FileIO
File read/write support for FidelityFX Cauldron Framework.
Functions
|
Return type |
Description |
|---|---|
|
int64_t |
cauldron::ReadFileAll (const wchar_t* fileName, void* buffer, size_t bufferLen)
Performs a full file read.
|
|
int64_t |
cauldron::ReadFilePartial ( const wchar_t* fileName, void* buffer, size_t bufferLen, int64_t readOffset = 0 )
Performs a partial file read.
|
|
int64_t |
cauldron::GetFileSize (const wchar_t* fileName)
Fetches the size (in bytes) of a file.
|
|
bool |
cauldron::ParseJsonFile (const wchar_t* fileName, json& jsonOut)
Helper to read and parse json files.
|
Detailed description
File read/write support for FidelityFX Cauldron Framework.
Global functions
ReadFileAll
Copied!
int64_t cauldron::ReadFileAll (
const wchar_t* fileName,
void* buffer,
size_t bufferLen
)Performs a full file read.
Parameters:
|
fileName |
The file to read. |
|
buffer |
The buffer into which to copy read file data. |
|
bufferLen |
The amount of data to read. |
Returns:
The number of bytes read.
ReadFilePartial
Copied!
int64_t cauldron::ReadFilePartial (
const wchar_t* fileName,
void* buffer,
size_t bufferLen,
int64_t readOffset = 0
)Performs a partial file read.
Parameters:
|
fileName |
The file to read. |
|
buffer |
The buffer into which to copy read file data. |
|
bufferLen |
The amount of data to read. |
|
readOffset |
Offset in the file where to start reading. |
Returns:
The number of bytes read.
GetFileSize
Copied!
int64_t cauldron::GetFileSize (const wchar_t* fileName)Fetches the size (in bytes) of a file.
Parameters:
|
fileName |
The file whose size we are querying. |
Returns:
The number of bytes contained in the file.
ParseJsonFile
Copied!
bool cauldron::ParseJsonFile (const wchar_t* fileName, json& jsonOut)Helper to read and parse json files.
Parameters:
|
fileName |
The json file to read and parse. |
|
jsonOut |
The json data read from file. |
Returns:
True if operation succeeded, false otherwise.
