AppBase

AppBase is a base application class that sample programs using the Platform derive from. AppBase class handles system-specific window initialization, input handling and frame processing.

Application is expected to work in three steps:

1. OnInit() - Called on startup, expected to setup window and graphics.

2. OnUpdateFrame() - Called in a loop by the system, expecting to both advance the frame and update display. Application should call Shutdown() to begin exit procedure.

3. OnShutdown() - Called when shutting down application.

Enumeration	Description
GestureMaskBits	Mask bits for the type of multi-touch event that is performed such as pan, rotate, swipe, zoom, tap etc.
GesturePhase

Method	Description
AppBase	AppBase constructor.
AppMain	AppBase Main function body used on some platforms.
ApplyViewConfigArgs	Applies default command line arguments to ViewConfig.
BringWindowToFront	Brings the window to the front.
CreateInstance	AppBase class creation function used by SF_PLATFORM_APP.
DestroyInstance	AppBase class deletion function.
EnableCursor	Enables the cursor on the window.
GetAppImpl	Gets the platform-specific app implementation.
GetAppRenderThread	Returns the render thread on which the application is running.
GetArgs	Returns the command line arguments once they have been parsed.
GetArgsThreadingType	Returns the threading type suggested by arguments.
GetCaps	Gets the device capabilities.
GetContentDirectory	Returns directory for additional content.
GetCursor	Returns the cursor set on the window.
GetDefaultFilePath	Returns default file path prefix for platform.
GetDevice	Returns the rendering device.
GetDeviceWindow	Returns the window of the rendering device.
GetDisplayCount	Returns the number of displays that the platform has.
GetFrameTime	Returns the actual frame time applied to OnUpdateFrame.
GetKeyboardCount	Returns the number of keyboards available.
GetMouseCount	Returns the number of mice or similar controllers available.
GetMousePos	Returns the current position of the mouse.
GetOrientation	Returns current orientation.
GetPlatformName	Returns the platform name as a string.
GetSafeArea	Returns the amount to reduce the viewport by to fit in the visible area on TVs.
GetSaveDataDirectory	Returns directory for save data.
GetViewConfig	Reports the current view configuration.
GetViewSize	Returns the current view size.
GetWindowTitle	Returns the title set for the window.
InitArgDescriptions	Called during initialization to allow user to add program-specific command line argument descriptions.
IsConsole	Checks if the platform is a console.
GetAppPackageName
IsCursorEnabled	Determines if the cursor is enabled on the window.
IsOrientationLocked	Determines whether the orientation is locked.
IsPadConnected	Determines whether the game pad is connected with the application.
IsShuttingDown	Returns true once Shutdown was called or program was closed.
MaximizeWindow	Maximizes the window.
MinimizeWindow	Minimizes the window size.
NotifyHideVirtualKeyboard	A notification that comes from a system to the player about virtual keyboard disappearance.
NotifyShowVirtualKeyboard	A notification that comes from a system to the player about virtual keyboard appearance.
OnAccelerometerUpdate	Called to notify application about updates from accelerometer sensor.
OnArgs	Called after parsing the command line.
OnClose	Called when "UI" closebox is pressed. Default behavior triggers program shutdown.
OnConfigurationChange	Used for changing stereo after the startup.
OnDropFiles	Called to notify application about file(s) dropped into the window.
OnFocus	Called to set/kill focus.
OnIMEEvent	Called to pass IME events to the IME Manager.
OnInit	Called to do initialization, including SetupWindow, render thread creation and graphics init.
OnKey	Called to notify application about a keyboard event.
OnMouseButton	Called to notify application about mouse button events.
OnMouseMove	Invoked whenever mouse movement occurs.
OnMouseWheel	Invoked for mouse wheel support.
OnOrientation	Notifies the application when the screen orientation changes.
OnPad	Called to notify application about gamepad events.
OnPause	Called to pause the movie clip.
OnGeolocationUpdate	Called to notify application about updates from location sensor.
OnGesture	Called to notify application about a manipulation/gesture event.
OnGestureBegin	Called to notify application about a manipulation/gesture being performed such as movement of fingers.
OnGestureEnd	Called to notify application when a manipulation is completed.
OnGestureEvent	Called to notify application about a multi-touch event.
OnResume	Called to resume a movie clip that is paused.
OnShutdown	Called to perform shutdown tasks before application exit.
OnSize	Called on window resize and should re-initialize renderer for the new view.
OnSizeEnter	Called when sizing begins and ends.
OnPadStick
OnStatus
OnTouchBegin	Called to notify application about beginning of a touch event such as a finger placed on the screen.
OnTouchEnd	Called to notify application about the end of a touch event such as release of finger from the screen.
OnTouchMove	Called to notify application about touch movement across the window screen.
OnUpdateCliboard	Called to notify application about keyboard content change.
OnUpdateFrame	Called in a loop to advance and update frame rendering.
ResetInputFocus	Resets current input focus to null.
RestoreWindow	Restores the window to its previous size.
SetCursor	Sets the cursor state for the window to the desired type.
SetFrameTime	Configures how often OnUpdateFrame will be called by default.
SetOrientationMode	Sets the screen orientation mode.
SetupWindow	Creates a window and initializes the application class.
SetWindowTitle	Changes/sets the window title.
Shutdown	Cleans up the application and kills the window.
TakeScreenShot	Takes a screen shot, saving it as the provided filename.
ViewConfigHasFlag	Determines if the ViewConfig has the passed flag set.

Structure	Description
IMEEvent	Base class for platform specific IME events passed to OnIMEEvent.

Platform.h