VIB_Init

C Specification

#include <nitro/vib.h>
BOOL VIB_Init(void);
 

Arguments

None.

Return Values

Returns TRUE if the Rumble Pak is enabled; otherwise, returns FALSE.

Description

Initializes pulse vibration.

A callback for stopping vibrations before entering sleep mode is registered inside this function using PM_AppendPreSleepCallback.

A callback for stopping vibrations if removal of the Game Pak is detected is also registered inside this function. If a callback for Game Pak removal is set using the CTRDG_SetPulledOutCallback function after this function has been called, the Game Pak removal callback set by VIB_Init will be overwritten. In this case, vibrations must be stopped inside the Rumble Pak callback that has been set.
If you want to carry out processing inside the Game Pak removal callback besides stopping vibration, register a callback using VIB_SetCartridgePulloutCallback and make sure to proceed the desired processing inside that callback.

If this function is called a second time when it has already been called once before, operations are equivalent to VIB_IsCartridgeEnabled.

See Also

VIB_SetCartridgePulloutCallback VIB_End

Revision History

02/28/2006 Added a description.
08/16/2005 Initial version.

CONFIDENTIAL