All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kzu_binary_loader.h File Reference

Binary loader for .kzb format. More...

Namespaces

 kanzi
 

Typedefs

typedef kzsError(* KzuBinaryLoaderValidator )(kzString binaryPath, void *userData, kzBool *out_valid)
 Callback that is asked for if a binary name is valid for loading. More...
 

Functions

kzsError kzuBinaryLoaderCreate (const KzcMemoryManager *memoryManager, kanzi::ResourceManager *resourceManager, KzuBinaryLoader **out_binaryLoader)
 Creates a new binary loader. More...
 
kzsError kzuBinaryLoaderDelete (struct KzuBinaryLoader *binaryLoader)
 Deletes a binary loader. More...
 
KANZI_API kzsError kzuBinaryLoaderSetValidator (struct KzuBinaryLoader *binaryLoader, KzuBinaryLoaderValidator validator, void *userData)
 Sets a callback that is asked for if a binary name is valid for loading. More...
 
kzsError kzuBinaryLoaderAddBinary (const struct KzuBinaryLoader *binaryLoader, kzString binaryPath)
 Reads the directory structure of given file resource to memory and merges it with the current state. More...
 
kzsError kzuBinaryLoaderAddBinaryMemory (const struct KzuBinaryLoader *binaryLoader, kzUint byteCount, const kzByte *bytes)
 Reads the directory structure of given memory block to memory and merges it with the current state. More...
 
kzsError kzuBinaryLoaderAddMemoryMappedBinary (const struct KzuBinaryLoader *binaryLoader, kzString binaryPath)
 Maps the binary file to memory and reads the directory structure from it and merges it with the current state. More...
 
kzsException kzuBinaryLoaderAddBinaryConfig (const struct KzuBinaryLoader *binaryLoader, kzString configPath, kzBool useMemoryMapping)
 Reads the given binary config file and adds all of the listed binary files to the binary loader. More...
 

Detailed Description

Binary loader for .kzb format.

Copyright 2008-2020 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzuBinaryLoaderValidator)(kzString binaryPath, void *userData, kzBool *out_valid)

Callback that is asked for if a binary name is valid for loading.

Function Documentation

kzsError kzuBinaryLoaderCreate ( const KzcMemoryManager memoryManager,
kanzi::ResourceManager resourceManager,
KzuBinaryLoader **  out_binaryLoader 
)

Creates a new binary loader.

kzsError kzuBinaryLoaderDelete ( struct KzuBinaryLoader binaryLoader)

Deletes a binary loader.

KANZI_API kzsError kzuBinaryLoaderSetValidator ( struct KzuBinaryLoader binaryLoader,
KzuBinaryLoaderValidator  validator,
void *  userData 
)

Sets a callback that is asked for if a binary name is valid for loading.

kzsError kzuBinaryLoaderAddBinary ( const struct KzuBinaryLoader binaryLoader,
kzString  binaryPath 
)

Reads the directory structure of given file resource to memory and merges it with the current state.

kzsError kzuBinaryLoaderAddBinaryMemory ( const struct KzuBinaryLoader binaryLoader,
kzUint  byteCount,
const kzByte bytes 
)

Reads the directory structure of given memory block to memory and merges it with the current state.

kzsError kzuBinaryLoaderAddMemoryMappedBinary ( const struct KzuBinaryLoader binaryLoader,
kzString  binaryPath 
)

Maps the binary file to memory and reads the directory structure from it and merges it with the current state.

kzsException kzuBinaryLoaderAddBinaryConfig ( const struct KzuBinaryLoader binaryLoader,
kzString  configPath,
kzBool  useMemoryMapping 
)

Reads the given binary config file and adds all of the listed binary files to the binary loader.