orxTexture.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- 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 _orxTEXTURE_H_
#define _orxTEXTURE_H_
 
#include "orxInclude.h"
 
#include "display/orxDisplay.h"
#include "math/orxMath.h"
 

#define orxTEXTURE_KZ_RESOURCE_GROUP      "Texture"
#define orxTEXTURE_KZ_LOCALE_GROUP        "Texture"
 
#define orxTEXTURE_KZ_SCREEN_NAME         "orx:texture:screen"
#define orxTEXTURE_KZ_PIXEL_NAME          "orx:texture:pixel"
#define orxTEXTURE_KZ_TRANSPARENT_NAME    "orx:texture:transparent"
 
#define orxTEXTURE_KZ_LOGO_NAME           "orx:texture:logo"
 

typedef enum __orxTEXTURE_EVENT_t
{
  orxTEXTURE_EVENT_CREATE = 0,
  orxTEXTURE_EVENT_DELETE,
  orxTEXTURE_EVENT_LOAD,
 
  orxTEXTURE_EVENT_NUMBER,
 
  orxTEXTURE_EVENT_NONE = orxENUM_NONE
 
} orxTEXTURE_EVENT;
 

typedef struct __orxTEXTURE_t             orxTEXTURE;
 

extern orxDLLAPI void orxFASTCALL         orxTexture_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_Init();

extern orxDLLAPI void orxFASTCALL         orxTexture_Exit();
 

extern orxDLLAPI orxTEXTURE *orxFASTCALL  orxTexture_Create();

extern orxDLLAPI orxTEXTURE *orxFASTCALL  orxTexture_Load(const orxSTRING _zFileName, orxBOOL _bKeepInCache);

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_Delete(orxTEXTURE *_pstTexture);

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_ClearCache();

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_LinkBitmap(orxTEXTURE *_pstTexture, const orxBITMAP *_pstBitmap, const orxSTRING _zDataName, orxBOOL _bTransferOwnership);

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_UnlinkBitmap(orxTEXTURE *_pstTexture);
 

extern orxDLLAPI orxBITMAP *orxFASTCALL   orxTexture_GetBitmap(const orxTEXTURE *_pstTexture);

extern orxDLLAPI orxSTATUS orxFASTCALL    orxTexture_GetSize(const orxTEXTURE *_pstTexture, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight);

extern orxDLLAPI orxTEXTURE *orxFASTCALL  orxTexture_Get(const orxSTRING _zName);

extern orxDLLAPI const orxSTRING orxFASTCALL orxTexture_GetName(const orxTEXTURE *_pstTexture);

extern orxDLLAPI orxTEXTURE *orxFASTCALL  orxTexture_GetScreenTexture();

extern orxDLLAPI orxU32 orxFASTCALL       orxTexture_GetLoadCount();
 
#endif /* _orxTEXTURE_H_ */