Final Platform Layer  0.9.2.0
Functions
Platform functions

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

Functions

fplPlatformResultType fplGetPlatformResult ()
 Gets the result type of the platform initialization. More...
 
fplPlatformType fplGetPlatformType ()
 Gets the type of the platform. More...
 
const char * fplGetPlatformTypeString (const fplPlatformType type)
 Gets the string representation of the given platform type. More...
 
bool fplPlatformInit (const fplInitFlags initFlags, const fplSettings *initSettings)
 Initializes the platform layer. More...
 
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

◆ fplGetPlatformResult()

fplPlatformResultType fplGetPlatformResult ( )

Gets the result type of the platform initialization.

Returns
Returns the result type as fplPlatformResultType

◆ fplGetPlatformType()

fplPlatformType fplGetPlatformType ( )

Gets the type of the platform.

Returns
Returns the fplPlatformType

◆ fplGetPlatformTypeString()

const char* fplGetPlatformTypeString ( 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

◆ fplPlatformInit()

bool fplPlatformInit ( const fplInitFlags  initFlags,
const fplSettings initSettings 
)

Initializes the platform layer.

Parameters
initFlagsThe init flags fplInitFlags used for 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.

◆ fplPlatformRelease()

void fplPlatformRelease ( )

Releases the resources allocated by the platform layer.

Note
Can only be called when fplPlatformInit() was successful.