Typedefs
typedef void(*	C_EventCallback )(void usr, EventHandle events, UInt32 count)

Functions
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_createEvent (EventManagerHandle manager, EventId type, EventHandle *eventHandle)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_addEvent (EventManagerHandle manager, EventHandle instance, UInt32 *index)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_registerEvent (EventManagerHandle manager, const LEG_InteractionsDescriptor descPtr, EventId eventId)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_parameterId (EventManagerHandle manager, EventId eventType, const char parameterName, ParameterId out)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_setSelfReflecting (EventManagerHandle manager, LEG_Bool reflect)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_selfReflecting (EventManagerHandle manager, LEG_Bool *reflect)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_getEvents (EventManagerHandle manager, EventId eventType, EventHandle *events, UInt32 count)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_peekEvents (EventManagerHandle manager, EventId eventType, EventHandle *events, UInt32 count)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_addCallback (EventManagerHandle manager, EventId eventType, C_EventCallback func, void *usr)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_removeCallback (EventManagerHandle manager, EventId eventType, C_EventCallback func, void *usr)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_addInterest (EventManagerHandle manager, EventId eventType)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_eventManager_removeInterest (EventManagerHandle manager, EventId eventType)

LEGIONRUNTIME_DLL LEG_ReturnCode	legion_event_getType (EventHandle eventInstance, EventId *typeId)

Typedef Documentation

typedef void(* C_EventCallback)(void *usr, EventHandle *events, UInt32 count)

Event callback function prototype

Function Documentation

LEGIONRUNTIME_DLL LEG_ReturnCode legion_event_getType	(	EventHandle	eventInstance,
		EventId *	typeId
	)

Get event type from the event instance

Parameters

[in]	eventInstance	The event instance handle
[out]	typeId	Output the unique event type identifier for the event instance

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_addCallback	(	EventManagerHandle	manager,
		EventId	eventType,
		C_EventCallback	func,
		void *	usr
	)

Add and register event callback for the specified event type

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type
[in]	func	A callback function to add
[in]	usr	User data passed to the callback function

See Also: C_EventCallback

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Referenced by Legion::EventManager::addEventCallback().

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_addEvent	(	EventManagerHandle	manager,
		EventHandle	instance,
		UInt32 *	index
	)

Add an event interaction

Parameters

[in]	manager	The handle of event manager
[in]	instance	The event instance to add
[out]	index	Output an index used by Legion platform

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_addInterest	(	EventManagerHandle	manager,
		EventId	eventType
	)

Add interest to this event type

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_createEvent	(	EventManagerHandle	manager,
		EventId	type,
		EventHandle *	eventHandle
	)

Create an event object

Parameters

[in]	manager	The handle of event manager
[in]	type	The event type indentifier
[out]	eventHandle	Output the created event handle

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Referenced by Legion::EventManager::createEvent().

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_getEvents	(	EventManagerHandle	manager,
		EventId	eventType,
		EventHandle **	events,
		UInt32 *	count
	)

Get one type of events from current frame

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type
[out]	events	Return the input type of events from current frame
[out]	count	Total number of events returned

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Referenced by Legion::EventManager::getEvents().

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_parameterId	(	EventManagerHandle	manager,
		EventId	eventType,
		const char *	parameterName,
		ParameterId *	out
	)

Get parameter id associated with input event type and parameter name

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type
[in]	paramterName	A parameter name of input event type
[out]	ParameterId	Output parameter ID of the event type & parameter name

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_peekEvents	(	EventManagerHandle	manager,
		EventId	eventType,
		EventHandle **	events,
		UInt32 *	count
	)

Get one type of events from next frame

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type
[out]	events	Return the input type of events from current frame
[out]	count	Total number of events returned

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Referenced by Legion::EventManager::peekEvents().

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_registerEvent	(	EventManagerHandle	manager,
		const LEG_InteractionsDescriptor *	descPtr,
		EventId *	eventId
	)

Register an event interaction descriptor

Parameters

[in]	manager	The handle of event manager
[in]	descPtr	Pointer to the interaction descriptor
[out]	eventId	Output the unique identifier of the event registry

See Also: LEG_InteractionsDescriptor

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_removeCallback	(	EventManagerHandle	manager,
		EventId	eventType,
		C_EventCallback	func,
		void *	usr
	)

Remove and unregister event callback for the specified event type

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type
[in]	func	A callback function to add
[in]	usr	User data passed to the callback function

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Referenced by Legion::EventManager::removeEventCallback().

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_removeInterest	(	EventManagerHandle	manager,
		EventId	eventType
	)

Remove interest to this event type

Parameters

[in]	manager	The handle of event manager
[in]	eventType	An unique identifier for the event type

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_selfReflecting	(	EventManagerHandle	manager,
		LEG_Bool *	reflect
	)

Get self reflecting value

Parameters

[in]	manager	The handle of event manager
[out]	reflect	Output self reflecting boolean value

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONRUNTIME_DLL LEG_ReturnCode legion_eventManager_setSelfReflecting	(	EventManagerHandle	manager,
		LEG_Bool	reflect
	)

Set self reflecting

Parameters

[in]	manager	The handle of event manager
[in]	reflect	self reflecting value to set

Returns: LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

Typedefs

Functions

Typedef Documentation

Function Documentation