orxBank.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2020 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxBANK_H_
#define _orxBANK_H_


#include "orxInclude.h"
#include "memory/orxMemory.h"


/* Internal Bank structure */
typedef struct __orxBANK_t orxBANK;

/* Define flags */
#define orxBANK_KU32_FLAG_NONE              0x00000000  
#define orxBANK_KU32_FLAG_NOT_EXPANDABLE    0x00000001  
extern orxDLLAPI void orxFASTCALL           orxBank_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL      orxBank_Init();

extern orxDLLAPI void orxFASTCALL           orxBank_Exit();

extern orxDLLAPI orxBANK *orxFASTCALL       orxBank_Create(orxU16 _u16NbElem, orxU32 _u32Size, orxU32 _u32Flags, orxMEMORY_TYPE _eMemType);

extern orxDLLAPI void orxFASTCALL           orxBank_Delete(orxBANK *_pstBank);

extern orxDLLAPI void *orxFASTCALL          orxBank_Allocate(orxBANK *_pstBank);

extern orxDLLAPI void *orxFASTCALL          orxBank_AllocateIndexed(orxBANK *_pstBank, orxU32 *_pu32ItemIndex, void **_ppPrevious);

extern orxDLLAPI void orxFASTCALL           orxBank_Free(orxBANK *_pstBank, void *_pCell);

extern orxDLLAPI void orxFASTCALL           orxBank_Clear(orxBANK *_pstBank);

extern orxDLLAPI void orxFASTCALL           orxBank_Compact(orxBANK *_pstBank);

extern orxDLLAPI void orxFASTCALL           orxBank_CompactAll();

extern orxDLLAPI void *orxFASTCALL          orxBank_GetNext(const orxBANK *_pstBank, const void *_pCell);

extern orxDLLAPI orxU32 orxFASTCALL         orxBank_GetIndex(const orxBANK *_pstBank, const void *_pCell);

extern orxDLLAPI void *orxFASTCALL          orxBank_GetAtIndex(const orxBANK *_pstBank, orxU32 _u32Index);

extern orxDLLAPI orxU32 orxFASTCALL         orxBank_GetCount(const orxBANK *_pstBank);


/*******************************************************************************
 * DEBUG FUNCTION
 ******************************************************************************/

#ifdef __orxDEBUG__

extern orxDLLAPI void orxFASTCALL           orxBank_DebugPrint(const orxBANK *_pstBank);

#endif /* __orxDEBUG__ */

#endif /* _orxBANK_H_ */