orx: include/display/orxGraphic.h Source File

Go to the documentation of this file.
00001 /* Orx - Portable Game Engine
00002  *
00003  * Copyright (c) 2008-2011 Orx-Project
00004  *
00005  * This software is provided 'as-is', without any express or implied
00006  * warranty. In no event will the authors be held liable for any damages
00007  * arising from the use of this software.
00008  *
00009  * Permission is granted to anyone to use this software for any purpose,
00010  * including commercial applications, and to alter it and redistribute it
00011  * freely, subject to the following restrictions:
00012  *
00013  *    1. The origin of this software must not be misrepresented; you must not
00014  *    claim that you wrote the original software. If you use this software
00015  *    in a product, an acknowledgment in the product documentation would be
00016  *    appreciated but is not required.
00017  *
00018  *    2. Altered source versions must be plainly marked as such, and must not be
00019  *    misrepresented as being the original software.
00020  *
00021  *    3. This notice may not be removed or altered from any source
00022  *    distribution.
00023  */
00024 
00047 #ifndef _orxGRAPHIC_H_
00048 #define _orxGRAPHIC_H_
00049 
00050 #include "orxInclude.h"
00051 
00052 #include "object/orxStructure.h"
00053 #include "display/orxDisplay.h"
00054 
00055 
00058 #define orxGRAPHIC_KU32_FLAG_NONE             0x00000000  
00060 #define orxGRAPHIC_KU32_FLAG_2D               0x00000001  
00061 #define orxGRAPHIC_KU32_FLAG_TEXT             0x00000002  
00063 #define orxGRAPHIC_KU32_MASK_TYPE             0x00000003  
00065 #define orxGRAPHIC_KU32_FLAG_FLIP_X           0x00000004  
00066 #define orxGRAPHIC_KU32_FLAG_FLIP_Y           0x00000008  
00067 #define orxGRAPHIC_KU32_MASK_FLIP_BOTH        0x0000000C  
00069 #define orxGRAPHIC_KU32_FLAG_ALIGN_CENTER     0x00000000  
00070 #define orxGRAPHIC_KU32_FLAG_ALIGN_LEFT       0x00000010  
00071 #define orxGRAPHIC_KU32_FLAG_ALIGN_RIGHT      0x00000020  
00072 #define orxGRAPHIC_KU32_FLAG_ALIGN_TOP        0x00000040  
00073 #define orxGRAPHIC_KU32_FLAG_ALIGN_BOTTOM     0x00000080  
00074 #define orxGRAPHIC_KU32_FLAG_ALIGN_TRUNCATE   0x00000100  
00075 #define orxGRAPHIC_KU32_FLAG_ALIGN_ROUND      0x00000200  
00077 #define orxGRAPHIC_KU32_MASK_USER_ALL         0x00000FFF  
00082 typedef struct __orxGRAPHIC_t                 orxGRAPHIC;
00083 
00084 
00087 extern orxDLLAPI void orxFASTCALL             orxGraphic_Setup();
00088 
00091 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_Init();
00092 
00095 extern orxDLLAPI void orxFASTCALL             orxGraphic_Exit();
00096 
00097 
00101 extern orxDLLAPI orxGRAPHIC *orxFASTCALL      orxGraphic_Create();
00102 
00107 extern orxDLLAPI orxGRAPHIC *orxFASTCALL      orxGraphic_CreateFromConfig(const orxSTRING _zConfigID);
00108 
00113 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_Delete(orxGRAPHIC *_pstGraphic);
00114 
00115 
00121 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetData(orxGRAPHIC *_pstGraphic, orxSTRUCTURE *_pstData);
00122 
00127 extern orxDLLAPI orxSTRUCTURE *orxFASTCALL    orxGraphic_GetData(const orxGRAPHIC *_pstGraphic);
00128 
00129 
00136 extern orxDLLAPI orxSTATUS orxFASTCALL      orxGraphic_SetFlip(orxGRAPHIC *_pstGraphic, orxBOOL _bFlipX, orxBOOL _bFlipY);
00137 
00144 extern orxDLLAPI orxSTATUS orxFASTCALL      orxGraphic_GetFlip(const orxGRAPHIC *_pstGraphic, orxBOOL *_pbFlipX, orxBOOL *_pbFlipY);
00145 
00146 
00152 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetPivot(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvPivot);
00153 
00159 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetRelativePivot(orxGRAPHIC *_pstGraphic, orxU32 _u32AlignFlags);
00160 
00166 extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetPivot(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvPivot);
00167 
00168 
00174 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetSize(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvSize);
00175 
00181 extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetSize(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvSize);
00182 
00188 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetColor(orxGRAPHIC *_pstGraphic, const orxCOLOR *_pstColor);
00189 
00196 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetRepeat(orxGRAPHIC *_pstGraphic, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY);
00197 
00202 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_ClearColor(orxGRAPHIC *_pstGraphic);
00203 
00208 extern orxDLLAPI orxBOOL orxFASTCALL          orxGraphic_HasColor(const orxGRAPHIC *_pstGraphic);
00209 
00215 extern orxDLLAPI orxCOLOR *orxFASTCALL        orxGraphic_GetColor(const orxGRAPHIC *_pstGraphic, orxCOLOR *_pstColor);
00216 
00223 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_GetRepeat(const orxGRAPHIC *_pstGraphic, orxFLOAT *_pfRepeatX, orxFLOAT *_pfRepeatY);
00224 
00230 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetOrigin(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvOrigin);
00231 
00237 extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetOrigin(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvOrigin);
00238 
00243 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_UpdateSize(orxGRAPHIC *_pstGraphic);
00244 
00250 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetSmoothing(orxGRAPHIC *_pstGraphic, orxDISPLAY_SMOOTHING _eSmoothing);
00251 
00256 extern orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxGraphic_GetSmoothing(const orxGRAPHIC *_pstGraphic);
00257 
00258 
00264 extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetBlendMode(orxGRAPHIC *_pstGraphic, orxDISPLAY_BLEND_MODE _eBlendMode);
00265 
00270 extern orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxGraphic_GetBlendMode(const orxGRAPHIC *_pstGraphic);
00271 
00272 #endif /* _orxGRAPHIC_H_ */
00273