const char *destfile_or_dir,
const char *srcdir,
|buildmode||The type of FSB file(s) to generate. Either FSBANK_BUILDMODE_SINGLE, FSBANK_BUILDMODE_MULTI or FSBANK_BUILDMODE_INTERLEAVED.|
|platform||The platform to target. This may be nescessary for platforms such as gamecube which require 32 byte padding.|
|format||The compression destination format. See FSBANK_FORMAT for a description of each format.|
|basicheaders||If set to TRUE, this generates FSBs with small sample header data. They only contain basic information such as sample length, and everything else has its attributes inherited from the first sample (for example the default frequency). Set to 0 by default.|
|destfile_or_dir||Destination filename if using FSBANK_BUILDMODE_SINGLE or FSBANK_BUILDMODE_INTERLEAVED. Destination directory if using FSBANK_BUILDMODE_MULTI.|
|numsrcfiles||The number of source files to add to the FSB target.|
|srcfile||Array of strings containing absolute paths to the source files to be added to the FSB target.|
|defaults||Array of FSBANK_SAMPLE_DEFAULTS structures that align with the src file string array. This is used to specify defaults for the files being built so they load that way in FMOD for playback. Can be NULL. See remarks if NULL.|
|dupdirstructure||For format type FSBANK_BUILDMODE_MULTI only. This will create the same source directory structure to the destination target directory. FALSE as default.|
|srcdir||Only if dupdirstructure = TRUE. The root of the source directory to be recreated in the destination directory. NULL as default if dupdirstructure is not specified.|
|createincludes||Create C header files with |
|abortonerror||If set to TRUE, compilation will be aborted if an error occurs (i.e. file not found), all output/intermediate files will be deleted and FSBANK_ERR_COMPILATION_ABORTED will be returned|
Return ValueOn success, FSBANK_OK is returned.
On failure, an FSBANK_RESULT error code is returned.
RemarksThis is a blocking function. You may want to execute this function from a thread to allow it to compile in the background (ie to update a GUI).
'basicheaders' are useful to save memory in a game when an FSB has been generated with thousands of samples in it.
Basicheaders does not refer to the C header file generated, it refers to the data stored inside the FSB.
If defaults are not specified for samples, for PlayStation 2 VAG, XBox XADPCM and Gamecube XADPCM, samples/streams are automatically set to FSOUND_HW3D if mono, FSOUND_HW2D if stereo.
See AlsoFSBANK_BUILDMODE , FSBANK_FORMAT , FSBANK_PLATFORM , FSBANK_RESULT , FSBANK_SAMPLE_DEFAULTS , FSBank_SetBuildCancel
This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2003. All rights reserved.
Generated Wed Apr 07 15:29:01 2004 by SourceDoc v0.10, the automated source code documenter.