CAPI_GamepadEvent.h

Overview

Gamepad event interface.

#include <Ultralight/CAPI/CAPI_GamepadEvent.h>

This file defines the C API for gamepad events.

See also

ulFireGamepadEvent

Functions
ULGamepadEvent	ulCreateGamepadEvent (unsigned int index, ULGamepadEventType type)
	Create a gamepad event.
void	ulDestroyGamepadEvent (ULGamepadEvent evt)
	Destroy a gamepad event created by ulCreateGamepadEvent().
ULGamepadAxisEvent	ulCreateGamepadAxisEvent (unsigned int index, unsigned int axis_index, double value)
	Create a gamepad axis event.
void	ulDestroyGamepadAxisEvent (ULGamepadAxisEvent evt)
	Destroy a gamepad axis event created by ulCreateGamepadAxisEvent().
ULGamepadButtonEvent	ulCreateGamepadButtonEvent (unsigned int index, unsigned int button_index, double value)
	Create a gamepad button event.
void	ulDestroyGamepadButtonEvent (ULGamepadButtonEvent evt)
	Destroy a gamepad button event created by ulCreateGamepadButtonEvent().

Function Documentation

ulCreateGamepadAxisEvent()

ULGamepadAxisEvent ulCreateGamepadAxisEvent	(	unsigned int	index,
		unsigned int	axis_index,
		double	value )

Create a gamepad axis event.

Parameters

index	The index of the gamepad.
axis_index	The index of the axis whose value has changed.
value	The new value of the axis, normalized to [-1.0, 1.0].

Returns

A new ULGamepadAxisEvent instance. You must call ulDestroyGamepadAxisEvent() when finished.

ulCreateGamepadButtonEvent()

ULGamepadButtonEvent ulCreateGamepadButtonEvent	(	unsigned int	index,
		unsigned int	button_index,
		double	value )

Create a gamepad button event.

Parameters

index	The index of the gamepad.
button_index	The index of the button whose value has changed.
value	The new value of the button, normalized to [0.0, 1.0]. Any value greater than 0.0 is considered "pressed".

Returns

A new ULGamepadButtonEvent instance. You must call ulDestroyGamepadButtonEvent() when finished.

ulCreateGamepadEvent()

ULGamepadEvent ulCreateGamepadEvent	(	unsigned int	index,
		ULGamepadEventType	type )

Create a gamepad event.

Parameters

index	The index of the gamepad (should match ulSetGamepadDetails()).
type	The type of gamepad event.

Returns

A new ULGamepadEvent instance. You must call ulDestroyGamepadEvent() when finished.

ulDestroyGamepadAxisEvent()

void ulDestroyGamepadAxisEvent

(

ULGamepadAxisEvent

evt

)

Destroy a gamepad axis event created by ulCreateGamepadAxisEvent().

ulDestroyGamepadButtonEvent()

void ulDestroyGamepadButtonEvent

(

ULGamepadButtonEvent

evt

)

Destroy a gamepad button event created by ulCreateGamepadButtonEvent().

ulDestroyGamepadEvent()

void ulDestroyGamepadEvent

(

ULGamepadEvent

evt

)

Destroy a gamepad event created by ulCreateGamepadEvent().

Go to the source code of this file.