ScummVM API documentation
TwinE::HQR Namespace Reference

Functions

int32 getEntry (uint8 *ptr, const char *filename, int32 index)
 
int32 getEntry (uint8 *ptr, const TwineResource &resource)
 
int32 entrySize (const char *filename, int32 index)
 
int32 entrySize (const TwineResource &resource)
 
int32 numEntries (const char *filename)
 
int32 getAllocEntry (uint8 **ptr, const char *filename, int32 index)
 
int32 getAllocEntry (uint8 **ptr, const TwineResource &resource)
 
bool dumpEntry (const char *filename, int32 index, const char *targetFileName)
 Helper method to dump the content of the given hqr index to a file.
 
bool dumpEntry (const TwineResource &resource, const char *targetFileName)
 
int32 getVoxEntry (uint8 *ptr, const char *filename, int32 index, int32 hiddenIndex)
 
int32 getAllocVoxEntry (uint8 **ptr, const char *filename, int32 index, int32 hiddenIndex)
 
bool getPaletteEntry (Graphics::Palette &palette, const char *filename, int32 index)
 
bool getPaletteEntry (Graphics::Palette &palette, const TwineResource &resource)
 
Common::SeekableReadStreammakeReadStream (const char *filename, int index)
 
Common::SeekableReadStreammakeReadStream (const TwineResource &resource)
 

Detailed Description

Function Documentation

◆ getEntry()

int32 TwinE::HQR::getEntry ( uint8 *  ptr,
const char *  filename,
int32  index 
)

Get a HQR entry pointer

Parameters
ptrpointer to save the entry
filenameHQR file name
indexentry index to extract
Returns
entry real size

◆ entrySize()

int32 TwinE::HQR::entrySize ( const char *  filename,
int32  index 
)

Get a HQR entry pointer

Parameters
filenameHQR file name
indexentry index to extract
Returns
entry real size

◆ numEntries()

int32 TwinE::HQR::numEntries ( const char *  filename)

Get a HQR total number of entries

Parameters
filenameHQR file name
Returns
total number of entries

◆ getAllocEntry()

int32 TwinE::HQR::getAllocEntry ( uint8 **  ptr,
const char *  filename,
int32  index 
)

Get a HQR entry pointer with memory allocation

Parameters
ptrpointer to save the entry. This pointer is automatically freed and therefore must be initialized to nullptr on the first run.
filenameHQR file name
indexentry index to extract
Returns
entry real size

◆ getVoxEntry()

int32 TwinE::HQR::getVoxEntry ( uint8 *  ptr,
const char *  filename,
int32  index,
int32  hiddenIndex 
)

Get a HQR entry pointer

Parameters
ptrpointer to save the entry
filenameHQR file name
indexentry index to extract
Returns
entry real size

◆ getAllocVoxEntry()

int32 TwinE::HQR::getAllocVoxEntry ( uint8 **  ptr,
const char *  filename,
int32  index,
int32  hiddenIndex 
)

Get a HQR entry pointer with memory allocation

Parameters
ptrpointer to save the entry. This pointer is automatically freed and therefore must be initialized to nullptr on the first run.
filenameHQR file name
indexentry index to extract
Returns
entry real size