Input functions

This category contains functions for retrieving input data. More...

Data Structures
struct	fplGamepadStates
	A struct containing the full state for all gamepad devices. More...
struct	fplKeyboardState
	A struct containing the full keyboard state. More...
struct	fplMouseState
	A struct containing the full mouse state. More...

Macros
#define	FPL_MAX_GAMEPAD_STATE_COUNT
	Max number of gamepad states.
#define	FPL_MAX_KEYBOARD_STATE_COUNT
	Max number of keyboard states.

Typedefs
typedef struct fplGamepadStates	fplGamepadStates
	A struct containing the full state for all gamepad devices.
typedef struct fplKeyboardState	fplKeyboardState
	A struct containing the full keyboard state.
typedef struct fplMouseState	fplMouseState
	A struct containing the full mouse state.

Functions
fpl_platform_api bool	fplPollGamepadStates (fplGamepadStates *outStates)
	Polls the current gamepad states and writes it out into the output structure.
fpl_platform_api bool	fplPollKeyboardState (fplKeyboardState *outState)
	Polls the current keyboard state and writes it out into the output structure.
fpl_platform_api bool	fplPollMouseState (fplMouseState *outState)
	Polls the current mouse state and writes it out into the output structure.
fpl_platform_api bool	fplQueryCursorPosition (int32_t *outX, int32_t *outY)
	Queries the cursor position in screen coordinates, relative to the root screen.

Detailed Description

This category contains functions for retrieving input data.

Macro Definition Documentation

FPL_MAX_GAMEPAD_STATE_COUNT

#define FPL_MAX_GAMEPAD_STATE_COUNT

Max number of gamepad states.

Definition at line 6241 of file final_platform_layer.h.

FPL_MAX_KEYBOARD_STATE_COUNT

#define FPL_MAX_KEYBOARD_STATE_COUNT

Max number of keyboard states.

Definition at line 6228 of file final_platform_layer.h.

Function Documentation

fplPollGamepadStates()

fpl_platform_api bool fplPollGamepadStates

(

fplGamepadStates *

outStates

)

Polls the current gamepad states and writes it out into the output structure.

Parameters

outStates

The pointer to the fplGamepadStates structure

See also

Gamepad

fplPollKeyboardState()

fpl_platform_api bool fplPollKeyboardState

(

fplKeyboardState *

outState

)

Polls the current keyboard state and writes it out into the output structure.

Parameters

outState

The pointer to the fplKeyboardState structure

See also

Keyboard

fplPollMouseState()

fpl_platform_api bool fplPollMouseState

(

fplMouseState *

outState

)

Polls the current mouse state and writes it out into the output structure.

Parameters

outState

The pointer to the fplMouseState structure

See also

Mouse

fplQueryCursorPosition()

fpl_platform_api bool fplQueryCursorPosition	(	int32_t *	outX,
		int32_t *	outY
	)

Queries the cursor position in screen coordinates, relative to the root screen.

Parameters

outX	The pointer to the out going X position
outY	The pointer to the out going Y position