Sdk engine extension api documentation

SDK Engine extension API documentation

Namespace: dmEngine
Include: #include <dmsdk/engine/extension.h>
FUNCTIONS
dmConfigFile::HConfig GetConfigFile(dmExtension::AppParams* app_params) get the config file
dmGameObject::HRegister GetGameObjectRegister(dmExtension::AppParams* app_params) get the game object register
dmHID::HContext GetHIDContext(dmExtension::AppParams* app_params) get the hid context
dmWebServer::HServer GetWebServer(dmExtension::AppParams* app_params) get the web server handle
MACROS
DM_DEBUG() define for debug builds
DM_HEADLESS() define for headless builds
DM_RELEASE() define for release builds

Functions

GetConfigFile

dmConfigFile::HConfig GetConfigFile(dmExtension::AppParams* app_params)

get the config file

PARAMETERS

dmExtension::AppParams* app_params The app params sent to the extension dmExtension::AppInitialize / dmExtension::AppInitialize

RETURNS

dmConfigFile::HConfig The game project config file

GetGameObjectRegister

dmGameObject::HRegister GetGameObjectRegister(dmExtension::AppParams* app_params)

get the game object register

PARAMETERS

dmExtension::AppParams* app_params The app params sent to the extension dmExtension::AppInitialize / dmExtension::AppInitialize

RETURNS

dmGameObject::HRegister The game object register

GetHIDContext

dmHID::HContext GetHIDContext(dmExtension::AppParams* app_params)

get the hid context

PARAMETERS

dmExtension::AppParams* app_params The app params sent to the extension dmExtension::AppInitialize / dmExtension::AppInitialize

RETURNS

dmHID::HContext The hid context

GetWebServer

dmWebServer::HServer GetWebServer(dmExtension::AppParams* app_params)

get the web server handle

PARAMETERS

dmExtension::AppParams* app_params The app params sent to the extension dmExtension::AppInitialize / dmExtension::AppInitialize

RETURNS

dmWebServer::HServer The web server handle

Macros

DM_DEBUG

define for debug builds

EXAMPLES

Only enable code in debug builds 
#if defined(DM_DEBUG)
    // ...
#endif

DM_HEADLESS

define for headless builds

EXAMPLES

Only enable code in headless builds 
#if defined(DM_HEADLESS)
    // ...
#endif

DM_RELEASE

define for release builds

EXAMPLES

Only enable code in release builds 
#if defined(DM_RELEASE)
    // ...
#endif