orxViewport.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 _orxVIEWPORT_H_
#define _orxVIEWPORT_H_
 
#include "orxInclude.h"
#include "core/orxClock.h"
#include "render/orxCamera.h"
#include "render/orxShader.h"
#include "display/orxDisplay.h"
#include "display/orxTexture.h"
 

#define orxVIEWPORT_KU32_FLAG_ALIGN_CENTER    0x00000000  
#define orxVIEWPORT_KU32_FLAG_ALIGN_LEFT      0x10000000  
#define orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT     0x20000000  
#define orxVIEWPORT_KU32_FLAG_ALIGN_TOP       0x40000000  
#define orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM    0x80000000  
#define orxVIEWPORT_KU32_FLAG_NO_DEBUG        0x01000000  
 

#define orxVIEWPORT_KU32_MAX_TEXTURE_NUMBER   8
 

typedef struct __orxVIEWPORT_t                orxVIEWPORT;
 

typedef enum __orxVIEWPORT_EVENT_t
{
  orxVIEWPORT_EVENT_RESIZE = 0,              
 
  orxVIEWPORT_EVENT_NUMBER,
 
  orxVIEWPORT_EVENT_NONE = orxENUM_NONE
 
} orxVIEWPORT_EVENT;
 

extern orxDLLAPI void orxFASTCALL             orxViewport_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_Init();

extern orxDLLAPI void orxFASTCALL             orxViewport_Exit();
 

extern orxDLLAPI orxVIEWPORT *orxFASTCALL     orxViewport_Create();

extern orxDLLAPI orxVIEWPORT *orxFASTCALL     orxViewport_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_Delete(orxVIEWPORT *_pstViewport);
 

extern orxDLLAPI void orxFASTCALL             orxViewport_SetTextureList(orxVIEWPORT *_pstViewport, orxU32 _u32TextureNumber, orxTEXTURE **_apstTextureList);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_GetTextureList(const orxVIEWPORT *_pstViewport, orxU32 _u32TextureNumber, orxTEXTURE **_apstTextureList);

extern orxDLLAPI orxU32 orxFASTCALL           orxViewport_GetTextureCount(const orxVIEWPORT *_pstViewport);
 
 

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetBackgroundColor(orxVIEWPORT *_pstViewport, const orxCOLOR *_pstColor);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_ClearBackgroundColor(orxVIEWPORT *_pstViewport);

extern orxDLLAPI orxBOOL orxFASTCALL          orxViewport_HasBackgroundColor(const orxVIEWPORT *_pstViewport);

extern orxDLLAPI orxCOLOR *orxFASTCALL        orxViewport_GetBackgroundColor(const orxVIEWPORT *_pstViewport, orxCOLOR *_pstColor);
 

extern orxDLLAPI void orxFASTCALL             orxViewport_Enable(orxVIEWPORT *_pstViewport, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL          orxViewport_IsEnabled(const orxVIEWPORT *_pstViewport);
 

extern orxDLLAPI void orxFASTCALL             orxViewport_SetCamera(orxVIEWPORT *_pstViewport, orxCAMERA *_pstCamera);

extern orxDLLAPI orxCAMERA *orxFASTCALL       orxViewport_GetCamera(const orxVIEWPORT *_pstViewport);
 

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetShader(orxVIEWPORT *_pstViewport, orxSHADER *_pstShader);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetShaderFromConfig(orxVIEWPORT *_pstViewport, const orxSTRING _zShaderID);

extern orxDLLAPI void orxFASTCALL             orxViewport_EnableShader(orxVIEWPORT *_pstViewport, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL          orxViewport_IsShaderEnabled(const orxVIEWPORT *_pstViewport);

extern orxDLLAPI const orxSHADER *orxFASTCALL orxViewport_GetShader(const orxVIEWPORT *_pstViewport);
 

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetBlendMode(orxVIEWPORT *_pstViewport, orxDISPLAY_BLEND_MODE _eBlendMode);

extern orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxViewport_GetBlendMode(const orxVIEWPORT *_pstViewport);
 

extern orxDLLAPI void orxFASTCALL             orxViewport_SetPosition(orxVIEWPORT *_pstViewport, orxFLOAT _fX, orxFLOAT _fY);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetRelativePosition(orxVIEWPORT *_pstViewport, orxU32 _u32AlignFlags);

extern orxDLLAPI void orxFASTCALL             orxViewport_GetPosition(const orxVIEWPORT *_pstViewport, orxFLOAT *_pfX, orxFLOAT *_pfY);
 

extern orxDLLAPI void orxFASTCALL             orxViewport_SetSize(orxVIEWPORT *_pstViewport, orxFLOAT _fWidth, orxFLOAT _fHeight);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxViewport_SetRelativeSize(orxVIEWPORT *_pstViewport, orxFLOAT _fWidth, orxFLOAT _fHeight);

extern orxDLLAPI void orxFASTCALL             orxViewport_GetSize(const orxVIEWPORT *_pstViewport, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight);

extern orxDLLAPI void orxFASTCALL             orxViewport_GetRelativeSize(const orxVIEWPORT *_pstViewport, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight);

extern orxDLLAPI orxAABOX *orxFASTCALL        orxViewport_GetBox(const orxVIEWPORT *_pstViewport, orxAABOX *_pstBox);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxViewport_GetCorrectionRatio(const orxVIEWPORT *_pstViewport);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxViewport_GetName(const orxVIEWPORT *_pstViewport);

extern orxDLLAPI orxVIEWPORT *orxFASTCALL     orxViewport_Get(const orxSTRING _zName);
 
#endif /* _orxVIEWPORT_H_ */