Platform functions

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

Functions
fpl_common_api const char *	fplGetPlatformName (const fplPlatformType type)
	Gets the string representation of the given platform type.
fpl_common_api fplPlatformResultType	fplGetPlatformResult (void)
	Gets the result type of the platform initialization.
fpl_common_api fplPlatformType	fplGetPlatformType (void)
	Gets the type of the platform.
fpl_common_api bool	fplIsPlatformInitialized (void)
	Gets a value indicating whether the platform is initialized.
fpl_common_api bool	fplPlatformInit (const fplInitFlags initFlags, const fplSettings *initSettings)
	Initializes the platform layer.
fpl_common_api void	fplPlatformRelease (void)
	Releases the resources allocated by the platform layer.

Detailed Description

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

Function Documentation

fplGetPlatformName()

fpl_common_api const char * fplGetPlatformName

(

const fplPlatformType

type

)

Gets the string representation of the given platform type.

Parameters

[in]

type

The platform type enumeration value 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

(

void

)

Gets the result type of the platform initialization.

Returns

Returns the platform result type enumeration value fplPlatformResultType.

See also

Check platform result

fplGetPlatformType()

fpl_common_api fplPlatformType fplGetPlatformType

(

void

)

Gets the type of the platform.

Returns

Returns the fplPlatformType.

See also

Get Current Platform Type/Name

fplIsPlatformInitialized()

fpl_common_api bool fplIsPlatformInitialized

(

void

)

Gets a value indicating whether the platform is initialized.

Returns

Returns true if the platform is initialized, false otherwise.

fplPlatformInit()

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

Initializes the platform layer.

Parameters

[in]	initFlags	The init flags fplInitFlags used to enable certain features, like video/audio, etc.
[in]	initSettings	Reference to the source structure fplSettings, that controls the platform layer behaviors 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

(

void

)

Releases the resources allocated by the platform layer.

Note

Can only be called when fplPlatformInit() was successful.

See also

Releasing the Platform