beastutils.h

Go to the documentation of this file.

/*
Copyright 2014 Autodesk, Inc.  All rights reserved.
Use of this software is subject to the terms of the Autodesk license agreement
provided at the time of installation or download, or which otherwise 
accompanies this software in either electronic or hard copy form.
*/


#ifndef BEASTUTILS_H
#define BEASTUTILS_H

#include "beastapitypes.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

ILB_DLL_FUNCTION ILBStatus ILBErrorToString(ILBStatus error, 
                                  ILBStringHandle* targetString);

ILB_DLL_FUNCTION ILBStatus ILBGetExtendErrorInformation(ILBStringHandle* targetString);

/*
 * Dumps the memory stats of the dll to the Debug console and puts the API
 * in an undefined state. NEVER CALL ANY OTHER BEAST API FUNCTIONS AFTER THIS!
 * Only works on debug builds, this means that it CAN only be used
 * internally for now. 
 * @returns ILB_ST_SUCCESS if there are no leaks or it's called running 
 * from a Release build
 * @todo Should we hide this function?
 */
ILB_DLL_FUNCTION ILBStatus ILBDumpMemoryStats();


#ifdef __cplusplus
}
#endif // __cplusplus


#endif // BEASTUTILS_H