orxGraphic.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 _orxGRAPHIC_H_
#define _orxGRAPHIC_H_

#include "orxInclude.h"

#include "object/orxStructure.h"
#include "display/orxDisplay.h"


#define orxGRAPHIC_KU32_FLAG_NONE             0x00000000  
#define orxGRAPHIC_KU32_FLAG_2D               0x00000001  
#define orxGRAPHIC_KU32_FLAG_TEXT             0x00000002  
#define orxGRAPHIC_KU32_MASK_TYPE             0x00000003  
#define orxGRAPHIC_KU32_FLAG_FLIP_X           0x00000004  
#define orxGRAPHIC_KU32_FLAG_FLIP_Y           0x00000008  
#define orxGRAPHIC_KU32_MASK_FLIP_BOTH        0x0000000C  
#define orxGRAPHIC_KU32_FLAG_ALIGN_CENTER     0x00000000  
#define orxGRAPHIC_KU32_FLAG_ALIGN_LEFT       0x00000010  
#define orxGRAPHIC_KU32_FLAG_ALIGN_RIGHT      0x00000020  
#define orxGRAPHIC_KU32_FLAG_ALIGN_TOP        0x00000040  
#define orxGRAPHIC_KU32_FLAG_ALIGN_BOTTOM     0x00000080  
#define orxGRAPHIC_KU32_FLAG_ALIGN_TRUNCATE   0x00000100  
#define orxGRAPHIC_KU32_FLAG_ALIGN_ROUND      0x00000200  
#define orxGRAPHIC_KU32_MASK_USER_ALL         0x00000FFF  
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_NAME     "Texture"
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_ORIGIN   "TextureOrigin"
#define orxGRAPHIC_KZ_CONFIG_TEXTURE_SIZE     "TextureSize"
#define orxGRAPHIC_KZ_CONFIG_TEXT_NAME        "Text"
#define orxGRAPHIC_KZ_CONFIG_PIVOT            "Pivot"
#define orxGRAPHIC_KZ_CONFIG_COLOR            "Color"
#define orxGRAPHIC_KZ_CONFIG_ALPHA            "Alpha"
#define orxGRAPHIC_KZ_CONFIG_RGB              "RGB"
#define orxGRAPHIC_KZ_CONFIG_HSL              "HSL"
#define orxGRAPHIC_KZ_CONFIG_HSV              "HSV"
#define orxGRAPHIC_KZ_CONFIG_FLIP             "Flip"
#define orxGRAPHIC_KZ_CONFIG_REPEAT           "Repeat"
#define orxGRAPHIC_KZ_CONFIG_SMOOTHING        "Smoothing"
#define orxGRAPHIC_KZ_CONFIG_BLEND_MODE       "BlendMode"
#define orxGRAPHIC_KZ_CONFIG_KEEP_IN_CACHE    "KeepInCache"


typedef struct __orxGRAPHIC_t                 orxGRAPHIC;


extern orxDLLAPI void orxFASTCALL             orxGraphic_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_Init();

extern orxDLLAPI void orxFASTCALL             orxGraphic_Exit();


extern orxDLLAPI orxGRAPHIC *orxFASTCALL      orxGraphic_Create();

extern orxDLLAPI orxGRAPHIC *orxFASTCALL      orxGraphic_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_Delete(orxGRAPHIC *_pstGraphic);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxGraphic_GetName(const orxGRAPHIC *_pstGraphic);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetData(orxGRAPHIC *_pstGraphic, orxSTRUCTURE *_pstData);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL    orxGraphic_GetData(const orxGRAPHIC *_pstGraphic);


extern orxDLLAPI orxSTATUS orxFASTCALL      orxGraphic_SetFlip(orxGRAPHIC *_pstGraphic, orxBOOL _bFlipX, orxBOOL _bFlipY);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxGraphic_GetFlip(const orxGRAPHIC *_pstGraphic, orxBOOL *_pbFlipX, orxBOOL *_pbFlipY);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetPivot(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvPivot);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetRelativePivot(orxGRAPHIC *_pstGraphic, orxU32 _u32AlignFlags);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetPivot(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvPivot);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetSize(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvSize);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetSize(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvSize);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetColor(orxGRAPHIC *_pstGraphic, const orxCOLOR *_pstColor);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetRepeat(orxGRAPHIC *_pstGraphic, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_ClearColor(orxGRAPHIC *_pstGraphic);

extern orxDLLAPI orxBOOL orxFASTCALL          orxGraphic_HasColor(const orxGRAPHIC *_pstGraphic);

extern orxDLLAPI orxCOLOR *orxFASTCALL        orxGraphic_GetColor(const orxGRAPHIC *_pstGraphic, orxCOLOR *_pstColor);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_GetRepeat(const orxGRAPHIC *_pstGraphic, orxFLOAT *_pfRepeatX, orxFLOAT *_pfRepeatY);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetOrigin(orxGRAPHIC *_pstGraphic, const orxVECTOR *_pvOrigin);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxGraphic_GetOrigin(const orxGRAPHIC *_pstGraphic, orxVECTOR *_pvOrigin);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_UpdateSize(orxGRAPHIC *_pstGraphic);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetSmoothing(orxGRAPHIC *_pstGraphic, orxDISPLAY_SMOOTHING _eSmoothing);

extern orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxGraphic_GetSmoothing(const orxGRAPHIC *_pstGraphic);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_SetBlendMode(orxGRAPHIC *_pstGraphic, orxDISPLAY_BLEND_MODE _eBlendMode);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxGraphic_ClearBlendMode(orxGRAPHIC *_pstGraphic);

extern orxDLLAPI orxBOOL orxFASTCALL          orxGraphic_HasBlendMode(const orxGRAPHIC *_pstGraphic);

extern orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxGraphic_GetBlendMode(const orxGRAPHIC *_pstGraphic);

#endif /* _orxGRAPHIC_H_ */