VPADSetLcdMode

Syntax

#include <cafe/vpad.h>

s32 VPADSetLcdMode( s32 chan, VPADLcdMode mode );

Parameters

chan Controller number. 0 for DRC1 and 1 for DRC2.
mode LCD mode of DRC.

Return Values

If the function succeeds, the return value is zero. If the function fails, the return value is negative.

Description

This function sets the DRC's LCD mode using elements of the VPADLcdMode structure. VPAD_LCD_MODE_ON is the normal state (LCD is on) whereas VPAD_LCD_MODE_MUTE is the same mode that can be set from the HOME Menu of the DRC. In VPAD_LCD_MODE_MUTE mode, the battery LED blinks a blue color when the DRC's battery is full and the battery LED blinks orange when the battery is charging.

VPAD_LCD_MODE_GAME_CONTROLLER mode uses the DRC only as a game controller and the LCD is off. This mode is useful to reduce the electrical power consumption of the DRC. When you use this mode, it is recommended to output the black screen data for the DRC.
When the HOME Button is pressed, the HOME Menu is launched and the LCD on the DRC turns on automatically. When returning back to the game application, the LCD mode is automatically returned to VPAD_LCD_MODE_GAME_CONTROLLER mode. This mode is defined as DRC game controller mode. In this mode, the battery LED is lit blue when the DRC's battery is full.

NOTE:
If you set Display Off from the HOME Menu, behavior is as VPAD_LCD_MODE_MUTE, but is returned to VPAD_LCD_MODE_GAME_CONTROLLER mode.

Do Not Call From

Background Do not call this function from the background.
Multiple threads This function is not thread-safe.
Multiple Cores Do not call this function from more than one Core.

See Also

VPADLcdMode
VPADGetLcdMode

Revision History

2015/03/03 Updated struct info and link.
2014/01/21 Terminology change to HOME Menu.
2013/08/07 Added the comment for battery LED to the description.
2013/05/15 Initial version.


CONFIDENTIAL