AESystem.h File Reference

Header file for the system library. More...

Go to the source code of this file.

Functions
s32	AESysInit (HINSTANCE hAppInstance, s32 show, s32 WinWidth, s32 WinHeight, s32 CreateConsole, u32 FrameRateMax, LRESULT(*pWinCallBack)(HWND hWnd, UINT msg, WPARAM wp, LPARAM lp))
	Initialize the Alpha Engine. More...
void	AESysReset ()
	Reset the Alpha Engine. More...
void	AESysExit ()
	Free the Alpha Engine. More...
void	AESysFrameStart ()
	Start of frame. More...
void	AESysFrameEnd ()
	End of frame. More...
HWND	AESysGetWindowHandle ()
	Get the handle to the window. More...
void	AESysSetWindowTitle (const s8 *pTitle)
	Set the title of the window. More...
s32	AESysDoesWindowExist ()
	Check if the window has been closed. More...

Variables
HINSTANCE	ghAESysAppInstance
HWND	gAESysWindowHandle
WNDCLASS	winClass
const s8 *	gpAESysWinTitle
const s8 *	gpAESysWinClassName
s32	gAESysAppActive

Detailed Description

Header file for the system library.

Project: Alpha Engine

Author

Sun Tjen Fam

Date

January 31, 2007

Copyright

Copyright (C) 2013 DigiPen Institute of Technology. Reproduction or disclosure of this file or its contents without the prior written consent of DigiPen Institute of Technology is prohibited.

Definition in file AESystem.h.

Function Documentation

s32 AESysDoesWindowExist

(

)

Check if the window has been closed.

Return values

s32	Return 1 if the window exist. Else return 0.

void AESysExit

(

)

Free the Alpha Engine.

Call this function once at the end of the program to free the system.

Return values

void	No return.

void AESysFrameEnd

(

)

End of frame.

Call this function once at the end of the frame to inform the system the current frame is ending.

Return values

void	No return.

void AESysFrameStart

(

)

Start of frame.

Call this function once at the start of the frame to inform the system a new frame is starting.

Return values

void	No return.

HWND AESysGetWindowHandle

(

)

Get the handle to the window.

Return values

HWND	Returns the handle to the window.

s32 AESysInit	(	HINSTANCE	hAppInstance,
		s32	show,
		s32	WinWidth,
		s32	WinHeight,
		s32	CreateConsole,
		u32	FrameRateMax,
		LRESULT(*)(HWND hWnd, UINT msg, WPARAM wp, LPARAM lp)	pWinCallBack
	)

Initialize the Alpha Engine.

Call this function once at the start of the program to initialize the system.

Parameters

[in]	hAppInstance	Handle to the current instance of the application.
[in]	show	Set how the the window is to be shown.
[in]	WinWidth	Set the width of the window.
[in]	WinHeight	Set the height of the window.
[in]	CreateConsole	Input 1 if a console window should be created. Else input 0.
[in]	FrameRateMax	Set the maximum frames per second.
[in]	pWinCallBack	Pointer to a callback function. May be left null if not needed.

Return values

s32	Return 1 if initialization is successful. Else return 0.

void AESysReset

(

)

Reset the Alpha Engine.

Call this function when changing gamestates to reset the system.

Return values

void	No return.

void AESysSetWindowTitle

(

const s8 *

pTitle

)

Set the title of the window.

Parameters

[in]

pTitle

Pointer to a null-terminated string to set as the title of the window.

Return values

void	No return.

Variable Documentation

s32 gAESysAppActive

HWND gAESysWindowHandle

HINSTANCE ghAESysAppInstance

const s8* gpAESysWinClassName

const s8* gpAESysWinTitle

WNDCLASS winClass