nn::hid::CTR Namespace

Description

Namespace for the CTR's HID (Human Interface Device) functionality.
(This can also be written without the ::CTR portion.)

Classes

nn::hid::CTR::Accelerometer Class that contains the resources required for getting sampling data from the accelerometer. Use the nn::hid::CTR::GetAccelerometer function to get a reference to a valid instance.
nn::hid::CTR::AccelerometerReader Class for loading sampling data from the accelerometer.
nn::hid::CTR::DebugPad A class that has the resources necessary to get sampling data from the debug pad (a game controller used for debugging). Call nn::hid::CTR::GetDebugPad to get a reference to a valid instance.
nn::hid::CTR::DebugPadReader Class for loading sampling data from the game controller used for debugging (the debug pad).
nn::hid::CTR::Gyroscope The class with the resources necessary to get sampling data from the gyro sensor. Use the nn::hid::CTR::GetGyroscope function to get a reference to a valid instance of this class.
nn::hid::CTR::GyroscopeReader Class for loading sampling data from the gyro sensor.
nn::hid::CTR::HidBase Base HID class.
nn::hid::CTR::Pad Class that contains the resources required for getting sampling data from the buttons and the Circle Pad. Use the nn::hid::CTR::GetPad function to get a reference to a valid instance.
nn::hid::CTR::PadReader Class for loading sampling data from the game pad (which consists of the buttons and the Circle Pad).
nn::hid::CTR::TouchPanel Class that contains the resources required for getting sampling data from the Touch Screen. Use the nn::hid::CTR::GetTouchPanel function to get a reference to a valid instance.
nn::hid::CTR::TouchPanelReader Class for loading sampling data from the Touch Screen.
nn::hid::CTR::MakeResultAlreadyInitialized Indicates that the HID library has already been initialized.
nn::hid::CTR::MakeResultInvalidCombination Indicates that an invalid combination of arguments has been used.

Structures

nn::hid::CTR::AnalogStickStatus Structure used to store sampling data from the Circle Pad.
nn::hid::CTR::PadStatus Structure used to store sampling data from the buttons and the Circle Pad.
nn::hid::CTR::TouchPanelStatus Structure used to store sampling data from the Touch Screen.
nn::hid::CTR::AccelerometerStatus Structure used to store sampling data from the accelerometer.
nn::hid::CTR::AccelerationFloat Structure used to store the acceleration (in g's) from the accelerometer.
nn::hid::CTR::Direction Structure storing the 3D attitude.
nn::hid::CTR::GyroscopeStatus This structure maintains the data acquired from the gyro sensor.
nn::hid::CTR::DebugPadStatus Structure used to store sampling data from the buttons and Circle Pad on the debug pad.

Enumerated Types

ZeroDriftMode Enumerated type for setting the strength of the correction for zero-point drift.

Constants

MAX_OF_ACCELEROMETER_VALUE const s16 Absolute value of the maximum value that the accelerometer can detect.
ACCELEROMETER_VALUE_PER_1G const s16 Accelerometer value equivalent to 1 g of acceleration.
MAX_OF_ACCELEROMETER_PLAY const s16 Maximum value for the play range of the accelerometer.
MAX_OF_ACCELEROMETER_SENSITIVITY const s16 Maximum value for the accelerometer sensitivity.
MIN_OF_STICK_CLAMP_MODE_CIRCLE const s16 The minimum play that is appropriate for circular clamping of the Circle Pad.
MIN_OF_STICK_CLAMP_MODE_CROSS const s16 The minimum play that is appropriate for cross-shaped (+Control Pad-shaped) clamping of the Circle Pad.
LIMIT_OF_STICK_CLAMP_MAX const s16 Maximum value for Circle Pad clamping.
BUTTON_A const bit32 A Button.
BUTTON_B const bit32 B Button.
BUTTON_SELECT_FOR_DEBUGGING const bit32 SELECT
BUTTON_START const bit32 START Button
BUTTON_RIGHT const bit32 Right on the +Control Pad.
BUTTON_LEFT const bit32 Left on the +Control Pad.
BUTTON_UP const bit32 Up on the +Control Pad.
BUTTON_DOWN const bit32 Down on the +Control Pad.
BUTTON_R const bit32 R Button.
BUTTON_L const bit32 L Button.
BUTTON_X const bit32 X Button.
BUTTON_Y const bit32 Y Button.
BUTTON_DEBUG const bit32 DEBUG Button.
BUTTON_EMULATION_RIGHT const bit32 Right on the emulated +Control Pad, using the Circle Pad input.
BUTTON_EMULATION_LEFT const bit32 Left on the emulated +Control Pad, using the Circle Pad input.
BUTTON_EMULATION_UP const bit32 Up on the emulated +Control Pad, using the Circle Pad input.
BUTTON_EMULATION_DOWN const bit32 Down on the emulated +Control Pad, using the Circle Pad input.
BUTTON_MASK const bit32 Input mask that includes everything other than the +Control Pad (the +Control Pad includes emulation).
PLUS_BUTTON_MASK const bit32 Input mask for the +Control Pad (excluding emulation).
PLUS_BUTTON_EMULATION_MASK const bit32 Input mask for +Control Pad emulation.
ALL_MASK const bit32 All input.
DEBUG_PAD_BUTTON_UP const bit16 Up on the +Control Pad of the debug pad.
DEBUG_PAD_BUTTON_LEFT const bit16 Left on the +Control Pad of the debug pad.
DEBUG_PAD_TRIGGER_ZR const bit16 The ZR Button on the debug pad.
DEBUG_PAD_BUTTON_X const bit16 The X Button on the debug pad.
DEBUG_PAD_BUTTON_A const bit16 The A Button on the debug pad.
DEBUG_PAD_BUTTON_Y const bit16 The Y Button on the debug pad.
DEBUG_PAD_BUTTON_B const bit16 The B Button on the debug pad.
DEBUG_PAD_TRIGGER_ZL const bit16 The ZL Button on the debug pad.
DEBUG_PAD_TRIGGER_R const bit16 The R Button on the debug pad.
DEBUG_PAD_BUTTON_PLUS const bit16 The + Button on the debug pad.
DEBUG_PAD_BUTTON_HOME const bit16 The HOME Button on the debug pad.
DEBUG_PAD_BUTTON_MINUS const bit16 The - Button on the debug pad.
DEBUG_PAD_TRIGGER_L const bit16 The L Button on the debug pad.
DEBUG_PAD_BUTTON_DOWN const bit16 Down on the +Control Pad of the debug pad.
DEBUG_PAD_BUTTON_RIGHT const bit16 Right on the +Control Pad of the debug pad.

Functions

Initialize/Finalize
Initialize Initializes the HID library and enables loading of the sampling data.
Finalize Finalizes the HID library.
Other
GetPad Gets a reference to an instance of the Pad class.
GetTouchPanel Gets a reference to an instance of the TouchPanel class.
GetAccelerometer Gets a reference to an instance of the Accelerometer class.
GetGyroscope Gets a reference to an instance of the Gyroscope class.
GetDebugPad Gets a reference to an instance of the DebugPad class.
EnableSelectButton Enables sampling of the SELECT Button. This feature is only available if Debug mode has been enabled from the Config tool.
DisableSelectButton Disables sampling of the SELECT Button.

Revision History

2010/01/07
Initial version.

CONFIDENTIAL