orxSystem.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 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 _orxSYSTEM_H_
#define _orxSYSTEM_H_

#include "orxInclude.h"
#include "math/orxVector.h"

typedef enum __orxSYSTEM_EVENT_t
{
  orxSYSTEM_EVENT_CLOSE = 0,
  orxSYSTEM_EVENT_FOCUS_GAINED,
  orxSYSTEM_EVENT_FOCUS_LOST,

  orxSYSTEM_EVENT_BACKGROUND,
  orxSYSTEM_EVENT_FOREGROUND,

  orxSYSTEM_EVENT_GAME_LOOP_START,
  orxSYSTEM_EVENT_GAME_LOOP_STOP,

  orxSYSTEM_EVENT_TOUCH_BEGIN,
  orxSYSTEM_EVENT_TOUCH_MOVE,
  orxSYSTEM_EVENT_TOUCH_END,
  orxSYSTEM_EVENT_ACCELERATE,
  orxSYSTEM_EVENT_MOTION_SHAKE,

  orxSYSTEM_EVENT_DROP,
  orxSYSTEM_EVENT_CLIPBOARD,

  orxSYSTEM_EVENT_PARAM_READY,
  orxSYSTEM_EVENT_PARAM_DISPLAY,

  orxSYSTEM_EVENT_NUMBER,

  orxSYSTEM_EVENT_NONE = orxENUM_NONE

} orxSYSTEM_EVENT;

typedef struct __orxSYSTEM_EVENT_PAYLOAD_t
{
  union
  {
    orxU32      u32FrameCount;

    /* Touch event */
    struct
    {
      orxDOUBLE dTime;
      orxU32    u32ID;
      orxFLOAT  fX, fY, fPressure;
    } stTouch;

    /* Accelerometer event */
    struct
    {
      orxDOUBLE dTime;
      orxVECTOR vAcceleration;
    } stAccelerometer;

    /* Drop event */
    struct
    {
      const orxSTRING  *azValueList;
      orxU32            u32Number;

    } stDrop;

    /* Clipboard event */
    struct
    {
      const orxSTRING zValue;

    } stClipboard;
  };

} orxSYSTEM_EVENT_PAYLOAD;


extern orxDLLAPI void orxFASTCALL             orxSystem_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSystem_Init();

extern orxDLLAPI void orxFASTCALL             orxSystem_Exit();

extern orxDLLAPI orxDOUBLE orxFASTCALL        orxSystem_GetTime();

extern orxDLLAPI orxU64 orxFASTCALL           orxSystem_GetRealTime();

extern orxDLLAPI orxDOUBLE orxFASTCALL        orxSystem_GetSystemTime();

extern orxDLLAPI void orxFASTCALL             orxSystem_Delay(orxFLOAT _fSeconds);

extern orxDLLAPI orxVERSION *orxFASTCALL      orxSystem_GetVersion(orxVERSION *_pstVersion);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxSystem_GetVersionString();

extern orxDLLAPI const orxSTRING orxFASTCALL  orxSystem_GetVersionFullString();

extern orxDLLAPI orxU32 orxFASTCALL           orxSystem_GetVersionNumeric();

extern orxDLLAPI const orxSTRING orxFASTCALL  orxSystem_GetClipboard();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSystem_SetClipboard(const orxSTRING _zValue);


#endif /* _orxSYSTEM_H_ */