Final Platform Layer  0.9.6-beta
Functions
Platform functions

This category contains structures, enumerations and functions for initializing/releasing the platform. More...

Functions

const fpl_common_api char * fplGetPlatformName (const fplPlatformType type)
 Gets the string representation of the given platform type. More...
 
fpl_common_api fplPlatformResultType fplGetPlatformResult ()
 Gets the result type of the platform initialization. More...
 
fpl_common_api fplPlatformType fplGetPlatformType ()
 Gets the type of the platform. More...
 
fpl_common_api bool fplIsPlatformInitialized ()
 Returns true when the platform is initialized, or false if not.
 
fpl_common_api bool fplPlatformInit (const fplInitFlags initFlags, const fplSettings *initSettings)
 Initializes the platform layer. More...
 
fpl_common_api void fplPlatformRelease ()
 Releases the resources allocated by the platform layer. More...
 

Detailed Description

This category contains structures, enumerations and functions for initializing/releasing the platform.

Function Documentation

◆ fplGetPlatformName()

const fpl_common_api char* fplGetPlatformName ( const fplPlatformType  type)

Gets the string representation of the given platform type.

Parameters
typeThe platform type fplPlatformType
Returns
Returns the string representation for the given platform type fplPlatformType
See also
Get Current Platform Type/Name

◆ fplGetPlatformResult()

fpl_common_api fplPlatformResultType fplGetPlatformResult ( )

Gets the result type of the platform initialization.

Returns
Returns the result type as fplPlatformResultType
See also
Check platform result

◆ fplGetPlatformType()

fpl_common_api fplPlatformType fplGetPlatformType ( )

Gets the type of the platform.

Returns
Returns the fplPlatformType
See also
Get Current Platform Type/Name

◆ fplPlatformInit()

fpl_common_api bool fplPlatformInit ( const fplInitFlags  initFlags,
const fplSettings initSettings 
)

Initializes the platform layer.

Parameters
initFlagsThe init flags fplInitFlags used to enable certain features, like video/audio, etc.
initSettingsThe fplSettings structure to control the platform layer behavior or systems, if null is passed here default values are used automatically.
Returns
Returns true when it was successful, false otherwise.
Note
fplPlatformRelease() must be called when you are done! After fplPlatformRelease() has been called you can call this function again if needed.
See also
Initialization with default settings

◆ fplPlatformRelease()

fpl_common_api void fplPlatformRelease ( )

Releases the resources allocated by the platform layer.

Note
Can only be called when fplPlatformInit() was successful.
See also
Releasing the Platform