Main engine interface. More...

#include <DGLE.h>

Inheritance diagram for IEngineCore:

Public Member Functions
virtual DGLE_RESULT DGLE_API	LoadSplashPicture (const char *pcBmpFileName)=0
	Set engine splash window picture.

virtual DGLE_RESULT DGLE_API	AddPluginToInitializationList (const char *pcFileName)=0
	Adds plugin to engine initialization list.

virtual DGLE_RESULT DGLE_API	InitializeEngine (TWindowHandle tHandle, const char *pcApplicationName, const TEngineWindow &stWindowParam=TEngineWindow(), uint uiUpdateInterval=33, E_ENGINE_INIT_FLAGS eInitFlags=EIF_DEFAULT)=0
	Initialize engine and all of its subroutines.

virtual DGLE_RESULT DGLE_API	SetUpdateInterval (uint uiUpdateInterval)=0
	Change interval of calling user update routine after engine has been started.

virtual DGLE_RESULT DGLE_API	StartEngine ()=0

virtual DGLE_RESULT DGLE_API	QuitEngine ()=0

virtual DGLE_RESULT DGLE_API	ConnectPlugin (const char pcFileName, IPlugin &prPlugin)=0

virtual DGLE_RESULT DGLE_API	DisconnectPlugin (IPlugin *pPlugin)=0

virtual DGLE_RESULT DGLE_API	GetPlugin (const char pcPluginName, IPlugin &prPlugin)=0

virtual DGLE_RESULT DGLE_API	AddEngineCallback (IEngineCallback *pEngineCallback)=0

virtual DGLE_RESULT DGLE_API	RemoveEngineCallback (IEngineCallback *pEngineCallback)=0

virtual DGLE_RESULT DGLE_API	AddProcedure (E_ENGINE_PROCEDURE_TYPE eProcType, void(DGLE_API pProc)(void pParameter), void *pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	RemoveProcedure (E_ENGINE_PROCEDURE_TYPE eProcType, void(DGLE_API pProc)(void pParameter), void *pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	CastEvent (E_EVENT_TYPE eEventType, IBaseEvent *pEvent)=0

virtual DGLE_RESULT DGLE_API	AddEventListener (E_EVENT_TYPE eEventType, void(DGLE_API pListenerProc)(void pParameter, IBaseEvent pEvent), void pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	RemoveEventListener (E_EVENT_TYPE eEventType, void(DGLE_API pListenerProc)(void pParameter, IBaseEvent pEvent), void pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	GetSubSystem (E_ENGINE_SUB_SYSTEM eSubSystem, IEngineSubSystem *&prSubSystem)=0

virtual DGLE_RESULT DGLE_API	RenderFrame ()=0

virtual DGLE_RESULT DGLE_API	RenderProfilerText (const char *pcTxt, const TColor4 &stColor=ColorWhite())=0

virtual DGLE_RESULT DGLE_API	GetInstanceIndex (uint &uiIdx)=0

virtual DGLE_RESULT DGLE_API	GetTimer (uint64 &uiTick)=0

virtual DGLE_RESULT DGLE_API	GetSystemInfo (TSystemInfo &stSysInfo)=0

virtual DGLE_RESULT DGLE_API	GetCurrentWindow (TEngineWindow &stWin)=0

virtual DGLE_RESULT DGLE_API	GetFPS (uint &uiFPS)=0

virtual DGLE_RESULT DGLE_API	GetLastUpdateDeltaTime (uint &uiDeltaTime)=0

virtual DGLE_RESULT DGLE_API	GetElapsedTime (uint64 &ui64ElapsedTime)=0

virtual DGLE_RESULT DGLE_API	GetWindowHandle (TWindowHandle &tHandle)=0

virtual DGLE_RESULT DGLE_API	ChangeWindowMode (const TEngineWindow &stNewWin)=0

virtual DGLE_RESULT DGLE_API	GetDesktopResolution (uint &uiWidth, uint &uiHeight)=0

virtual DGLE_RESULT DGLE_API	AllowPause (bool bAllow)=0

virtual DGLE_RESULT DGLE_API	WriteToLog (const char *pcTxt)=0

virtual DGLE_RESULT DGLE_API	WriteToLogEx (const char pcTxt, E_LOG_TYPE eType, const char pcSrcFileName, int iSrcLineNumber)=0

virtual DGLE_RESULT DGLE_API	ConsoleVisible (bool bIsVisible)=0

virtual DGLE_RESULT DGLE_API	ConsoleWrite (const char *pcTxt, bool bWriteToPreviousLine=false)=0

virtual DGLE_RESULT DGLE_API	ConsoleExecute (const char *pcCommandTxt)=0

virtual DGLE_RESULT DGLE_API	ConsoleRegisterCommand (const char pcCommandName, const char pcCommandHelp, bool(DGLE_API pProc)(void pParameter, const char pcParam), void pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	ConsoleRegisterVariable (const char pcCommandName, const char pcCommandHelp, int piVar, int iMinValue, int iMaxValue, bool(DGLE_API pProc)(void pParameter, const char pcParam)=NULL, void *pParameter=NULL)=0

virtual DGLE_RESULT DGLE_API	ConsoleUnregister (const char *pcCommandName)=0

virtual DGLE_RESULT DGLE_API	GetVersion (char *pcBuffer, uint &uiBufferSize)=0

Public Member Functions inherited from IDGLE_Base
virtual DGLE_RESULT DGLE_API	GetGUID (GUID &guid)=0
	Returns unique identifier of the last interface in the inheritance chain.

virtual DGLE_RESULT DGLE_API	ExecuteCommand (uint uiCmd, TVariant &stVar)=0
	Executes some command using its index or bitmask.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommand (const char *pcCommand, TVariant &stVar)=0
	Executes some text command and returns result as variant.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommandEx (const char pcCommand, char pcResult, uint &uiCharsCount)=0
	Executes some text command and returns result as string.

Detailed Description

Main engine interface.

Pointer to this interface is retrieved directly from the DGLE library.

See Also: DGLE_DYNAMIC_FUNC

Examples:: HelloWorld.cpp.

Member Function Documentation

virtual DGLE_RESULT DGLE_API AddEngineCallback ( IEngineCallback * pEngineCallback )

pure virtual

virtual DGLE_RESULT DGLE_API AddEventListener	(	E_EVENT_TYPE	eEventType,
		void(DGLE_API pListenerProc)(void pParameter, IBaseEvent *pEvent)	,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API AddPluginToInitializationList ( const char * pcFileName )

pure virtual

Adds plugin to engine initialization list.

This means that plugin will be loaded on engine initialization. This is the only correct way to setup specific Render, Sound, Input or other system plugins.

Parameters

[in] pcFileName File name of the plugin.

Note: Standard extension plugin ("Ext") will be connected automatically (if found), so you don't need to add it to initialization list.

See Also: EIF_LOAD_ALL_PLUGINS

virtual DGLE_RESULT DGLE_API AddProcedure	(	E_ENGINE_PROCEDURE_TYPE	eProcType,
		void(DGLE_API pProc)(void pParameter)	,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API AllowPause ( bool bAllow )

pure virtual

virtual DGLE_RESULT DGLE_API CastEvent	(	E_EVENT_TYPE	eEventType,
		IBaseEvent *	pEvent
	)

pure virtual

virtual DGLE_RESULT DGLE_API ChangeWindowMode ( const TEngineWindow & stNewWin )

pure virtual

virtual DGLE_RESULT DGLE_API ConnectPlugin	(	const char *	pcFileName,
		IPlugin *&	prPlugin
	)

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleExecute ( const char * pcCommandTxt )

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleRegisterCommand	(	const char *	pcCommandName,
		const char *	pcCommandHelp,
		bool(DGLE_API pProc)(void pParameter, const char *pcParam)	,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleRegisterVariable	(	const char *	pcCommandName,
		const char *	pcCommandHelp,
		int *	piVar,
		int	iMinValue,
		int	iMaxValue,
		bool(DGLE_API pProc)(void pParameter, const char *pcParam)	= `NULL`,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleUnregister ( const char * pcCommandName )

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleVisible ( bool bIsVisible )

pure virtual

virtual DGLE_RESULT DGLE_API ConsoleWrite	(	const char *	pcTxt,
		bool	bWriteToPreviousLine = `false`
	)

pure virtual

virtual DGLE_RESULT DGLE_API DisconnectPlugin ( IPlugin * pPlugin )

pure virtual

virtual DGLE_RESULT DGLE_API GetCurrentWindow ( TEngineWindow & stWin )

pure virtual

virtual DGLE_RESULT DGLE_API GetDesktopResolution	(	uint &	uiWidth,
		uint &	uiHeight
	)

pure virtual

virtual DGLE_RESULT DGLE_API GetElapsedTime ( uint64 & ui64ElapsedTime )

pure virtual

virtual DGLE_RESULT DGLE_API GetFPS ( uint & uiFPS )

pure virtual

virtual DGLE_RESULT DGLE_API GetInstanceIndex ( uint & uiIdx )

pure virtual

virtual DGLE_RESULT DGLE_API GetLastUpdateDeltaTime ( uint & uiDeltaTime )

pure virtual

virtual DGLE_RESULT DGLE_API GetPlugin	(	const char *	pcPluginName,
		IPlugin *&	prPlugin
	)

pure virtual

virtual DGLE_RESULT DGLE_API GetSubSystem	(	E_ENGINE_SUB_SYSTEM	eSubSystem,
		IEngineSubSystem *&	prSubSystem
	)

pure virtual

virtual DGLE_RESULT DGLE_API GetSystemInfo ( TSystemInfo & stSysInfo )

pure virtual

virtual DGLE_RESULT DGLE_API GetTimer ( uint64 & uiTick )

pure virtual

virtual DGLE_RESULT DGLE_API GetVersion	(	char *	pcBuffer,
		uint &	uiBufferSize
	)

pure virtual

virtual DGLE_RESULT DGLE_API GetWindowHandle ( TWindowHandle & tHandle )

pure virtual

virtual DGLE_RESULT DGLE_API InitializeEngine	(	TWindowHandle	tHandle,
		const char *	pcApplicationName,
		const TEngineWindow &	stWindowParam = `TEngineWindow()`,
		uint	uiUpdateInterval = `33`,
		E_ENGINE_INIT_FLAGS	eInitFlags = `EIF_DEFAULT`
	)

pure virtual

Initialize engine and all of its subroutines.

Also creates main engine window.

Parameters

[in]	tHandle	Handle of some already created window control to render in or NULL in case to let engine create its own window.
[in]	pcApplicationName	Caption of main engine window.
[in]	stWindowParam	Structure with some window properties.
[in]	uiUpdateInterval	Interval in milliseconds between calling of user update routine.

See Also: EPT_UPDATE

Parameters

[in] eInitFlags Special engine configuration flags.

virtual DGLE_RESULT DGLE_API LoadSplashPicture ( const char * pcBmpFileName )

pure virtual

Set engine splash window picture.

Parameters

[in] pcBmpFileName File name of the BMP file with picture to be set.

Note: You can use this method only before calling InitializeEngine.

virtual DGLE_RESULT DGLE_API QuitEngine ( )

pure virtual

virtual DGLE_RESULT DGLE_API RemoveEngineCallback ( IEngineCallback * pEngineCallback )

pure virtual

virtual DGLE_RESULT DGLE_API RemoveEventListener	(	E_EVENT_TYPE	eEventType,
		void(DGLE_API pListenerProc)(void pParameter, IBaseEvent *pEvent)	,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API RemoveProcedure	(	E_ENGINE_PROCEDURE_TYPE	eProcType,
		void(DGLE_API pProc)(void pParameter)	,
		void *	pParameter = `NULL`
	)

pure virtual

virtual DGLE_RESULT DGLE_API RenderFrame ( )

pure virtual

virtual DGLE_RESULT DGLE_API RenderProfilerText	(	const char *	pcTxt,
		const TColor4 &	stColor = `ColorWhite()`
	)

pure virtual

virtual DGLE_RESULT DGLE_API SetUpdateInterval ( uint uiUpdateInterval )

pure virtual

Change interval of calling user update routine after engine has been started.

See Also: EPT_UPDATE

Parameters

[in] uiUpdateInterval Interval in milliseconds.

See Also: InitializeEngine

virtual DGLE_RESULT DGLE_API StartEngine ( )

pure virtual

virtual DGLE_RESULT DGLE_API WriteToLog ( const char * pcTxt )

pure virtual

virtual DGLE_RESULT DGLE_API WriteToLogEx	(	const char *	pcTxt,
		E_LOG_TYPE	eType,
		const char *	pcSrcFileName,
		int	iSrcLineNumber
	)

pure virtual

Public Member Functions

Detailed Description

Member Function Documentation