Architecture Arcade
Architecture Commune Arcade
Macros | Enumerations | Functions
Api.hpp File Reference
#include "IDisplayModule.hpp"
#include "IGameModule.hpp"
Include dependency graph for Api.hpp:

Go to the source code of this file.

Macros

#define EXPORT
 

Enumerations

enum  LibType {
  GRAPH ,
  GAME
}
 

Functions

EXPORT Arcade::Game::IGameModulegetGameModule ()
 The Games shared lib main entry point to get GameModule. More...
 
EXPORT void destroyGameModule (Arcade::Game::IGameModule *gameModule)
 Destroy the GameModule created by getGameModule. More...
 
EXPORT Arcade::Graph::IDisplayModulegetDisplayModule ()
 The Graphs shared lib main entry point to get DisplayModule. More...
 
EXPORT void destroyDisplayModule (Arcade::Graph::IDisplayModule *displayModule)
 Destroy the DisplayModule created by getDisplayModule. More...
 
EXPORT const char * getName ()
 The Shared lib entry point to get lib name. More...
 
EXPORT LibType getType ()
 The Shared lib entry point to get lib type. More...
 

Macro Definition Documentation

◆ EXPORT

#define EXPORT

Enumeration Type Documentation

◆ LibType

enum LibType

Each graphical library must call in one system the setMousePosition method of EventManager

Enumerator
GRAPH 
GAME 

Function Documentation

◆ destroyDisplayModule()

EXPORT void destroyDisplayModule ( Arcade::Graph::IDisplayModule displayModule)

Destroy the DisplayModule created by getDisplayModule.

Parameters
displayModuleA ptr on IDisplayModule

◆ destroyGameModule()

EXPORT void destroyGameModule ( Arcade::Game::IGameModule gameModule)

Destroy the GameModule created by getGameModule.

Parameters
gameModuleA ptr on IGameModule

◆ getDisplayModule()

EXPORT Arcade::Graph::IDisplayModule* getDisplayModule ( )

The Graphs shared lib main entry point to get DisplayModule.

Returns
A ptr on IDisplayModule

All graph shared lib must have this function

◆ getGameModule()

EXPORT Arcade::Game::IGameModule* getGameModule ( )

The Games shared lib main entry point to get GameModule.

Returns
A ptr on IGameModule

All game shared lib must have this function

◆ getName()

EXPORT const char* getName ( )

The Shared lib entry point to get lib name.

Returns
Lib's name in std::string

All shared lib must have this function

◆ getType()

EXPORT LibType getType ( )

The Shared lib entry point to get lib type.

Returns
LibType enum

All shared lib must have this function