Functions
void	OGE_Screenshot ()
	Take a screenshot.
int	OGE_GetLastScreenshot ()
	Get the image ID of the last screenshot.
int	OGE_GetScreenImage ()
	Get the image ID of current game screen.
void	OGE_ShowFPS (bool bShow)
	Show or hide FPS.
void	OGE_LockFPS (int iFPS)
	Lock FPS.
int	OGE_GetFPS ()
	Get current FPS.
int	OGE_GetLockedFPS ()
	Get the FPS value you want to lock.
void	OGE_ShowMousePos (bool bShow)
	Show or hide mouse position on the screen.
void	OGE_SetDirtyRectMode (bool bValue)
	Set dirty rect mode or not.
void	OGE_Scroll (int iIncX, int iIncY)
	Scroll the screen.
void	OGE_SetViewPos (int iLeft, int iTop)
	Set the position of the viewport.
int	OGE_GetViewPosX ()
	Get the x coordinate of the viewport position.
int	OGE_GetViewPosY ()
	Get the y coordinate of the viewport position.
int	OGE_GetViewWidth ()
	Get the width of the viewport.
int	OGE_GetViewHeight ()
	Get the height of the viewport.
void	OGE_StopAutoScroll ()
	Stop auto-scrolling screen.
void	OGE_StartAutoScroll (int iStepX, int iStepY, int iInterval, bool bLoop)
	Start to auto-scroll screen.
void	OGE_SetAutoScrollSpeed (int iStepX, int iStepY, int iInterval)
	Set the speed of scrolling the screen.
void	OGE_SetScrollTarget (int iTargetX, int iTargetY)
	Set the target position for the auto-scrolling.
void	OGE_ShowMouseCursor (bool bShow)
	Show or hide the system mouse cursor on the screen.
bool	OGE_GetFullScreen ()
	Check if the game is in fullscreen mode or not.
void	OGE_SetFullScreen (bool bValue)
	Set window mode or fullscreen mode for current game.

Function Documentation

int OGE_GetFPS ( )

Get current FPS.

Returns:: Current FPS

bool OGE_GetFullScreen ( )

Check if the game is in fullscreen mode or not.

Returns:: Returns true if game is in fullscreen mode

int OGE_GetLastScreenshot ( )

Get the image ID of the last screenshot.

Returns:: The image ID of the screenshot

int OGE_GetLockedFPS ( )

Get the FPS value you want to lock.

Returns:: The FPS value you want to lock

int OGE_GetScreenImage ( )

Get the image ID of current game screen.

Returns:: The image ID of game screen

int OGE_GetViewHeight ( )

Get the height of the viewport.

Returns:: The height of the viewport

int OGE_GetViewPosX ( )

Get the x coordinate of the viewport position.

Returns:: The x coordinate of the viewport position

int OGE_GetViewPosY ( )

Get the y coordinate of the viewport position.

Returns:: The y coordinate of the viewport position

int OGE_GetViewWidth ( )

Get the width of the viewport.

Returns:: The width of the viewport

void OGE_LockFPS ( int iFPS )

Lock FPS.

Parameters:

[in] iFPS The FPS value you want to lock

void OGE_Scroll	(	int	iIncX,
		int	iIncY
	)

Scroll the screen.

Parameters:

[in]	iIncX	The x-coordinate offset value of the scrolling
[in]	iIncY	The y-coordinate offset value of the scrolling

void OGE_SetAutoScrollSpeed	(	int	iStepX,
		int	iStepY,
		int	iInterval
	)

Set the speed of scrolling the screen.

Parameters:

[in]	iStepX	The x-coordinate offset of every step
[in]	iStepY	The y-coordinate offset of every step
[in]	iInterval	The interval between two steps

void OGE_SetDirtyRectMode ( bool bValue )

Set dirty rect mode or not.

Parameters:

[in] bValue If true then use dirty rect mode

void OGE_SetFullScreen ( bool bValue )

Set window mode or fullscreen mode for current game.

Parameters:

[in] bValue Enable fullscreen mode or not

void OGE_SetScrollTarget	(	int	iTargetX,
		int	iTargetY
	)

Set the target position for the auto-scrolling.

Parameters:

[in]	iTargetX	The x coordinate of the target position
[in]	iTargetY	The y coordinate of the target position

void OGE_SetViewPos	(	int	iLeft,
		int	iTop
	)

Set the position of the viewport.

Parameters:

[in]	iLeft	The x coordinate of the viewport position
[in]	iTop	The y coordinate of the viewport position

void OGE_ShowFPS ( bool bShow )

Show or hide FPS.

Parameters:

[in] bShow If it is true then show FPS else hide FPS

void OGE_ShowMouseCursor ( bool bShow )

Show or hide the system mouse cursor on the screen.

Parameters:

[in] bShow If true then show it else hide it

void OGE_ShowMousePos ( bool bShow )

Show or hide mouse position on the screen.

Parameters:

[in] bShow If true then show the position else hide it

void OGE_StartAutoScroll	(	int	iStepX,
		int	iStepY,
		int	iInterval,
		bool	bLoop
	)

Start to auto-scroll screen.

Parameters:

[in]	iStepX	The x-coordinate offset value of every scroll step
[in]	iStepY	The y-coordinate offset value of every scroll step
[in]	iInterval	Interval between two steps
[in]	bLoop	If true then the scrolling will restart when reaching the end

Functions

Function Documentation