Torque Game Engine Documentation
TGE Version 1.5.2

engine/platformMacCarb/macCarbEvents.h File Reference

Functions

void MacCarbCheckHideCursor (S32 x=-1, S32 y=-1)

Hides the mouse cursor when the mouse is locked, when we are in fullscreen mode, and when the cursor is inside the window bounds.

void MacCarbSetHideCursor (bool shouldHide)

Hides or shows the system mouse cursor, regardless of the mouse position, and tracks the hidden state.

void MacCarbInstallCarbonEventHandlers (void)

Install event handlers on the current window & on the app.

void MacCarbRemoveCarbonEventHandlers (void)

Remove all event handlers, except the alert event handlers.

void MacCarbInstallTorqueCarbonEventHandlers (void)

Install event handlers for custom Torque inter-thread communication.

void MacCarbSendTorqueEventToMain (U32 eventKind, void *userData=NULL)

create an event of class kEventClassTorque, and send it to the main thread

Variables

const U32 kEventClassTorque = 'TORQ'

event type for alerts. The event class is an arbitrary val, it must not collide w/ kEventApp* .

const U32 kEventTorqueAlert = 1

const U32 kEventTorqueFadeInWindow = 2

const U32 kEventTorqueFadeOutWindow = 3

const U32 kEventTorqueReleaseWindow = 4

const U32 kEventTorqueShowMenuBar = 5

const U32 kEventParamTorqueData = 'tDAT'

Function Documentation

void MacCarbCheckHideCursor	(	S32	x = `-1`,
		S32	y = `-1`
	)

Hides the mouse cursor when the mouse is locked, when we are in fullscreen mode, and when the cursor is inside the window bounds.

Optionally takes the cursor location, in window local coords.

void MacCarbSetHideCursor ( bool shouldHide )

Hides or shows the system mouse cursor, regardless of the mouse position, and tracks the hidden state.

void MacCarbInstallCarbonEventHandlers ( void )

Install event handlers on the current window & on the app.

void MacCarbRemoveCarbonEventHandlers ( void )

Remove all event handlers, except the alert event handlers.

void MacCarbInstallTorqueCarbonEventHandlers ( void )

Install event handlers for custom Torque inter-thread communication.

This must be called before starting multithreaded execution in main().

void MacCarbSendTorqueEventToMain	(	U32	eventKind,
		void *	userData = `NULL`
	)

create an event of class kEventClassTorque, and send it to the main thread

const U32 kEventClassTorque = 'TORQ'

event type for alerts. The event class is an arbitrary val, it must not collide w/ kEventApp* .

const U32 kEventTorqueAlert = 1

const U32 kEventParamTorqueData = 'tDAT'