orx  stable
Portable Game Engine
orxTexture.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
43 #ifndef _orxTEXTURE_H_
44 #define _orxTEXTURE_H_
45 
46 #include "orxInclude.h"
47 
48 #include "display/orxDisplay.h"
49 #include "math/orxMath.h"
50 
51 
54 #define orxTEXTURE_KZ_SCREEN_NAME "screen"
55 
56 #define orxTEXTURE_KZ_RESOURCE_GROUP "Texture"
57 
58 #define orxTEXTURE_KZ_PIXEL "pixel"
59 
60 
63 typedef enum __orxTEXTURE_EVENT_t
64 {
68 
70 
71  orxTEXTURE_EVENT_NONE = orxENUM_NONE
72 
74 
75 
77 typedef struct __orxTEXTURE_t orxTEXTURE;
78 
79 
82 extern orxDLLAPI void orxFASTCALL orxTexture_Setup();
83 
87 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Init();
88 
91 extern orxDLLAPI void orxFASTCALL orxTexture_Exit();
92 
93 
97 extern orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_Create();
98 
104 extern orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_CreateFromFile(const orxSTRING _zFileName, orxBOOL _bKeepInCache);
105 
110 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Delete(orxTEXTURE *_pstTexture);
111 
115 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_ClearCache();
116 
124 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_LinkBitmap(orxTEXTURE *_pstTexture, const orxBITMAP *_pstBitmap, const orxSTRING _zDataName, orxBOOL _bTransferOwnership);
125 
130 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_UnlinkBitmap(orxTEXTURE *_pstTexture);
131 
132 
137 extern orxDLLAPI orxBITMAP *orxFASTCALL orxTexture_GetBitmap(const orxTEXTURE *_pstTexture);
138 
145 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_GetSize(const orxTEXTURE *_pstTexture, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight);
146 
151 extern orxDLLAPI const orxSTRING orxFASTCALL orxTexture_GetName(const orxTEXTURE *_pstTexture);
152 
158 extern orxDLLAPI orxSTATUS orxFASTCALL orxTexture_SetColor(orxTEXTURE *_pstTexture, const orxCOLOR *_pstColor);
159 
163 extern orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_GetScreenTexture();
164 
168 extern orxDLLAPI orxU32 orxFASTCALL orxTexture_GetLoadCounter();
169 
170 #endif /* _orxTEXTURE_H_ */
171 
orxDLLAPI orxU32 orxFASTCALL orxTexture_GetLoadCounter()
orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_CreateFromFile(const orxSTRING _zFileName, orxBOOL _bKeepInCache)
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_LinkBitmap(orxTEXTURE *_pstTexture, const orxBITMAP *_pstBitmap, const orxSTRING _zDataName, orxBOOL _bTransferOwnership)
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Init()
orxDLLAPI orxBITMAP *orxFASTCALL orxTexture_GetBitmap(const orxTEXTURE *_pstTexture)
struct __orxTEXTURE_t orxTEXTURE
Definition: orxTexture.h:77
struct __orxBITMAP_t orxBITMAP
Definition: orxDisplay.h:82
orxTEXTURE_EVENT
Definition: orxTexture.h:63
orxDLLAPI const orxSTRING orxFASTCALL orxTexture_GetName(const orxTEXTURE *_pstTexture)
orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_Create()
orxSTATUS
Definition: orxType.h:243
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Delete(orxTEXTURE *_pstTexture)
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI void orxFASTCALL orxTexture_Setup()
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_SetColor(orxTEXTURE *_pstTexture, const orxCOLOR *_pstColor)
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_ClearCache()
orxDLLAPI void orxFASTCALL orxTexture_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_UnlinkBitmap(orxTEXTURE *_pstTexture)
orxDLLAPI orxTEXTURE *orxFASTCALL orxTexture_GetScreenTexture()
orxDLLAPI orxSTATUS orxFASTCALL orxTexture_GetSize(const orxTEXTURE *_pstTexture, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight)

Generated for orx by doxygen 1.5.6