include/memory/orxMemory.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2011 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 _orxMEMORY_H_
#define _orxMEMORY_H_


#include "orxInclude.h"


typedef enum __orxMEMORY_TYPE_t
{
  orxMEMORY_TYPE_MAIN = 0,              
  orxMEMORY_TYPE_VIDEO,                 
  orxMEMORY_TYPE_SPRITE,                
  orxMEMORY_TYPE_BACKGROUND,            
  orxMEMORY_TYPE_PALETTE,               
  orxMEMORY_TYPE_CONFIG,                
  orxMEMORY_TYPE_TEXT,                  
  orxMEMORY_TYPE_TEMP,                  
  orxMEMORY_TYPE_NUMBER,                
  orxMEMORY_TYPE_NONE = orxENUM_NONE    
} orxMEMORY_TYPE;


extern orxDLLAPI void orxFASTCALL       orxMemory_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL  orxMemory_Init();

extern orxDLLAPI void orxFASTCALL       orxMemory_Exit();

extern orxDLLAPI void *orxFASTCALL      orxMemory_Allocate(orxU32 _u32Size, orxMEMORY_TYPE _eMemType);

extern orxDLLAPI void orxFASTCALL       orxMemory_Free(void *_pMem);

extern orxDLLAPI void *orxFASTCALL      orxMemory_Copy(void *_pDest, const void *_pSrc, orxU32 _u32Size);

extern orxDLLAPI void *orxFASTCALL      orxMemory_Move(void *_pDest, void *_pSrc, orxU32 _u32Size);

extern orxDLLAPI orxU32 orxFASTCALL     orxMemory_Compare(const void *_pMem1, const void *_pMem2, orxU32 _u32Size);

extern orxDLLAPI void *orxFASTCALL      orxMemory_Set(void *_pDest, orxU8 _u8Data, orxU32 _u32Size);

extern orxDLLAPI void *orxFASTCALL      orxMemory_Zero(void *_pDest, orxU32 _u32Size);

extern orxDLLAPI void *orxFASTCALL      orxMemory_Reallocate(void *_pMem, orxU32 _u32Size);

#endif /* _orxMEMORY_H_ */