Human input device (hid) service IPC wrapper. More...

#include "../types.h"
#include "../kernel/event.h"
#include "../services/btdrv_types.h"
#include "../sf/service.h"

Go to the source code of this file.

Data Structures
struct	HidAnalogStickState
	HidAnalogStickState. More...

struct	HidVector
	HidVector. More...

struct	HidDirectionState
	HidDirectionState. More...

struct	HidCommonLifoHeader
	HidCommonLifoHeader. More...

struct	HidDebugPadState
	HidDebugPadState. More...

struct	HidDebugPadStateAtomicStorage
	HidDebugPadStateAtomicStorage. More...

struct	HidDebugPadLifo
	HidDebugPadLifo. More...

struct	HidDebugPadSharedMemoryFormat
	HidDebugPadSharedMemoryFormat. More...

struct	HidTouchState
	HidTouchState. More...

struct	HidTouchScreenState
	HidTouchScreenState. More...

struct	HidTouchScreenStateAtomicStorage
	HidTouchScreenStateAtomicStorage. More...

struct	HidTouchScreenLifo
	HidTouchScreenLifo. More...

struct	HidTouchScreenSharedMemoryFormat
	HidTouchScreenSharedMemoryFormat. More...

struct	HidTouchScreenConfigurationForNx
	HidTouchScreenConfigurationForNx. More...

struct	HidMouseState
	HidMouseState. More...

struct	HidMouseStateAtomicStorage
	HidMouseStateAtomicStorage. More...

struct	HidMouseLifo
	HidMouseLifo. More...

struct	HidMouseSharedMemoryFormat
	HidMouseSharedMemoryFormat. More...

struct	HidKeyboardState
	HidKeyboardState. More...

struct	HidKeyboardStateAtomicStorage
	HidKeyboardStateAtomicStorage. More...

struct	HidKeyboardLifo
	HidKeyboardLifo. More...

struct	HidKeyboardSharedMemoryFormat
	HidKeyboardSharedMemoryFormat. More...

struct	HidNpadControllerColor
	Npad colors. More...

struct	HidNpadFullKeyColorState
	HidNpadFullKeyColorState. More...

struct	HidNpadJoyColorState
	HidNpadJoyColorState. More...

struct	HidNpadCommonState
	HidNpadCommonState. More...

struct	HidNpadGcState
	State for HidNpadStyleTag_NpadGc. Loaded from the same lifo as HidNpadFullKeyState, with the additional trigger_l/trigger_r loaded from elsewhere. More...

struct	HidNpadLarkState
	State for HidNpadStyleTag_NpadLark. The base state is loaded from the same lifo as HidNpadFullKeyState. More...

struct	HidNpadHandheldLarkState
	State for HidNpadStyleTag_NpadHandheldLark. The base state is loaded from the same lifo as HidNpadHandheldState. More...

struct	HidNpadLuciaState
	State for HidNpadStyleTag_NpadLucia. The base state is loaded from the same lifo as HidNpadFullKeyState. More...

struct	HidNpadCommonStateAtomicStorage
	HidNpadCommonStateAtomicStorage. More...

struct	HidNpadCommonLifo
	HidNpadCommonLifo. More...

struct	HidNpadGcTriggerState
	HidNpadGcTriggerState. More...

struct	HidNpadGcTriggerStateAtomicStorage
	HidNpadGcTriggerStateAtomicStorage. More...

struct	HidNpadGcTriggerLifo
	HidNpadGcTriggerLifo. More...

struct	HidSixAxisSensorState
	HidSixAxisSensorState. More...

struct	HidSixAxisSensorStateAtomicStorage
	HidSixAxisSensorStateAtomicStorage. More...

struct	HidNpadSixAxisSensorLifo
	HidNpadSixAxisSensorLifo. More...

struct	HidNpadSystemProperties
	NpadSystemProperties. More...

struct	HidNpadSystemButtonProperties
	NpadSystemButtonProperties. More...

struct	HidPowerInfo
	HidPowerInfo (system) More...

struct	XcdDeviceHandle
	XcdDeviceHandle. More...

struct	HidNfcXcdDeviceHandleStateImpl
	HidNfcXcdDeviceHandleStateImpl. More...

struct	HidNfcXcdDeviceHandleStateImplAtomicStorage
	HidNfcXcdDeviceHandleStateImplAtomicStorage. More...

struct	HidNfcXcdDeviceHandleState
	HidNfcXcdDeviceHandleState. More...

struct	HidNpadInternalState
	HidNpadInternalState. More...

struct	HidNpadSharedMemoryEntry
	HidNpadSharedMemoryEntry. More...

struct	HidNpadSharedMemoryFormat
	HidNpadSharedMemoryFormat. More...

struct	HidGesturePoint
	HidGesturePoint. More...

struct	HidGestureState
	HidGestureState. More...

struct	HidGestureDummyStateAtomicStorage
	HidGestureDummyStateAtomicStorage. More...

struct	HidGestureLifo
	HidGestureLifo. More...

struct	HidGestureSharedMemoryFormat
	HidGestureSharedMemoryFormat. More...

struct	HidConsoleSixAxisSensor
	HidConsoleSixAxisSensor. More...

struct	HidSharedMemory
	HidSharedMemory. More...

struct	HidSevenSixAxisSensorState
	HidSevenSixAxisSensorState. More...

struct	HidSevenSixAxisSensorStateEntry
	HidSevenSixAxisSensorStateEntry. More...

struct	HidSevenSixAxisSensorStates
	HidSevenSixAxisSensorStates. More...

union	HidSixAxisSensorHandle
	HidSixAxisSensorHandle. More...

union	HidVibrationDeviceHandle
	HidVibrationDeviceHandle. More...

struct	HidVibrationDeviceInfo
	HidVibrationDeviceInfo. More...

struct	HidVibrationValue
	HidVibrationValue. More...

struct	HidPalmaConnectionHandle
	PalmaConnectionHandle. More...

struct	HidPalmaOperationInfo
	PalmaOperationInfo. More...

struct	HidPalmaApplicationSectionAccessBuffer
	PalmaApplicationSectionAccessBuffer. More...

struct	HidPalmaActivityEntry
	PalmaActivityEntry. More...

Macros
#define	JOYSTICK_MAX (0x7FFF)

#define	JOYSTICK_MIN (-0x7FFF)

Typedefs
typedef HidNpadCommonState	HidNpadFullKeyState
	State for HidNpadStyleTag_NpadFullKey.

typedef HidNpadCommonState	HidNpadHandheldState
	State for HidNpadStyleTag_NpadHandheld.

typedef HidNpadCommonState	HidNpadJoyDualState
	State for HidNpadStyleTag_NpadJoyDual.

typedef HidNpadCommonState	HidNpadJoyLeftState
	State for HidNpadStyleTag_NpadJoyLeft.

typedef HidNpadCommonState	HidNpadJoyRightState
	State for HidNpadStyleTag_NpadJoyRight.

typedef HidNpadCommonState	HidNpadPalmaState
	State for HidNpadStyleTag_NpadPalma.

typedef HidNpadCommonState	HidNpadLagerState
	State for HidNpadStyleTag_NpadLager. Analog-sticks state are always zero.

typedef HidNpadCommonState	HidNpadSystemExtState
	State for HidNpadStyleTag_NpadSystemExt.

typedef HidNpadCommonState	HidNpadSystemState
	State for HidNpadStyleTag_NpadSystem. Analog-sticks state are always zero. Only the following button bits are available: HidNpadButton_A, HidNpadButton_B, HidNpadButton_X, HidNpadButton_Y, HidNpadButton_Left, HidNpadButton_Up, HidNpadButton_Right, HidNpadButton_Down, HidNpadButton_L, HidNpadButton_R.

Enumerations
enum	HidDebugPadButton { HidDebugPadButton_A = (1U<<( 0 )) , HidDebugPadButton_B = (1U<<( 1 )) , HidDebugPadButton_X = (1U<<( 2 )) , HidDebugPadButton_Y = (1U<<( 3 )) , HidDebugPadButton_L = (1U<<( 4 )) , HidDebugPadButton_R = (1U<<( 5 )) , HidDebugPadButton_ZL = (1U<<( 6 )) , HidDebugPadButton_ZR = (1U<<( 7 )) , HidDebugPadButton_Start = (1U<<( 8 )) , HidDebugPadButton_Select = (1U<<( 9 )) , HidDebugPadButton_Left = (1U<<( 10 )) , HidDebugPadButton_Up = (1U<<( 11 )) , HidDebugPadButton_Right = (1U<<( 12 )) , HidDebugPadButton_Down = (1U<<( 13 )) }
	HidDebugPadButton. More...

enum	HidTouchScreenModeForNx { HidTouchScreenModeForNx_UseSystemSetting = 0 , HidTouchScreenModeForNx_Finger = 1 , HidTouchScreenModeForNx_Heat2 = 2 }
	HidTouchScreenModeForNx. More...

enum	HidMouseButton { HidMouseButton_Left = (1U<<( 0 )) , HidMouseButton_Right = (1U<<( 1 )) , HidMouseButton_Middle = (1U<<( 2 )) , HidMouseButton_Forward = (1U<<( 3 )) , HidMouseButton_Back = (1U<<( 4 )) }
	HidMouseButton.

enum	HidKeyboardKey { HidKeyboardKey_A = 4 , HidKeyboardKey_B = 5 , HidKeyboardKey_C = 6 , HidKeyboardKey_D = 7 , HidKeyboardKey_E = 8 , HidKeyboardKey_F = 9 , HidKeyboardKey_G = 10 , HidKeyboardKey_H = 11 , HidKeyboardKey_I = 12 , HidKeyboardKey_J = 13 , HidKeyboardKey_K = 14 , HidKeyboardKey_L = 15 , HidKeyboardKey_M = 16 , HidKeyboardKey_N = 17 , HidKeyboardKey_O = 18 , HidKeyboardKey_P = 19 , HidKeyboardKey_Q = 20 , HidKeyboardKey_R = 21 , HidKeyboardKey_S = 22 , HidKeyboardKey_T = 23 , HidKeyboardKey_U = 24 , HidKeyboardKey_V = 25 , HidKeyboardKey_W = 26 , HidKeyboardKey_X = 27 , HidKeyboardKey_Y = 28 , HidKeyboardKey_Z = 29 , HidKeyboardKey_D1 = 30 , HidKeyboardKey_D2 = 31 , HidKeyboardKey_D3 = 32 , HidKeyboardKey_D4 = 33 , HidKeyboardKey_D5 = 34 , HidKeyboardKey_D6 = 35 , HidKeyboardKey_D7 = 36 , HidKeyboardKey_D8 = 37 , HidKeyboardKey_D9 = 38 , HidKeyboardKey_D0 = 39 , HidKeyboardKey_Return = 40 , HidKeyboardKey_Escape = 41 , HidKeyboardKey_Backspace = 42 , HidKeyboardKey_Tab = 43 , HidKeyboardKey_Space = 44 , HidKeyboardKey_Minus = 45 , HidKeyboardKey_Plus = 46 , HidKeyboardKey_OpenBracket = 47 , HidKeyboardKey_CloseBracket = 48 , HidKeyboardKey_Pipe = 49 , HidKeyboardKey_Tilde = 50 , HidKeyboardKey_Semicolon = 51 , HidKeyboardKey_Quote = 52 , HidKeyboardKey_Backquote = 53 , HidKeyboardKey_Comma = 54 , HidKeyboardKey_Period = 55 , HidKeyboardKey_Slash = 56 , HidKeyboardKey_CapsLock = 57 , HidKeyboardKey_F1 = 58 , HidKeyboardKey_F2 = 59 , HidKeyboardKey_F3 = 60 , HidKeyboardKey_F4 = 61 , HidKeyboardKey_F5 = 62 , HidKeyboardKey_F6 = 63 , HidKeyboardKey_F7 = 64 , HidKeyboardKey_F8 = 65 , HidKeyboardKey_F9 = 66 , HidKeyboardKey_F10 = 67 , HidKeyboardKey_F11 = 68 , HidKeyboardKey_F12 = 69 , HidKeyboardKey_PrintScreen = 70 , HidKeyboardKey_ScrollLock = 71 , HidKeyboardKey_Pause = 72 , HidKeyboardKey_Insert = 73 , HidKeyboardKey_Home = 74 , HidKeyboardKey_PageUp = 75 , HidKeyboardKey_Delete = 76 , HidKeyboardKey_End = 77 , HidKeyboardKey_PageDown = 78 , HidKeyboardKey_RightArrow = 79 , HidKeyboardKey_LeftArrow = 80 , HidKeyboardKey_DownArrow = 81 , HidKeyboardKey_UpArrow = 82 , HidKeyboardKey_NumLock = 83 , HidKeyboardKey_NumPadDivide = 84 , HidKeyboardKey_NumPadMultiply = 85 , HidKeyboardKey_NumPadSubtract = 86 , HidKeyboardKey_NumPadAdd = 87 , HidKeyboardKey_NumPadEnter = 88 , HidKeyboardKey_NumPad1 = 89 , HidKeyboardKey_NumPad2 = 90 , HidKeyboardKey_NumPad3 = 91 , HidKeyboardKey_NumPad4 = 92 , HidKeyboardKey_NumPad5 = 93 , HidKeyboardKey_NumPad6 = 94 , HidKeyboardKey_NumPad7 = 95 , HidKeyboardKey_NumPad8 = 96 , HidKeyboardKey_NumPad9 = 97 , HidKeyboardKey_NumPad0 = 98 , HidKeyboardKey_NumPadDot = 99 , HidKeyboardKey_Backslash = 100 , HidKeyboardKey_Application = 101 , HidKeyboardKey_Power = 102 , HidKeyboardKey_NumPadEquals = 103 , HidKeyboardKey_F13 = 104 , HidKeyboardKey_F14 = 105 , HidKeyboardKey_F15 = 106 , HidKeyboardKey_F16 = 107 , HidKeyboardKey_F17 = 108 , HidKeyboardKey_F18 = 109 , HidKeyboardKey_F19 = 110 , HidKeyboardKey_F20 = 111 , HidKeyboardKey_F21 = 112 , HidKeyboardKey_F22 = 113 , HidKeyboardKey_F23 = 114 , HidKeyboardKey_F24 = 115 , HidKeyboardKey_NumPadComma = 133 , HidKeyboardKey_Ro = 135 , HidKeyboardKey_KatakanaHiragana = 136 , HidKeyboardKey_Yen = 137 , HidKeyboardKey_Henkan = 138 , HidKeyboardKey_Muhenkan = 139 , HidKeyboardKey_NumPadCommaPc98 = 140 , HidKeyboardKey_HangulEnglish = 144 , HidKeyboardKey_Hanja = 145 , HidKeyboardKey_Katakana = 146 , HidKeyboardKey_Hiragana = 147 , HidKeyboardKey_ZenkakuHankaku = 148 , HidKeyboardKey_LeftControl = 224 , HidKeyboardKey_LeftShift = 225 , HidKeyboardKey_LeftAlt = 226 , HidKeyboardKey_LeftGui = 227 , HidKeyboardKey_RightControl = 228 , HidKeyboardKey_RightShift = 229 , HidKeyboardKey_RightAlt = 230 , HidKeyboardKey_RightGui = 231 }
	HidKeyboardKey.

enum	HidKeyboardModifier { HidKeyboardModifier_Control = (1U<<( 0 )) , HidKeyboardModifier_Shift = (1U<<( 1 )) , HidKeyboardModifier_LeftAlt = (1U<<( 2 )) , HidKeyboardModifier_RightAlt = (1U<<( 3 )) , HidKeyboardModifier_Gui = (1U<<( 4 )) , HidKeyboardModifier_CapsLock = (1U<<( 8 )) , HidKeyboardModifier_ScrollLock = (1U<<( 9 )) , HidKeyboardModifier_NumLock = (1U<<( 10 )) , HidKeyboardModifier_Katakana = (1U<<( 11 )) , HidKeyboardModifier_Hiragana = (1U<<( 12 )) }
	HidKeyboardModifier.

enum	HidKeyboardLockKeyEvent { HidKeyboardLockKeyEvent_NumLockOn = (1U<<( 0 )) , HidKeyboardLockKeyEvent_NumLockOff = (1U<<( 1 )) , HidKeyboardLockKeyEvent_NumLockToggle = (1U<<( 2 )) , HidKeyboardLockKeyEvent_CapsLockOn = (1U<<( 3 )) , HidKeyboardLockKeyEvent_CapsLockOff = (1U<<( 4 )) , HidKeyboardLockKeyEvent_CapsLockToggle = (1U<<( 5 )) , HidKeyboardLockKeyEvent_ScrollLockOn = (1U<<( 6 )) , HidKeyboardLockKeyEvent_ScrollLockOff = (1U<<( 7 )) , HidKeyboardLockKeyEvent_ScrollLockToggle = (1U<<( 8 )) }
	KeyboardLockKeyEvent. More...

enum	HidNpadIdType { HidNpadIdType_No1 = 0 , HidNpadIdType_No2 = 1 , HidNpadIdType_No3 = 2 , HidNpadIdType_No4 = 3 , HidNpadIdType_No5 = 4 , HidNpadIdType_No6 = 5 , HidNpadIdType_No7 = 6 , HidNpadIdType_No8 = 7 , HidNpadIdType_Other = 0x10 , HidNpadIdType_Handheld = 0x20 }
	HID controller IDs. More...

enum	HidNpadStyleTag { HidNpadStyleTag_NpadFullKey = (1U<<( 0 )) , HidNpadStyleTag_NpadHandheld = (1U<<( 1 )) , HidNpadStyleTag_NpadJoyDual = (1U<<( 2 )) , HidNpadStyleTag_NpadJoyLeft = (1U<<( 3 )) , HidNpadStyleTag_NpadJoyRight = (1U<<( 4 )) , HidNpadStyleTag_NpadGc = (1U<<( 5 )) , HidNpadStyleTag_NpadPalma = (1U<<( 6 )) , HidNpadStyleTag_NpadLark = (1U<<( 7 )) , HidNpadStyleTag_NpadHandheldLark = (1U<<( 8 )) , HidNpadStyleTag_NpadLucia = (1U<<( 9 )) , HidNpadStyleTag_NpadLagon = (1U<<( 10 )) , HidNpadStyleTag_NpadLager = (1U<<( 11 )) , HidNpadStyleTag_NpadSystemExt = (1U<<( 29 )) , HidNpadStyleTag_NpadSystem = (1U<<( 30 )) , HidNpadStyleSet_NpadFullCtrl = HidNpadStyleTag_NpadFullKey \| HidNpadStyleTag_NpadHandheld \| HidNpadStyleTag_NpadJoyDual , HidNpadStyleSet_NpadStandard = HidNpadStyleSet_NpadFullCtrl \| HidNpadStyleTag_NpadJoyLeft \| HidNpadStyleTag_NpadJoyRight }
	HID controller styles. More...

enum	HidColorAttribute { HidColorAttribute_Ok = 0 , HidColorAttribute_ReadError = 1 , HidColorAttribute_NoController = 2 }
	HidColorAttribute. More...

enum	HidNpadButton { HidNpadButton_A = (1UL<<( 0 )) , HidNpadButton_B = (1UL<<( 1 )) , HidNpadButton_X = (1UL<<( 2 )) , HidNpadButton_Y = (1UL<<( 3 )) , HidNpadButton_StickL = (1UL<<( 4 )) , HidNpadButton_StickR = (1UL<<( 5 )) , HidNpadButton_L = (1UL<<( 6 )) , HidNpadButton_R = (1UL<<( 7 )) , HidNpadButton_ZL = (1UL<<( 8 )) , HidNpadButton_ZR = (1UL<<( 9 )) , HidNpadButton_Plus = (1UL<<( 10 )) , HidNpadButton_Minus = (1UL<<( 11 )) , HidNpadButton_Left = (1UL<<( 12 )) , HidNpadButton_Up = (1UL<<( 13 )) , HidNpadButton_Right = (1UL<<( 14 )) , HidNpadButton_Down = (1UL<<( 15 )) , HidNpadButton_StickLLeft = (1UL<<( 16 )) , HidNpadButton_StickLUp = (1UL<<( 17 )) , HidNpadButton_StickLRight = (1UL<<( 18 )) , HidNpadButton_StickLDown = (1UL<<( 19 )) , HidNpadButton_StickRLeft = (1UL<<( 20 )) , HidNpadButton_StickRUp = (1UL<<( 21 )) , HidNpadButton_StickRRight = (1UL<<( 22 )) , HidNpadButton_StickRDown = (1UL<<( 23 )) , HidNpadButton_LeftSL = (1UL<<( 24 )) , HidNpadButton_LeftSR = (1UL<<( 25 )) , HidNpadButton_RightSL = (1UL<<( 26 )) , HidNpadButton_RightSR = (1UL<<( 27 )) , HidNpadButton_Palma = (1UL<<( 28 )) , HidNpadButton_Verification = (1UL<<( 29 )) , HidNpadButton_HandheldLeftB = (1UL<<( 30 )) , HidNpadButton_LagonCLeft = (1UL<<( 31 )) , HidNpadButton_LagonCUp = (1UL<<( 32 )) , HidNpadButton_LagonCRight = (1UL<<( 33 )) , HidNpadButton_LagonCDown = (1UL<<( 34 )) , HidNpadButton_AnyLeft = HidNpadButton_Left \| HidNpadButton_StickLLeft \| HidNpadButton_StickRLeft , HidNpadButton_AnyUp = HidNpadButton_Up \| HidNpadButton_StickLUp \| HidNpadButton_StickRUp , HidNpadButton_AnyRight = HidNpadButton_Right \| HidNpadButton_StickLRight \| HidNpadButton_StickRRight , HidNpadButton_AnyDown = HidNpadButton_Down \| HidNpadButton_StickLDown \| HidNpadButton_StickRDown , HidNpadButton_AnySL = HidNpadButton_LeftSL \| HidNpadButton_RightSL , HidNpadButton_AnySR = HidNpadButton_LeftSR \| HidNpadButton_RightSR }
	HidNpadButton. More...

enum	HidDebugPadAttribute { HidDebugPadAttribute_IsConnected = (1U<<( 0 )) }
	HidDebugPadAttribute. More...

enum	HidTouchAttribute { HidTouchAttribute_Start = (1U<<( 0 )) , HidTouchAttribute_End = (1U<<( 1 )) }
	HidTouchAttribute. More...

enum	HidMouseAttribute { HidMouseAttribute_Transferable = (1U<<( 0 )) , HidMouseAttribute_IsConnected = (1U<<( 1 )) }
	HidMouseAttribute. More...

enum	HidNpadAttribute { HidNpadAttribute_IsConnected = (1U<<( 0 )) , HidNpadAttribute_IsWired = (1U<<( 1 )) , HidNpadAttribute_IsLeftConnected = (1U<<( 2 )) , HidNpadAttribute_IsLeftWired = (1U<<( 3 )) , HidNpadAttribute_IsRightConnected = (1U<<( 4 )) , HidNpadAttribute_IsRightWired = (1U<<( 5 )) }
	HidNpadAttribute. More...

enum	HidSixAxisSensorAttribute { HidSixAxisSensorAttribute_IsConnected = (1U<<( 0 )) , HidSixAxisSensorAttribute_IsInterpolated = (1U<<( 1 )) }
	HidSixAxisSensorAttribute. More...

enum	HidGestureAttribute { HidGestureAttribute_IsNewTouch = (1U<<( 4 )) , HidGestureAttribute_IsDoubleTap = (1U<<( 8 )) }
	HidGestureAttribute. More...

enum	HidGestureDirection { HidGestureDirection_None = 0 , HidGestureDirection_Left = 1 , HidGestureDirection_Up = 2 , HidGestureDirection_Right = 3 , HidGestureDirection_Down = 4 }
	HidGestureDirection. More...

enum	HidGestureType { HidGestureType_Idle = 0 , HidGestureType_Complete = 1 , HidGestureType_Cancel = 2 , HidGestureType_Touch = 3 , HidGestureType_Press = 4 , HidGestureType_Tap = 5 , HidGestureType_Pan = 6 , HidGestureType_Swipe = 7 , HidGestureType_Pinch = 8 , HidGestureType_Rotate = 9 }
	HidGestureType. More...

enum	HidGyroscopeZeroDriftMode { HidGyroscopeZeroDriftMode_Loose = 0 , HidGyroscopeZeroDriftMode_Standard = 1 , HidGyroscopeZeroDriftMode_Tight = 2 }
	GyroscopeZeroDriftMode. More...

enum	HidNpadJoyHoldType { HidNpadJoyHoldType_Vertical = 0 , HidNpadJoyHoldType_Horizontal = 1 }
	NpadJoyHoldType. More...

enum	HidNpadJoyDeviceType { HidNpadJoyDeviceType_Left = 0 , HidNpadJoyDeviceType_Right = 1 }
	NpadJoyDeviceType. More...

enum	HidNpadHandheldActivationMode { HidNpadHandheldActivationMode_Dual = 0 , HidNpadHandheldActivationMode_Single = 1 , HidNpadHandheldActivationMode_None = 2 }
	This controls how many Joy-Cons must be attached for handheld-mode to be activated. More...

enum	HidNpadJoyAssignmentMode { HidNpadJoyAssignmentMode_Dual = 0 , HidNpadJoyAssignmentMode_Single = 1 }
	NpadJoyAssignmentMode. More...

enum	HidNpadCommunicationMode { HidNpadCommunicationMode_5ms = 0 , HidNpadCommunicationMode_10ms = 1 , HidNpadCommunicationMode_15ms = 2 , HidNpadCommunicationMode_Default = 3 }
	NpadCommunicationMode. More...

enum	HidDeviceTypeBits { HidDeviceTypeBits_FullKey = (1U<<( 0 )) , HidDeviceTypeBits_DebugPad = (1U<<( 1 )) , HidDeviceTypeBits_HandheldLeft = (1U<<( 2 )) , HidDeviceTypeBits_HandheldRight = (1U<<( 3 )) , HidDeviceTypeBits_JoyLeft = (1U<<( 4 )) , HidDeviceTypeBits_JoyRight = (1U<<( 5 )) , HidDeviceTypeBits_Palma = (1U<<( 6 )) , HidDeviceTypeBits_LarkHvcLeft = (1U<<( 7 )) , HidDeviceTypeBits_LarkHvcRight = (1U<<( 8 )) , HidDeviceTypeBits_LarkNesLeft = (1U<<( 9 )) , HidDeviceTypeBits_LarkNesRight = (1U<<( 10 )) , HidDeviceTypeBits_HandheldLarkHvcLeft = (1U<<( 11 )) , HidDeviceTypeBits_HandheldLarkHvcRight = (1U<<( 12 )) , HidDeviceTypeBits_HandheldLarkNesLeft = (1U<<( 13 )) , HidDeviceTypeBits_HandheldLarkNesRight = (1U<<( 14 )) , HidDeviceTypeBits_Lucia = (1U<<( 15 )) , HidDeviceTypeBits_Lagon = (1U<<( 16 )) , HidDeviceTypeBits_Lager = (1U<<( 17 )) , HidDeviceTypeBits_System = (1U<<( 31 )) }
	DeviceType (system) More...

enum	HidDeviceType { HidDeviceType_JoyRight1 = 1 , HidDeviceType_JoyLeft2 = 2 , HidDeviceType_FullKey3 = 3 , HidDeviceType_JoyLeft4 = 4 , HidDeviceType_JoyRight5 = 5 , HidDeviceType_FullKey6 = 6 , HidDeviceType_LarkHvcLeft = 7 , HidDeviceType_LarkHvcRight = 8 , HidDeviceType_LarkNesLeft = 9 , HidDeviceType_LarkNesRight = 10 , HidDeviceType_Lucia = 11 , HidDeviceType_Palma = 12 , HidDeviceType_FullKey13 = 13 , HidDeviceType_FullKey15 = 15 , HidDeviceType_DebugPad = 17 , HidDeviceType_System19 = 19 , HidDeviceType_System20 = 20 , HidDeviceType_System21 = 21 , HidDeviceType_Lagon = 22 , HidDeviceType_Lager = 28 }
	Internal DeviceType for [9.0.0+]. Converted to/from the pre-9.0.0 version of this by the hiddbg funcs. More...

enum	HidAppletFooterUiType { HidAppletFooterUiType_None = 0 , HidAppletFooterUiType_HandheldNone = 1 , HidAppletFooterUiType_HandheldJoyConLeftOnly = 2 , HidAppletFooterUiType_HandheldJoyConRightOnly = 3 , HidAppletFooterUiType_HandheldJoyConLeftJoyConRight = 4 , HidAppletFooterUiType_JoyDual = 5 , HidAppletFooterUiType_JoyDualLeftOnly = 6 , HidAppletFooterUiType_JoyDualRightOnly = 7 , HidAppletFooterUiType_JoyLeftHorizontal = 8 , HidAppletFooterUiType_JoyLeftVertical = 9 , HidAppletFooterUiType_JoyRightHorizontal = 10 , HidAppletFooterUiType_JoyRightVertical = 11 , HidAppletFooterUiType_SwitchProController = 12 , HidAppletFooterUiType_CompatibleProController = 13 , HidAppletFooterUiType_CompatibleJoyCon = 14 , HidAppletFooterUiType_LarkHvc1 = 15 , HidAppletFooterUiType_LarkHvc2 = 16 , HidAppletFooterUiType_LarkNesLeft = 17 , HidAppletFooterUiType_LarkNesRight = 18 , HidAppletFooterUiType_Lucia = 19 , HidAppletFooterUiType_Verification = 20 , HidAppletFooterUiType_Lagon = 21 }
	AppletFooterUiType (system) More...

enum	HidNpadInterfaceType { HidNpadInterfaceType_Bluetooth = 1 , HidNpadInterfaceType_Rail = 2 , HidNpadInterfaceType_USB = 3 , HidNpadInterfaceType_Unknown4 = 4 }
	NpadInterfaceType (system) More...

enum	XcdInterfaceType { XcdInterfaceType_Bluetooth = (1U<<( 0 )) , XcdInterfaceType_Uart = (1U<<( 1 )) , XcdInterfaceType_Usb = (1U<<( 2 )) , XcdInterfaceType_FieldSet = (1U<<( 7 )) }
	XcdInterfaceType.

enum	HidNpadLarkType { HidNpadLarkType_Invalid = 0 , HidNpadLarkType_H1 = 1 , HidNpadLarkType_H2 = 2 , HidNpadLarkType_NL = 3 , HidNpadLarkType_NR = 4 }
	NpadLarkType. More...

enum	HidNpadLuciaType { HidNpadLuciaType_Invalid = 0 , HidNpadLuciaType_J = 1 , HidNpadLuciaType_E = 2 , HidNpadLuciaType_U = 3 }
	NpadLuciaType. More...

enum	HidNpadLagerType { HidNpadLagerType_Invalid = 0 , HidNpadLagerType_J = 1 , HidNpadLagerType_E = 2 , HidNpadLagerType_U = 3 }
	NpadLagerType. More...

enum	HidVibrationDeviceType { HidVibrationDeviceType_Unknown = 0 , HidVibrationDeviceType_LinearResonantActuator = 1 , HidVibrationDeviceType_GcErm = 2 }
	Type values for HidVibrationDeviceInfo::type. More...

enum	HidVibrationDevicePosition { HidVibrationDevicePosition_None = 0 , HidVibrationDevicePosition_Left = 1 , HidVibrationDevicePosition_Right = 2 }
	VibrationDevicePosition. More...

enum	HidVibrationGcErmCommand { HidVibrationGcErmCommand_Stop = 0 , HidVibrationGcErmCommand_Start = 1 , HidVibrationGcErmCommand_StopHard = 2 }
	VibrationGcErmCommand. More...

enum	HidPalmaOperationType { HidPalmaOperationType_PlayActivity = 0 , HidPalmaOperationType_SetFrModeType = 1 , HidPalmaOperationType_ReadStep = 2 , HidPalmaOperationType_EnableStep = 3 , HidPalmaOperationType_ResetStep = 4 , HidPalmaOperationType_ReadApplicationSection = 5 , HidPalmaOperationType_WriteApplicationSection = 6 , HidPalmaOperationType_ReadUniqueCode = 7 , HidPalmaOperationType_SetUniqueCodeInvalid = 8 , HidPalmaOperationType_WriteActivityEntry = 9 , HidPalmaOperationType_WriteRgbLedPatternEntry = 10 , HidPalmaOperationType_WriteWaveEntry = 11 , HidPalmaOperationType_ReadDataBaseIdentificationVersion = 12 , HidPalmaOperationType_WriteDataBaseIdentificationVersion = 13 , HidPalmaOperationType_SuspendFeature = 14 , HidPalmaOperationType_ReadPlayLog = 15 , HidPalmaOperationType_ResetPlayLog = 16 }
	PalmaOperationType. More...

enum	HidPalmaFrModeType { HidPalmaFrModeType_Off = 0 , HidPalmaFrModeType_B01 = 1 , HidPalmaFrModeType_B02 = 2 , HidPalmaFrModeType_B03 = 3 , HidPalmaFrModeType_Downloaded = 4 }
	PalmaFrModeType. More...

enum	HidPalmaWaveSet { HidPalmaWaveSet_Small = 0 , HidPalmaWaveSet_Medium = 1 , HidPalmaWaveSet_Large = 2 }
	PalmaWaveSet. More...

enum	HidPalmaFeature { HidPalmaFeature_FrMode = (1U<<( 0 )) , HidPalmaFeature_RumbleFeedback = (1U<<( 1 )) , HidPalmaFeature_Step = (1U<<( 2 )) , HidPalmaFeature_MuteSwitch = (1U<<( 3 )) }
	PalmaFeature. More...

Functions
Result	hidInitialize (void)
	Initialize hid. Called automatically during app startup.

void	hidExit (void)
	Exit hid. Called automatically during app exit.

Service *	hidGetServiceSession (void)
	Gets the Service object for the actual hid service session.

void *	hidGetSharedmemAddr (void)
	Gets the address of the SharedMemory.

Result	hidSendKeyboardLockKeyEvent (u32 events)
	SendKeyboardLockKeyEvent. More...

Result	hidGetSixAxisSensorHandles (HidSixAxisSensorHandle *handles, s32 total_handles, HidNpadIdType id, HidNpadStyleTag style)
	Gets SixAxisSensorHandles. More...

Result	hidStartSixAxisSensor (HidSixAxisSensorHandle handle)
	Starts the SixAxisSensor for the specified handle. More...

Result	hidStopSixAxisSensor (HidSixAxisSensorHandle handle)
	Stops the SixAxisSensor for the specified handle. More...

Result	hidIsSixAxisSensorFusionEnabled (HidSixAxisSensorHandle handle, bool *out)
	IsSixAxisSensorFusionEnabled. More...

Result	hidEnableSixAxisSensorFusion (HidSixAxisSensorHandle handle, bool flag)
	EnableSixAxisSensorFusion. More...

Result	hidSetSixAxisSensorFusionParameters (HidSixAxisSensorHandle handle, float unk0, float unk1)
	SetSixAxisSensorFusionParameters. More...

Result	hidGetSixAxisSensorFusionParameters (HidSixAxisSensorHandle handle, float unk0, float unk1)
	GetSixAxisSensorFusionParameters. More...

Result	hidResetSixAxisSensorFusionParameters (HidSixAxisSensorHandle handle)
	ResetSixAxisSensorFusionParameters. More...

Result	hidSetGyroscopeZeroDriftMode (HidSixAxisSensorHandle handle, HidGyroscopeZeroDriftMode mode)
	Sets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle. More...

Result	hidGetGyroscopeZeroDriftMode (HidSixAxisSensorHandle handle, HidGyroscopeZeroDriftMode *mode)
	Gets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle. More...

Result	hidResetGyroscopeZeroDriftMode (HidSixAxisSensorHandle handle)
	Resets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle to HidGyroscopeZeroDriftMode_Standard. More...

Result	hidIsSixAxisSensorAtRest (HidSixAxisSensorHandle handle, bool *out)
	IsSixAxisSensorAtRest. More...

Result	hidIsFirmwareUpdateAvailableForSixAxisSensor (HidSixAxisSensorHandle handle, bool *out)
	IsFirmwareUpdateAvailableForSixAxisSensor. More...

Result	hidSetSupportedNpadStyleSet (u32 style_set)
	Sets which controller styles are supported. More...

Result	hidGetSupportedNpadStyleSet (u32 *style_set)
	Gets which controller styles are supported. More...

Result	hidSetSupportedNpadIdType (const HidNpadIdType *ids, size_t count)
	Sets which HidNpadIdType are supported. More...

Result	hidAcquireNpadStyleSetUpdateEventHandle (HidNpadIdType id, Event *out_event, bool autoclear)
	Gets an Event which is signaled when the hidGetNpadStyleSet output is updated for the specified controller. More...

Result	hidDisconnectNpad (HidNpadIdType id)
	DisconnectNpad. More...

Result	hidGetPlayerLedPattern (HidNpadIdType id, u8 *out)
	GetPlayerLedPattern. More...

Result	hidSetNpadJoyHoldType (HidNpadJoyHoldType type)
	Sets the HidNpadJoyHoldType. More...

Result	hidGetNpadJoyHoldType (HidNpadJoyHoldType *type)
	Gets the HidNpadJoyHoldType. More...

Result	hidSetNpadJoyAssignmentModeSingleByDefault (HidNpadIdType id)
	This is the same as hidSetNpadJoyAssignmentModeSingle, except HidNpadJoyDeviceType_Left is used for the type. More...

Result	hidSetNpadJoyAssignmentModeSingle (HidNpadIdType id, HidNpadJoyDeviceType type)
	This is the same as hidSetNpadJoyAssignmentModeSingleWithDestination, except without the output params. More...

Result	hidSetNpadJoyAssignmentModeDual (HidNpadIdType id)
	Use this if you want to use a pair of joy-cons as a single HidNpadIdType_No*. More...

Result	hidMergeSingleJoyAsDualJoy (HidNpadIdType id0, HidNpadIdType id1)
	Merge two single joy-cons into a dual-mode controller. More...

Result	hidStartLrAssignmentMode (void)
	StartLrAssignmentMode.

Result	hidStopLrAssignmentMode (void)
	StopLrAssignmentMode.

Result	hidSetNpadHandheldActivationMode (HidNpadHandheldActivationMode mode)
	Sets the HidNpadHandheldActivationMode. More...

Result	hidGetNpadHandheldActivationMode (HidNpadHandheldActivationMode *out)
	Gets the HidNpadHandheldActivationMode. More...

Result	hidSwapNpadAssignment (HidNpadIdType id0, HidNpadIdType id1)
	SwapNpadAssignment. More...

Result	hidEnableUnintendedHomeButtonInputProtection (HidNpadIdType id, bool flag)
	EnableUnintendedHomeButtonInputProtection. More...

Result	hidSetNpadJoyAssignmentModeSingleWithDestination (HidNpadIdType id, HidNpadJoyDeviceType type, bool flag, HidNpadIdType dest)
	Use this if you want to use a single joy-con as a dedicated HidNpadIdType_No*. More...

Result	hidSetNpadAnalogStickUseCenterClamp (bool flag)
	SetNpadAnalogStickUseCenterClamp. More...

Result	hidSetNpadCaptureButtonAssignment (HidNpadStyleTag style, u64 buttons)
	Assigns the button(s) which trigger the CaptureButton. More...

Result	hidClearNpadCaptureButtonAssignment (void)
	ClearNpadCaptureButtonAssignment. More...

Result	hidInitializeVibrationDevices (HidVibrationDeviceHandle *handles, s32 total_handles, HidNpadIdType id, HidNpadStyleTag style)
	Gets and initializes vibration handles. More...

Result	hidGetVibrationDeviceInfo (HidVibrationDeviceHandle handle, HidVibrationDeviceInfo *out)
	Gets HidVibrationDeviceInfo for the specified device. More...

Result	hidSendVibrationValue (HidVibrationDeviceHandle handle, const HidVibrationValue *value)
	Sends the HidVibrationDeviceHandle to the specified device. More...

Result	hidGetActualVibrationValue (HidVibrationDeviceHandle handle, HidVibrationValue *out)
	Gets the current HidVibrationValue for the specified device. More...

Result	hidPermitVibration (bool flag)
	Sets whether vibration is allowed, this also affects the config displayed by System Settings. More...

Result	hidIsVibrationPermitted (bool *flag)
	Gets whether vibration is allowed. More...

Result	hidSendVibrationValues (const HidVibrationDeviceHandle handles, const HidVibrationValue values, s32 count)
	Send vibration values[index] to handles[index]. More...

Result	hidSendVibrationGcErmCommand (HidVibrationDeviceHandle handle, HidVibrationGcErmCommand cmd)
	Send HidVibrationGcErmCommand to the specified device, for HidVibrationDeviceType_GcErm. More...

Result	hidGetActualVibrationGcErmCommand (HidVibrationDeviceHandle handle, HidVibrationGcErmCommand *out)
	Get HidVibrationGcErmCommand for the specified device, for HidVibrationDeviceType_GcErm. More...

Result	hidBeginPermitVibrationSession (void)
	Begins a forced-permitted vibration session. More...

Result	hidEndPermitVibrationSession (void)
	Ends the session started by hidBeginPermitVibrationSession. More...

Result	hidIsVibrationDeviceMounted (HidVibrationDeviceHandle handle, bool *flag)
	Gets whether vibration is available with the specified device. More...

Result	hidStartSevenSixAxisSensor (void)
	Starts the SevenSixAxisSensor. More...

Result	hidStopSevenSixAxisSensor (void)
	Stops the SevenSixAxisSensor. More...

Result	hidInitializeSevenSixAxisSensor (void)
	Initializes the SevenSixAxisSensor. More...

Result	hidFinalizeSevenSixAxisSensor (void)
	Finalizes the SevenSixAxisSensor. More...

Result	hidSetSevenSixAxisSensorFusionStrength (float strength)
	Sets the SevenSixAxisSensor FusionStrength. More...

Result	hidGetSevenSixAxisSensorFusionStrength (float *strength)
	Gets the SevenSixAxisSensor FusionStrength. More...

Result	hidResetSevenSixAxisSensorTimestamp (void)
	Resets the timestamp for the SevenSixAxisSensor. More...

Result	hidGetSevenSixAxisSensorStates (HidSevenSixAxisSensorState states, size_t count, size_t total_out)
	GetSevenSixAxisSensorStates. More...

Result	hidIsSevenSixAxisSensorAtRest (bool *out)
	IsSevenSixAxisSensorAtRest. More...

Result	hidGetSensorFusionError (float *out)
	GetSensorFusionError. More...

Result	hidGetGyroBias (UtilFloat3 *out)
	GetGyroBias. More...

Result	hidIsUsbFullKeyControllerEnabled (bool *out)
	IsUsbFullKeyControllerEnabled. More...

Result	hidEnableUsbFullKeyController (bool flag)
	EnableUsbFullKeyController. More...

Result	hidIsUsbFullKeyControllerConnected (HidNpadIdType id, bool *out)
	IsUsbFullKeyControllerConnected. More...

Result	hidGetNpadInterfaceType (HidNpadIdType id, u8 *out)
	Gets the HidNpadInterfaceType for the specified controller. More...

Result	hidGetNpadOfHighestBatteryLevel (const HidNpadIdType ids, size_t count, HidNpadIdType out)
	GetNpadOfHighestBatteryLevel. More...

Result	hidSetNpadCommunicationMode (HidNpadCommunicationMode mode)
	SetNpadCommunicationMode. More...

Result	hidGetNpadCommunicationMode (HidNpadCommunicationMode *out)
	GetNpadCommunicationMode. More...

Result	hidSetTouchScreenConfiguration (const HidTouchScreenConfigurationForNx *config)
	SetTouchScreenConfiguration. More...

Result	hidIsFirmwareUpdateNeededForNotification (bool *out)
	IsFirmwareUpdateNeededForNotification. More...

TouchScreen
void	hidInitializeTouchScreen (void)
	Initialize TouchScreen. Must be called when TouchScreen is being used. Used automatically by hidScanInput when required.

size_t	hidGetTouchScreenStates (HidTouchScreenState *states, size_t count)
	Gets HidTouchScreenState. More...

Mouse
void	hidInitializeMouse (void)
	Initialize Mouse. Must be called when Mouse is being used. Used automatically by hidScanInput when required.

size_t	hidGetMouseStates (HidMouseState *states, size_t count)
	Gets HidMouseState. More...

Keyboard
void	hidInitializeKeyboard (void)
	Initialize Keyboard. Must be called when Keyboard is being used. Used automatically by hidScanInput when required.

size_t	hidGetKeyboardStates (HidKeyboardState *states, size_t count)
	Gets HidKeyboardState. More...

static bool	hidKeyboardStateGetKey (const HidKeyboardState *state, HidKeyboardKey key)
	Gets the state of a key in a HidKeyboardState. More...

Npad
void	hidInitializeNpad (void)
	Initialize Npad. Must be called when Npad is being used. Used automatically by hidScanInput when required.

u32	hidGetNpadStyleSet (HidNpadIdType id)
	Gets the StyleSet for the specified Npad. More...

HidNpadJoyAssignmentMode	hidGetNpadJoyAssignment (HidNpadIdType id)
	Gets the HidNpadJoyAssignmentMode for the specified Npad. More...

Result	hidGetNpadControllerColorSingle (HidNpadIdType id, HidNpadControllerColor *color)
	Gets the main HidNpadControllerColor for the specified Npad. More...

Result	hidGetNpadControllerColorSplit (HidNpadIdType id, HidNpadControllerColor color_left, HidNpadControllerColor color_right)
	Gets the left/right HidNpadControllerColor for the specified Npad (Joy-Con pair in dual mode). More...

u32	hidGetNpadDeviceType (HidNpadIdType id)
	Gets the DeviceType for the specified Npad. More...

void	hidGetNpadSystemProperties (HidNpadIdType id, HidNpadSystemProperties *out)
	Gets the HidNpadSystemProperties for the specified Npad. More...

void	hidGetNpadSystemButtonProperties (HidNpadIdType id, HidNpadSystemButtonProperties *out)
	Gets the HidNpadSystemButtonProperties for the specified Npad. More...

void	hidGetNpadPowerInfoSingle (HidNpadIdType id, HidPowerInfo *info)
	Gets the main HidPowerInfo for the specified Npad. More...

void	hidGetNpadPowerInfoSplit (HidNpadIdType id, HidPowerInfo info_left, HidPowerInfo info_right)
	Gets the left/right HidPowerInfo for the specified Npad (Joy-Con pair in dual mode). More...

u32	hidGetAppletFooterUiAttributesSet (HidNpadIdType id)
	Gets the AppletFooterUiAttributesSet for the specified Npad. More...

HidAppletFooterUiType	hidGetAppletFooterUiTypes (HidNpadIdType id)
	Gets HidAppletFooterUiType for the specified Npad. More...

HidNpadLagerType	hidGetNpadLagerType (HidNpadIdType id)
	Gets HidNpadLagerType for the specified Npad. More...

size_t	hidGetNpadStatesFullKey (HidNpadIdType id, HidNpadFullKeyState *states, size_t count)
	Gets HidNpadFullKeyState. More...

size_t	hidGetNpadStatesHandheld (HidNpadIdType id, HidNpadHandheldState *states, size_t count)
	Gets HidNpadHandheldState. More...

size_t	hidGetNpadStatesJoyDual (HidNpadIdType id, HidNpadJoyDualState *states, size_t count)
	Gets HidNpadJoyDualState. More...

size_t	hidGetNpadStatesJoyLeft (HidNpadIdType id, HidNpadJoyLeftState *states, size_t count)
	Gets HidNpadJoyLeftState. More...

size_t	hidGetNpadStatesJoyRight (HidNpadIdType id, HidNpadJoyRightState *states, size_t count)
	Gets HidNpadJoyRightState. More...

size_t	hidGetNpadStatesGc (HidNpadIdType id, HidNpadGcState *states, size_t count)
	Gets HidNpadGcState. More...

size_t	hidGetNpadStatesPalma (HidNpadIdType id, HidNpadPalmaState *states, size_t count)
	Gets HidNpadPalmaState. More...

size_t	hidGetNpadStatesLark (HidNpadIdType id, HidNpadLarkState *states, size_t count)
	Gets HidNpadLarkState. More...

size_t	hidGetNpadStatesHandheldLark (HidNpadIdType id, HidNpadHandheldLarkState *states, size_t count)
	Gets HidNpadHandheldLarkState. More...

size_t	hidGetNpadStatesLucia (HidNpadIdType id, HidNpadLuciaState *states, size_t count)
	Gets HidNpadLuciaState. More...

size_t	hidGetNpadStatesLager (HidNpadIdType id, HidNpadLagerState *states, size_t count)
	Gets HidNpadLagerState. More...

size_t	hidGetNpadStatesSystemExt (HidNpadIdType id, HidNpadSystemExtState *states, size_t count)
	Gets HidNpadSystemExtState. More...

size_t	hidGetNpadStatesSystem (HidNpadIdType id, HidNpadSystemState *states, size_t count)
	Gets HidNpadSystemState. More...

size_t	hidGetSixAxisSensorStates (HidSixAxisSensorHandle handle, HidSixAxisSensorState *states, size_t count)
	Gets HidSixAxisSensorState for the specified handle. More...

Gesture
void	hidInitializeGesture (void)
	Initialize Gesture. Must be called when Gesture is being used.

size_t	hidGetGestureStates (HidGestureState *states, size_t count)
	Gets HidGestureState. More...

Palma, see ::HidNpadStyleTag_NpadPalma.
Result	hidGetPalmaConnectionHandle (HidNpadIdType id, HidPalmaConnectionHandle *out)
	GetPalmaConnectionHandle. More...

Result	hidInitializePalma (HidPalmaConnectionHandle handle)
	InitializePalma. More...

Result	hidAcquirePalmaOperationCompleteEvent (HidPalmaConnectionHandle handle, Event *out_event, bool autoclear)
	Gets an Event which is signaled when data is available with hidGetPalmaOperationInfo. More...

Result	hidGetPalmaOperationInfo (HidPalmaConnectionHandle handle, HidPalmaOperationInfo *out)
	Gets HidPalmaOperationInfo for a completed operation. More...

Result	hidPlayPalmaActivity (HidPalmaConnectionHandle handle, u16 val)
	PlayPalmaActivity. More...

Result	hidSetPalmaFrModeType (HidPalmaConnectionHandle handle, HidPalmaFrModeType type)
	SetPalmaFrModeType. More...

Result	hidReadPalmaStep (HidPalmaConnectionHandle handle)
	ReadPalmaStep. More...

Result	hidEnablePalmaStep (HidPalmaConnectionHandle handle, bool flag)
	EnablePalmaStep. More...

Result	hidResetPalmaStep (HidPalmaConnectionHandle handle)
	ResetPalmaStep. More...

Result	hidReadPalmaApplicationSection (HidPalmaConnectionHandle handle, s32 inval0, u64 size)
	ReadPalmaApplicationSection. More...

Result	hidWritePalmaApplicationSection (HidPalmaConnectionHandle handle, s32 inval0, u64 size, const HidPalmaApplicationSectionAccessBuffer *buf)
	WritePalmaApplicationSection. More...

Result	hidReadPalmaUniqueCode (HidPalmaConnectionHandle handle)
	ReadPalmaUniqueCode. More...

Result	hidSetPalmaUniqueCodeInvalid (HidPalmaConnectionHandle handle)
	SetPalmaUniqueCodeInvalid. More...

Result	hidWritePalmaActivityEntry (HidPalmaConnectionHandle handle, u16 unk, const HidPalmaActivityEntry *entry)
	WritePalmaActivityEntry. More...

Result	hidWritePalmaRgbLedPatternEntry (HidPalmaConnectionHandle handle, u16 unk, const void *buffer, size_t size)
	WritePalmaRgbLedPatternEntry. More...

Result	hidWritePalmaWaveEntry (HidPalmaConnectionHandle handle, HidPalmaWaveSet wave_set, u16 unk, const void *buffer, size_t tmem_size, size_t size)
	WritePalmaWaveEntry. More...

Result	hidSetPalmaDataBaseIdentificationVersion (HidPalmaConnectionHandle handle, s32 version)
	SetPalmaDataBaseIdentificationVersion. More...

Result	hidGetPalmaDataBaseIdentificationVersion (HidPalmaConnectionHandle handle)
	GetPalmaDataBaseIdentificationVersion. More...

Result	hidSuspendPalmaFeature (HidPalmaConnectionHandle handle, u32 features)
	SuspendPalmaFeature. More...

Result	hidReadPalmaPlayLog (HidPalmaConnectionHandle handle, u16 unk)
	ReadPalmaPlayLog. More...

Result	hidResetPalmaPlayLog (HidPalmaConnectionHandle handle, u16 unk)
	ResetPalmaPlayLog. More...

Result	hidSetIsPalmaAllConnectable (bool flag)
	Sets whether any Palma can connect. More...

Result	hidSetIsPalmaPairedConnectable (bool flag)
	Sets whether paired Palma can connect. More...

Result	hidPairPalma (HidPalmaConnectionHandle handle)
	PairPalma. More...

Result	hidCancelWritePalmaWaveEntry (HidPalmaConnectionHandle handle)
	CancelWritePalmaWaveEntry. More...

Result	hidEnablePalmaBoostMode (bool flag)
	EnablePalmaBoostMode. More...

Result	hidGetPalmaBluetoothAddress (HidPalmaConnectionHandle handle, BtdrvAddress *out)
	GetPalmaBluetoothAddress. More...

Result	hidSetDisallowedPalmaConnection (const BtdrvAddress *addrs, s32 count)
	SetDisallowedPalmaConnection. More...

Detailed Description

Human input device (hid) service IPC wrapper.

Author: shinyquagsire23; yellows8

Copyright: libnx Authors

Enumeration Type Documentation

◆ HidAppletFooterUiType

enum HidAppletFooterUiType

AppletFooterUiType (system)

Enumerator
HidAppletFooterUiType_None	None.
HidAppletFooterUiType_HandheldNone	HandheldNone.
HidAppletFooterUiType_HandheldJoyConLeftOnly	HandheldJoyConLeftOnly.
HidAppletFooterUiType_HandheldJoyConRightOnly	HandheldJoyConRightOnly.
HidAppletFooterUiType_HandheldJoyConLeftJoyConRight	HandheldJoyConLeftJoyConRight.
HidAppletFooterUiType_JoyDual	JoyDual.
HidAppletFooterUiType_JoyDualLeftOnly	JoyDualLeftOnly.
HidAppletFooterUiType_JoyDualRightOnly	JoyDualRightOnly.
HidAppletFooterUiType_JoyLeftHorizontal	JoyLeftHorizontal.
HidAppletFooterUiType_JoyLeftVertical	JoyLeftVertical.
HidAppletFooterUiType_JoyRightHorizontal	JoyRightHorizontal.
HidAppletFooterUiType_JoyRightVertical	JoyRightVertical.
HidAppletFooterUiType_SwitchProController	SwitchProController.
HidAppletFooterUiType_CompatibleProController	CompatibleProController.
HidAppletFooterUiType_CompatibleJoyCon	CompatibleJoyCon.
HidAppletFooterUiType_LarkHvc1	LarkHvc1.
HidAppletFooterUiType_LarkHvc2	LarkHvc2.
HidAppletFooterUiType_LarkNesLeft	LarkNesLeft.
HidAppletFooterUiType_LarkNesRight	LarkNesRight.
HidAppletFooterUiType_Lucia	Lucia.
HidAppletFooterUiType_Verification	Verification.
HidAppletFooterUiType_Lagon	[13.0.0+] Lagon

◆ HidColorAttribute

enum HidColorAttribute

HidColorAttribute.

Enumerator
HidColorAttribute_Ok	Ok.
HidColorAttribute_ReadError	ReadError.
HidColorAttribute_NoController	NoController.

◆ HidDebugPadAttribute

enum HidDebugPadAttribute

HidDebugPadAttribute.

Enumerator
HidDebugPadAttribute_IsConnected	IsConnected.

◆ HidDebugPadButton

enum HidDebugPadButton

HidDebugPadButton.

Enumerator
HidDebugPadButton_A	A button.
HidDebugPadButton_B	B button.
HidDebugPadButton_X	X button.
HidDebugPadButton_Y	Y button.
HidDebugPadButton_L	L button.
HidDebugPadButton_R	R button.
HidDebugPadButton_ZL	ZL button.
HidDebugPadButton_ZR	ZR button.
HidDebugPadButton_Start	Start button.
HidDebugPadButton_Select	Select button.
HidDebugPadButton_Left	D-Pad Left button.
HidDebugPadButton_Up	D-Pad Up button.
HidDebugPadButton_Right	D-Pad Right button.
HidDebugPadButton_Down	D-Pad Down button.

◆ HidDeviceType

enum HidDeviceType

Internal DeviceType for [9.0.0+]. Converted to/from the pre-9.0.0 version of this by the hiddbg funcs.

Enumerator
HidDeviceType_JoyRight1	HidDeviceTypeBits_JoyRight
HidDeviceType_JoyLeft2	HidDeviceTypeBits_JoyLeft
HidDeviceType_FullKey3	HidDeviceTypeBits_FullKey
HidDeviceType_JoyLeft4	HidDeviceTypeBits_JoyLeft
HidDeviceType_JoyRight5	HidDeviceTypeBits_JoyRight
HidDeviceType_FullKey6	HidDeviceTypeBits_FullKey
HidDeviceType_LarkHvcLeft	HidDeviceTypeBits_LarkHvcLeft, HidDeviceTypeBits_HandheldLarkHvcLeft
HidDeviceType_LarkHvcRight	HidDeviceTypeBits_LarkHvcRight, HidDeviceTypeBits_HandheldLarkHvcRight
HidDeviceType_LarkNesLeft	HidDeviceTypeBits_LarkNesLeft, HidDeviceTypeBits_HandheldLarkNesLeft
HidDeviceType_LarkNesRight	HidDeviceTypeBits_LarkNesRight, HidDeviceTypeBits_HandheldLarkNesRight
HidDeviceType_Lucia	HidDeviceTypeBits_Lucia
HidDeviceType_Palma	[9.0.0+] HidDeviceTypeBits_Palma
HidDeviceType_FullKey13	HidDeviceTypeBits_FullKey
HidDeviceType_FullKey15	HidDeviceTypeBits_FullKey
HidDeviceType_DebugPad	HidDeviceTypeBits_DebugPad
HidDeviceType_System19	HidDeviceTypeBits_System with HidNpadStyleTag \|= HidNpadStyleTag_NpadFullKey.
HidDeviceType_System20	HidDeviceTypeBits_System with HidNpadStyleTag \|= HidNpadStyleTag_NpadJoyDual.
HidDeviceType_System21	HidDeviceTypeBits_System with HidNpadStyleTag \|= HidNpadStyleTag_NpadJoyDual.
HidDeviceType_Lagon	HidDeviceTypeBits_Lagon
HidDeviceType_Lager	HidDeviceTypeBits_Lager

◆ HidDeviceTypeBits

enum HidDeviceTypeBits

DeviceType (system)

Enumerator
HidDeviceTypeBits_FullKey	Pro Controller and Gc controller.
HidDeviceTypeBits_DebugPad	DebugPad.
HidDeviceTypeBits_HandheldLeft	Joy-Con/Famicom/NES left controller in handheld mode.
HidDeviceTypeBits_HandheldRight	Joy-Con/Famicom/NES right controller in handheld mode.
HidDeviceTypeBits_JoyLeft	Joy-Con left controller.
HidDeviceTypeBits_JoyRight	Joy-Con right controller.
HidDeviceTypeBits_Palma	Poké Ball Plus controller.
HidDeviceTypeBits_LarkHvcLeft	Famicom left controller.
HidDeviceTypeBits_LarkHvcRight	Famicom right controller (with microphone).
HidDeviceTypeBits_LarkNesLeft	NES left controller.
HidDeviceTypeBits_LarkNesRight	NES right controller.
HidDeviceTypeBits_HandheldLarkHvcLeft	Famicom left controller in handheld mode.
HidDeviceTypeBits_HandheldLarkHvcRight	Famicom right controller (with microphone) in handheld mode.
HidDeviceTypeBits_HandheldLarkNesLeft	NES left controller in handheld mode.
HidDeviceTypeBits_HandheldLarkNesRight	NES right controller in handheld mode.
HidDeviceTypeBits_Lucia	SNES controller.
HidDeviceTypeBits_Lagon	N64 controller.
HidDeviceTypeBits_Lager	Sega Genesis controller.
HidDeviceTypeBits_System	Generic controller.

◆ HidGestureAttribute

enum HidGestureAttribute

HidGestureAttribute.

Enumerator
HidGestureAttribute_IsNewTouch	IsNewTouch.
HidGestureAttribute_IsDoubleTap	IsDoubleTap.

◆ HidGestureDirection

enum HidGestureDirection

HidGestureDirection.

Enumerator
HidGestureDirection_None	None.
HidGestureDirection_Left	Left.
HidGestureDirection_Up	Up.
HidGestureDirection_Right	Right.
HidGestureDirection_Down	Down.

◆ HidGestureType

enum HidGestureType

HidGestureType.

Enumerator
HidGestureType_Idle	Idle.
HidGestureType_Complete	Complete.
HidGestureType_Cancel	Cancel.
HidGestureType_Touch	Touch.
HidGestureType_Press	Press.
HidGestureType_Tap	Tap.
HidGestureType_Pan	Pan.
HidGestureType_Swipe	Swipe.
HidGestureType_Pinch	Pinch.
HidGestureType_Rotate	Rotate.

◆ HidGyroscopeZeroDriftMode

enum HidGyroscopeZeroDriftMode

GyroscopeZeroDriftMode.

Enumerator
HidGyroscopeZeroDriftMode_Loose	Loose.
HidGyroscopeZeroDriftMode_Standard	Standard.
HidGyroscopeZeroDriftMode_Tight	Tight.

◆ HidKeyboardLockKeyEvent

enum HidKeyboardLockKeyEvent

KeyboardLockKeyEvent.

Enumerator
HidKeyboardLockKeyEvent_NumLockOn	NumLockOn.
HidKeyboardLockKeyEvent_NumLockOff	NumLockOff.
HidKeyboardLockKeyEvent_NumLockToggle	NumLockToggle.
HidKeyboardLockKeyEvent_CapsLockOn	CapsLockOn.
HidKeyboardLockKeyEvent_CapsLockOff	CapsLockOff.
HidKeyboardLockKeyEvent_CapsLockToggle	CapsLockToggle.
HidKeyboardLockKeyEvent_ScrollLockOn	ScrollLockOn.
HidKeyboardLockKeyEvent_ScrollLockOff	ScrollLockOff.
HidKeyboardLockKeyEvent_ScrollLockToggle	ScrollLockToggle.

◆ HidMouseAttribute

enum HidMouseAttribute

HidMouseAttribute.

Enumerator
HidMouseAttribute_Transferable	Transferable.
HidMouseAttribute_IsConnected	IsConnected.

◆ HidNpadAttribute

enum HidNpadAttribute

HidNpadAttribute.

Enumerator
HidNpadAttribute_IsConnected	IsConnected.
HidNpadAttribute_IsWired	IsWired.
HidNpadAttribute_IsLeftConnected	IsLeftConnected.
HidNpadAttribute_IsLeftWired	IsLeftWired.
HidNpadAttribute_IsRightConnected	IsRightConnected.
HidNpadAttribute_IsRightWired	IsRightWired.

◆ HidNpadButton

enum HidNpadButton

HidNpadButton.

Enumerator
HidNpadButton_A	A button / Right face button.
HidNpadButton_B	B button / Down face button.
HidNpadButton_X	X button / Up face button.
HidNpadButton_Y	Y button / Left face button.
HidNpadButton_StickL	Left Stick button.
HidNpadButton_StickR	Right Stick button.
HidNpadButton_L	L button.
HidNpadButton_R	R button.
HidNpadButton_ZL	ZL button.
HidNpadButton_ZR	ZR button.
HidNpadButton_Plus	Plus button.
HidNpadButton_Minus	Minus button.
HidNpadButton_Left	D-Pad Left button.
HidNpadButton_Up	D-Pad Up button.
HidNpadButton_Right	D-Pad Right button.
HidNpadButton_Down	D-Pad Down button.
HidNpadButton_StickLLeft	Left Stick pseudo-button when moved Left.
HidNpadButton_StickLUp	Left Stick pseudo-button when moved Up.
HidNpadButton_StickLRight	Left Stick pseudo-button when moved Right.
HidNpadButton_StickLDown	Left Stick pseudo-button when moved Down.
HidNpadButton_StickRLeft	Right Stick pseudo-button when moved Left.
HidNpadButton_StickRUp	Right Stick pseudo-button when moved Up.
HidNpadButton_StickRRight	Right Stick pseudo-button when moved Right.
HidNpadButton_StickRDown	Right Stick pseudo-button when moved Left.
HidNpadButton_LeftSL	SL button on Left Joy-Con.
HidNpadButton_LeftSR	SR button on Left Joy-Con.
HidNpadButton_RightSL	SL button on Right Joy-Con.
HidNpadButton_RightSR	SR button on Right Joy-Con.
HidNpadButton_Palma	Top button on Poké Ball Plus (Palma) controller.
HidNpadButton_Verification	Verification.
HidNpadButton_HandheldLeftB	B button on Left NES/HVC controller in Handheld mode.
HidNpadButton_LagonCLeft	Left C button in N64 controller.
HidNpadButton_LagonCUp	Up C button in N64 controller.
HidNpadButton_LagonCRight	Right C button in N64 controller.
HidNpadButton_LagonCDown	Down C button in N64 controller.
HidNpadButton_AnyLeft	Bitmask containing all buttons that are considered Left (D-Pad, Sticks)
HidNpadButton_AnyUp	Bitmask containing all buttons that are considered Up (D-Pad, Sticks)
HidNpadButton_AnyRight	Bitmask containing all buttons that are considered Right (D-Pad, Sticks)
HidNpadButton_AnyDown	Bitmask containing all buttons that are considered Down (D-Pad, Sticks)
HidNpadButton_AnySL	Bitmask containing SL buttons on both Joy-Cons (Left/Right)
HidNpadButton_AnySR	Bitmask containing SR buttons on both Joy-Cons (Left/Right)

◆ HidNpadCommunicationMode

enum HidNpadCommunicationMode

NpadCommunicationMode.

Enumerator
HidNpadCommunicationMode_5ms	5ms
HidNpadCommunicationMode_10ms	10ms
HidNpadCommunicationMode_15ms	15ms
HidNpadCommunicationMode_Default	Default.

◆ HidNpadHandheldActivationMode

enum HidNpadHandheldActivationMode

This controls how many Joy-Cons must be attached for handheld-mode to be activated.

Enumerator
HidNpadHandheldActivationMode_Dual	Dual (2 Joy-Cons)
HidNpadHandheldActivationMode_Single	Single (1 Joy-Con)
HidNpadHandheldActivationMode_None	None (0 Joy-Cons)

◆ HidNpadIdType

enum HidNpadIdType

HID controller IDs.

Enumerator
HidNpadIdType_No1	Player 1 controller.
HidNpadIdType_No2	Player 2 controller.
HidNpadIdType_No3	Player 3 controller.
HidNpadIdType_No4	Player 4 controller.
HidNpadIdType_No5	Player 5 controller.
HidNpadIdType_No6	Player 6 controller.
HidNpadIdType_No7	Player 7 controller.
HidNpadIdType_No8	Player 8 controller.
HidNpadIdType_Other	Other controller.
HidNpadIdType_Handheld	Handheld mode controls.

◆ HidNpadInterfaceType

enum HidNpadInterfaceType

NpadInterfaceType (system)

Enumerator
HidNpadInterfaceType_Bluetooth	Bluetooth.
HidNpadInterfaceType_Rail	Rail.
HidNpadInterfaceType_USB	USB.
HidNpadInterfaceType_Unknown4	Unknown.

◆ HidNpadJoyAssignmentMode

enum HidNpadJoyAssignmentMode

NpadJoyAssignmentMode.

Enumerator
HidNpadJoyAssignmentMode_Dual	Dual (Set by hidSetNpadJoyAssignmentModeDual)
HidNpadJoyAssignmentMode_Single	Single (Set by hidSetNpadJoyAssignmentModeSingle*())

◆ HidNpadJoyDeviceType

enum HidNpadJoyDeviceType

NpadJoyDeviceType.

Enumerator
HidNpadJoyDeviceType_Left	Left.
HidNpadJoyDeviceType_Right	Right.

◆ HidNpadJoyHoldType

enum HidNpadJoyHoldType

NpadJoyHoldType.

Enumerator
HidNpadJoyHoldType_Vertical	Default / Joy-Con held vertically.
HidNpadJoyHoldType_Horizontal	Joy-Con held horizontally.

◆ HidNpadLagerType

enum HidNpadLagerType

NpadLagerType.

Enumerator
HidNpadLagerType_Invalid	Invalid.
HidNpadLagerType_J	J.
HidNpadLagerType_E	E.
HidNpadLagerType_U	U.

◆ HidNpadLarkType

enum HidNpadLarkType

NpadLarkType.

Enumerator
HidNpadLarkType_Invalid	Invalid.
HidNpadLarkType_H1	H1.
HidNpadLarkType_H2	H2.
HidNpadLarkType_NL	NL.
HidNpadLarkType_NR	NR.

◆ HidNpadLuciaType

enum HidNpadLuciaType

NpadLuciaType.

Enumerator
HidNpadLuciaType_Invalid	Invalid.
HidNpadLuciaType_J	J.
HidNpadLuciaType_E	E.
HidNpadLuciaType_U	U.

◆ HidNpadStyleTag

enum HidNpadStyleTag

HID controller styles.

Enumerator
HidNpadStyleTag_NpadFullKey	Pro Controller.
HidNpadStyleTag_NpadHandheld	Joy-Con controller in handheld mode.
HidNpadStyleTag_NpadJoyDual	Joy-Con controller in dual mode.
HidNpadStyleTag_NpadJoyLeft	Joy-Con left controller in single mode.
HidNpadStyleTag_NpadJoyRight	Joy-Con right controller in single mode.
HidNpadStyleTag_NpadGc	GameCube controller.
HidNpadStyleTag_NpadPalma	Poké Ball Plus controller.
HidNpadStyleTag_NpadLark	NES/Famicom controller.
HidNpadStyleTag_NpadHandheldLark	NES/Famicom controller in handheld mode.
HidNpadStyleTag_NpadLucia	SNES controller.
HidNpadStyleTag_NpadLagon	N64 controller.
HidNpadStyleTag_NpadLager	Sega Genesis controller.
HidNpadStyleTag_NpadSystemExt	Generic external controller.
HidNpadStyleTag_NpadSystem	Generic controller.
HidNpadStyleSet_NpadFullCtrl	Style set comprising Npad styles containing the full set of controls {FullKey, Handheld, JoyDual}.
HidNpadStyleSet_NpadStandard	Style set comprising all standard Npad styles {FullKey, Handheld, JoyDual, JoyLeft, JoyRight}.

◆ HidPalmaFeature

enum HidPalmaFeature

PalmaFeature.

Enumerator
HidPalmaFeature_FrMode	FrMode.
HidPalmaFeature_RumbleFeedback	RumbleFeedback.
HidPalmaFeature_Step	Step.
HidPalmaFeature_MuteSwitch	MuteSwitch.

◆ HidPalmaFrModeType

enum HidPalmaFrModeType

PalmaFrModeType.

Enumerator
HidPalmaFrModeType_Off	Off.
HidPalmaFrModeType_B01	B01.
HidPalmaFrModeType_B02	B02.
HidPalmaFrModeType_B03	B03.
HidPalmaFrModeType_Downloaded	Downloaded.

◆ HidPalmaOperationType

enum HidPalmaOperationType

PalmaOperationType.

Enumerator
HidPalmaOperationType_PlayActivity	PlayActivity.
HidPalmaOperationType_SetFrModeType	SetFrModeType.
HidPalmaOperationType_ReadStep	ReadStep.
HidPalmaOperationType_EnableStep	EnableStep.
HidPalmaOperationType_ResetStep	ResetStep.
HidPalmaOperationType_ReadApplicationSection	ReadApplicationSection.
HidPalmaOperationType_WriteApplicationSection	WriteApplicationSection.
HidPalmaOperationType_ReadUniqueCode	ReadUniqueCode.
HidPalmaOperationType_SetUniqueCodeInvalid	SetUniqueCodeInvalid.
HidPalmaOperationType_WriteActivityEntry	WriteActivityEntry.
HidPalmaOperationType_WriteRgbLedPatternEntry	WriteRgbLedPatternEntry.
HidPalmaOperationType_WriteWaveEntry	WriteWaveEntry.
HidPalmaOperationType_ReadDataBaseIdentificationVersion	ReadDataBaseIdentificationVersion.
HidPalmaOperationType_WriteDataBaseIdentificationVersion	WriteDataBaseIdentificationVersion.
HidPalmaOperationType_SuspendFeature	SuspendFeature.
HidPalmaOperationType_ReadPlayLog	[5.1.0+] ReadPlayLog
HidPalmaOperationType_ResetPlayLog	[5.1.0+] ResetPlayLog

◆ HidPalmaWaveSet

enum HidPalmaWaveSet

PalmaWaveSet.

Enumerator
HidPalmaWaveSet_Small	Small.
HidPalmaWaveSet_Medium	Medium.
HidPalmaWaveSet_Large	Large.

◆ HidSixAxisSensorAttribute

enum HidSixAxisSensorAttribute

HidSixAxisSensorAttribute.

Enumerator
HidSixAxisSensorAttribute_IsConnected	IsConnected.
HidSixAxisSensorAttribute_IsInterpolated	IsInterpolated.

◆ HidTouchAttribute

enum HidTouchAttribute

HidTouchAttribute.

Enumerator
HidTouchAttribute_Start	Start.
HidTouchAttribute_End	End.

◆ HidTouchScreenModeForNx

enum HidTouchScreenModeForNx

HidTouchScreenModeForNx.

Enumerator
HidTouchScreenModeForNx_UseSystemSetting	UseSystemSetting.
HidTouchScreenModeForNx_Finger	Finger.
HidTouchScreenModeForNx_Heat2	Heat2.

◆ HidVibrationDevicePosition

enum HidVibrationDevicePosition

VibrationDevicePosition.

Enumerator
HidVibrationDevicePosition_None	None.
HidVibrationDevicePosition_Left	Left.
HidVibrationDevicePosition_Right	Right.

◆ HidVibrationDeviceType

enum HidVibrationDeviceType

Type values for HidVibrationDeviceInfo::type.

Enumerator
HidVibrationDeviceType_Unknown	Unknown.
HidVibrationDeviceType_LinearResonantActuator	LinearResonantActuator.
HidVibrationDeviceType_GcErm	GcErm (HidNpadStyleTag_NpadGc)

◆ HidVibrationGcErmCommand

enum HidVibrationGcErmCommand

VibrationGcErmCommand.

Enumerator
HidVibrationGcErmCommand_Stop	Stops the vibration with a decay phase.
HidVibrationGcErmCommand_Start	Starts the vibration.
HidVibrationGcErmCommand_StopHard	Stops the vibration immediately, with no decay phase.

Function Documentation

◆ hidAcquireNpadStyleSetUpdateEventHandle()

Result hidAcquireNpadStyleSetUpdateEventHandle	(	HidNpadIdType	id,
		Event *	out_event,
		bool	autoclear
	)

Gets an Event which is signaled when the hidGetNpadStyleSet output is updated for the specified controller.

Note: The Event must be closed by the user once finished with it.

Parameters

[in]	id	HidNpadIdType
[out]	out_event	Output Event.
[in]	autoclear	The autoclear for the Event.

◆ hidAcquirePalmaOperationCompleteEvent()

Result hidAcquirePalmaOperationCompleteEvent	(	HidPalmaConnectionHandle	handle,
		Event *	out_event,
		bool	autoclear
	)

Gets an Event which is signaled when data is available with hidGetPalmaOperationInfo.

Note: The Event must be closed by the user once finished with it.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[out]	out_event	Output Event.
[in]	autoclear	The autoclear for the Event.

◆ hidBeginPermitVibrationSession()

Result hidBeginPermitVibrationSession ( void )

Begins a forced-permitted vibration session.

Note: Only available on [4.0.0+].

◆ hidCancelWritePalmaWaveEntry()

Result hidCancelWritePalmaWaveEntry ( HidPalmaConnectionHandle handle )

CancelWritePalmaWaveEntry.

Note: Only available on [7.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidClearNpadCaptureButtonAssignment()

Result hidClearNpadCaptureButtonAssignment ( void )

ClearNpadCaptureButtonAssignment.

Note: Only available on [8.0.0+].

◆ hidDisconnectNpad()

Result hidDisconnectNpad ( HidNpadIdType id )

DisconnectNpad.

Parameters

[in] id HidNpadIdType

◆ hidEnablePalmaBoostMode()

Result hidEnablePalmaBoostMode ( bool flag )

EnablePalmaBoostMode.

Note: Only available on [5.1.0+]. Uses cmd EnablePalmaBoostMode on [8.0.0+], otherwise cmd SetPalmaBoostMode is used.

Parameters

[in] flag Flag

◆ hidEnablePalmaStep()

Result hidEnablePalmaStep	(	HidPalmaConnectionHandle	handle,
		bool	flag
	)

EnablePalmaStep.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	flag	Flag

◆ hidEnableSixAxisSensorFusion()

Result hidEnableSixAxisSensorFusion	(	HidSixAxisSensorHandle	handle,
		bool	flag
	)

EnableSixAxisSensorFusion.

Parameters

[in]	handle	HidSixAxisSensorHandle
[in]	flag	Flag

◆ hidEnableUnintendedHomeButtonInputProtection()

Result hidEnableUnintendedHomeButtonInputProtection	(	HidNpadIdType	id,
		bool	flag
	)

EnableUnintendedHomeButtonInputProtection.

Note: To get the state of this, use hidGetNpadSystemButtonProperties to access HidNpadSystemButtonProperties::is_unintended_home_button_input_protection_enabled.

Parameters

[in]	id	HidNpadIdType
[in]	flag	Whether UnintendedHomeButtonInputProtection is enabled.

◆ hidEnableUsbFullKeyController()

Result hidEnableUsbFullKeyController ( bool flag )

EnableUsbFullKeyController.

Note: Only available on [3.0.0+].

Parameters

[in] flag Flag

◆ hidEndPermitVibrationSession()

Result hidEndPermitVibrationSession ( void )

Ends the session started by hidBeginPermitVibrationSession.

Note: Only available on [4.0.0+].

◆ hidFinalizeSevenSixAxisSensor()

Result hidFinalizeSevenSixAxisSensor ( void )

Finalizes the SevenSixAxisSensor.

Note: This must be called before hidExit.; Only available on [5.0.0+].

◆ hidGetActualVibrationGcErmCommand()

Result hidGetActualVibrationGcErmCommand	(	HidVibrationDeviceHandle	handle,
		HidVibrationGcErmCommand *	out
	)

Get HidVibrationGcErmCommand for the specified device, for HidVibrationDeviceType_GcErm.

Note: Only available on [4.0.0+].

Parameters

[in]	handle	HidVibrationDeviceHandle
[out]	out	HidVibrationGcErmCommand

◆ hidGetActualVibrationValue()

Result hidGetActualVibrationValue	(	HidVibrationDeviceHandle	handle,
		HidVibrationValue *	out
	)

Gets the current HidVibrationValue for the specified device.

Note: With HidVibrationDeviceType_GcErm, use hidGetActualVibrationGcErmCommand instead.

Parameters

[in]	handle	HidVibrationDeviceHandle
[out]	out	HidVibrationValue

◆ hidGetAppletFooterUiAttributesSet()

u32 hidGetAppletFooterUiAttributesSet ( HidNpadIdType id )

Gets the AppletFooterUiAttributesSet for the specified Npad.

Note: Only available on [9.0.0+].

Parameters

[in] id HidNpadIdType

Returns: Bitfield of AppletFooterUiAttribute (system).

◆ hidGetAppletFooterUiTypes()

HidAppletFooterUiType hidGetAppletFooterUiTypes ( HidNpadIdType id )

Gets HidAppletFooterUiType for the specified Npad.

Note: Only available on [9.0.0+].

Parameters

[in] id HidNpadIdType

Returns: HidAppletFooterUiType

◆ hidGetGestureStates()

size_t hidGetGestureStates	(	HidGestureState *	states,
		size_t	count
	)

Gets HidGestureState.

Parameters

[out]	states	Output array of HidGestureState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetGyroBias()

Result hidGetGyroBias ( UtilFloat3 * out )

GetGyroBias.

Note: Only available when hidInitializeSevenSixAxisSensor was previously used.

Parameters

[out] out UtilFloat3

◆ hidGetGyroscopeZeroDriftMode()

Result hidGetGyroscopeZeroDriftMode	(	HidSixAxisSensorHandle	handle,
		HidGyroscopeZeroDriftMode *	mode
	)

Gets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle.

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	mode	HidGyroscopeZeroDriftMode

◆ hidGetKeyboardStates()

size_t hidGetKeyboardStates	(	HidKeyboardState *	states,
		size_t	count
	)

Gets HidKeyboardState.

Parameters

[out]	states	Output array of HidKeyboardState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetMouseStates()

size_t hidGetMouseStates	(	HidMouseState *	states,
		size_t	count
	)

Gets HidMouseState.

Parameters

[out]	states	Output array of HidMouseState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadCommunicationMode()

Result hidGetNpadCommunicationMode ( HidNpadCommunicationMode * out )

GetNpadCommunicationMode.

Note: [2.0.0+] Stubbed, always returns output mode HidNpadCommunicationMode_Default.

Parameters

[out] out HidNpadCommunicationMode

◆ hidGetNpadControllerColorSingle()

Result hidGetNpadControllerColorSingle	(	HidNpadIdType	id,
		HidNpadControllerColor *	color
	)

Gets the main HidNpadControllerColor for the specified Npad.

Parameters

[in]	id	HidNpadIdType
[out]	color	HidNpadControllerColor

◆ hidGetNpadControllerColorSplit()

Result hidGetNpadControllerColorSplit	(	HidNpadIdType	id,
		HidNpadControllerColor *	color_left,
		HidNpadControllerColor *	color_right
	)

Gets the left/right HidNpadControllerColor for the specified Npad (Joy-Con pair in dual mode).

Parameters

[in]	id	HidNpadIdType
[out]	color_left	HidNpadControllerColor
[out]	color_right	HidNpadControllerColor

◆ hidGetNpadDeviceType()

u32 hidGetNpadDeviceType ( HidNpadIdType id )

Gets the DeviceType for the specified Npad.

Parameters

[in] id HidNpadIdType

Returns: Bitfield of HidDeviceTypeBits.

◆ hidGetNpadHandheldActivationMode()

Result hidGetNpadHandheldActivationMode ( HidNpadHandheldActivationMode * out )

Gets the HidNpadHandheldActivationMode.

Parameters

[out] out HidNpadHandheldActivationMode

◆ hidGetNpadInterfaceType()

Result hidGetNpadInterfaceType	(	HidNpadIdType	id,
		u8 *	out
	)

Gets the HidNpadInterfaceType for the specified controller.

Note: When available, hidsysGetNpadInterfaceType should be used instead.; Only available on [4.0.0+].

Parameters

[in]	id	HidNpadIdType
[out]	out	HidNpadInterfaceType

◆ hidGetNpadJoyAssignment()

HidNpadJoyAssignmentMode hidGetNpadJoyAssignment ( HidNpadIdType id )

Gets the HidNpadJoyAssignmentMode for the specified Npad.

Parameters

[in] id HidNpadIdType

Returns: HidNpadJoyAssignmentMode

◆ hidGetNpadJoyHoldType()

Result hidGetNpadJoyHoldType ( HidNpadJoyHoldType * type )

Gets the HidNpadJoyHoldType.

Parameters

[out] type HidNpadJoyHoldType

◆ hidGetNpadLagerType()

HidNpadLagerType hidGetNpadLagerType ( HidNpadIdType id )

Gets HidNpadLagerType for the specified Npad.

Parameters

[in] id HidNpadIdType

Returns: HidNpadLagerType

◆ hidGetNpadOfHighestBatteryLevel()

Result hidGetNpadOfHighestBatteryLevel	(	const HidNpadIdType *	ids,
		size_t	count,
		HidNpadIdType *	out
	)

GetNpadOfHighestBatteryLevel.

Note: Only available on [10.0.0+].

Parameters

[in]	ids	Input array of HidNpadIdType, HidNpadIdType_Handheld is ignored.
[in]	count	Total entries in the ids array.
[out]	out	HidNpadIdType

◆ hidGetNpadPowerInfoSingle()

void hidGetNpadPowerInfoSingle	(	HidNpadIdType	id,
		HidPowerInfo *	info
	)

Gets the main HidPowerInfo for the specified Npad.

Parameters

[in]	id	HidNpadIdType
[out]	info	HidPowerInfo

◆ hidGetNpadPowerInfoSplit()

void hidGetNpadPowerInfoSplit	(	HidNpadIdType	id,
		HidPowerInfo *	info_left,
		HidPowerInfo *	info_right
	)

Gets the left/right HidPowerInfo for the specified Npad (Joy-Con pair in dual mode).

Parameters

[in]	id	HidNpadIdType
[out]	info_left	HidPowerInfo
[out]	info_right	HidPowerInfo

◆ hidGetNpadStatesFullKey()

size_t hidGetNpadStatesFullKey	(	HidNpadIdType	id,
		HidNpadFullKeyState *	states,
		size_t	count
	)

Gets HidNpadFullKeyState.

Parameters

[out]	states	Output array of HidNpadFullKeyState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesGc()

size_t hidGetNpadStatesGc	(	HidNpadIdType	id,
		HidNpadGcState *	states,
		size_t	count
	)

Gets HidNpadGcState.

Parameters

[out]	states	Output array of HidNpadGcState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesHandheld()

size_t hidGetNpadStatesHandheld	(	HidNpadIdType	id,
		HidNpadHandheldState *	states,
		size_t	count
	)

Gets HidNpadHandheldState.

Parameters

[out]	states	Output array of HidNpadHandheldState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesHandheldLark()

size_t hidGetNpadStatesHandheldLark	(	HidNpadIdType	id,
		HidNpadHandheldLarkState *	states,
		size_t	count
	)

Gets HidNpadHandheldLarkState.

Parameters

[out]	states	Output array of HidNpadHandheldLarkState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesJoyDual()

size_t hidGetNpadStatesJoyDual	(	HidNpadIdType	id,
		HidNpadJoyDualState *	states,
		size_t	count
	)

Gets HidNpadJoyDualState.

Parameters

[out]	states	Output array of HidNpadJoyDualState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesJoyLeft()

size_t hidGetNpadStatesJoyLeft	(	HidNpadIdType	id,
		HidNpadJoyLeftState *	states,
		size_t	count
	)

Gets HidNpadJoyLeftState.

Parameters

[out]	states	Output array of HidNpadJoyLeftState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesJoyRight()

size_t hidGetNpadStatesJoyRight	(	HidNpadIdType	id,
		HidNpadJoyRightState *	states,
		size_t	count
	)

Gets HidNpadJoyRightState.

Parameters

[out]	states	Output array of HidNpadJoyRightState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesLager()

size_t hidGetNpadStatesLager	(	HidNpadIdType	id,
		HidNpadLagerState *	states,
		size_t	count
	)

Gets HidNpadLagerState.

Parameters

[out]	states	Output array of HidNpadLagerState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesLark()

size_t hidGetNpadStatesLark	(	HidNpadIdType	id,
		HidNpadLarkState *	states,
		size_t	count
	)

Gets HidNpadLarkState.

Parameters

[out]	states	Output array of HidNpadLarkState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesLucia()

size_t hidGetNpadStatesLucia	(	HidNpadIdType	id,
		HidNpadLuciaState *	states,
		size_t	count
	)

Gets HidNpadLuciaState.

Parameters

[out]	states	Output array of HidNpadLuciaState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesPalma()

size_t hidGetNpadStatesPalma	(	HidNpadIdType	id,
		HidNpadPalmaState *	states,
		size_t	count
	)

Gets HidNpadPalmaState.

Parameters

[out]	states	Output array of HidNpadPalmaState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesSystem()

size_t hidGetNpadStatesSystem	(	HidNpadIdType	id,
		HidNpadSystemState *	states,
		size_t	count
	)

Gets HidNpadSystemState.

Parameters

[out]	states	Output array of HidNpadSystemState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStatesSystemExt()

size_t hidGetNpadStatesSystemExt	(	HidNpadIdType	id,
		HidNpadSystemExtState *	states,
		size_t	count
	)

Gets HidNpadSystemExtState.

Parameters

[out]	states	Output array of HidNpadSystemExtState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetNpadStyleSet()

u32 hidGetNpadStyleSet ( HidNpadIdType id )

Gets the StyleSet for the specified Npad.

Parameters

[in] id HidNpadIdType

Returns: Bitfield of HidNpadStyleTag.

◆ hidGetNpadSystemButtonProperties()

void hidGetNpadSystemButtonProperties	(	HidNpadIdType	id,
		HidNpadSystemButtonProperties *	out
	)

Gets the HidNpadSystemButtonProperties for the specified Npad.

Parameters

[in]	id	HidNpadIdType
[out]	out	HidNpadSystemButtonProperties

◆ hidGetNpadSystemProperties()

void hidGetNpadSystemProperties	(	HidNpadIdType	id,
		HidNpadSystemProperties *	out
	)

Gets the HidNpadSystemProperties for the specified Npad.

Parameters

[in]	id	HidNpadIdType
[out]	out	HidNpadSystemProperties

◆ hidGetPalmaBluetoothAddress()

Result hidGetPalmaBluetoothAddress	(	HidPalmaConnectionHandle	handle,
		BtdrvAddress *	out
	)

GetPalmaBluetoothAddress.

Note: Only available on [8.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[out]	out	BtdrvAddress

◆ hidGetPalmaConnectionHandle()

Result hidGetPalmaConnectionHandle	(	HidNpadIdType	id,
		HidPalmaConnectionHandle *	out
	)

GetPalmaConnectionHandle.

Note: Only available on [5.0.0+].

Parameters

[in]	id	HidNpadIdType
[out]	out	HidPalmaConnectionHandle

◆ hidGetPalmaDataBaseIdentificationVersion()

Result hidGetPalmaDataBaseIdentificationVersion ( HidPalmaConnectionHandle handle )

GetPalmaDataBaseIdentificationVersion.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidGetPalmaOperationInfo()

Result hidGetPalmaOperationInfo	(	HidPalmaConnectionHandle	handle,
		HidPalmaOperationInfo *	out
	)

Gets HidPalmaOperationInfo for a completed operation.

Note: This must be used at some point following using any of the other Palma cmds which trigger an Operation, once the Event from hidAcquirePalmaOperationCompleteEvent is signaled. Up to 4 Operations can be queued at once, the other cmds will throw an error once there's too many operations.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[out]	out	HidPalmaOperationInfo

◆ hidGetPlayerLedPattern()

Result hidGetPlayerLedPattern	(	HidNpadIdType	id,
		u8 *	out
	)

GetPlayerLedPattern.

Parameters

[in]	id	HidNpadIdType
[out]	out	Output value.

◆ hidGetSensorFusionError()

Result hidGetSensorFusionError ( float * out )

GetSensorFusionError.

Note: Only available when hidInitializeSevenSixAxisSensor was previously used.

Parameters

[out] out Output data.

◆ hidGetSevenSixAxisSensorFusionStrength()

Result hidGetSevenSixAxisSensorFusionStrength ( float * strength )

Gets the SevenSixAxisSensor FusionStrength.

Note: Only available on [5.0.0+].

Parameters

[out] strength Strength

◆ hidGetSevenSixAxisSensorStates()

Result hidGetSevenSixAxisSensorStates	(	HidSevenSixAxisSensorState *	states,
		size_t	count,
		size_t *	total_out
	)

GetSevenSixAxisSensorStates.

Note: Only available when hidInitializeSevenSixAxisSensor was previously used.

Parameters

[out]	states	Output array of HidSevenSixAxisSensorState.
[in]	count	Size of the states array in entries.
[out]	total_out	Total output entries.

◆ hidGetSixAxisSensorFusionParameters()

Result hidGetSixAxisSensorFusionParameters	(	HidSixAxisSensorHandle	handle,
		float *	unk0,
		float *	unk1
	)

GetSixAxisSensorFusionParameters.

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	unk0	Unknown
[out]	unk1	Unknown

◆ hidGetSixAxisSensorHandles()

Result hidGetSixAxisSensorHandles	(	HidSixAxisSensorHandle *	handles,
		s32	total_handles,
		HidNpadIdType	id,
		HidNpadStyleTag	style
	)

Gets SixAxisSensorHandles.

Note: Only HidNpadStyleTag_NpadJoyDual supports total_handles==2.

Parameters

[out]	handles	Output array of HidSixAxisSensorHandle.
[in]	total_handles	Total handles for the handles array. Must be 1 or 2, if 2 handles aren't supported by the specified style an error is thrown.
[in]	id	HidNpadIdType
[in]	style	HidNpadStyleTag

◆ hidGetSixAxisSensorStates()

size_t hidGetSixAxisSensorStates	(	HidSixAxisSensorHandle	handle,
		HidSixAxisSensorState *	states,
		size_t	count
	)

Gets HidSixAxisSensorState for the specified handle.

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	states	Output array of HidSixAxisSensorState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetSupportedNpadStyleSet()

Result hidGetSupportedNpadStyleSet ( u32 * style_set )

Gets which controller styles are supported.

Parameters

[out] style_set Bitfield of HidNpadStyleTag.

◆ hidGetTouchScreenStates()

size_t hidGetTouchScreenStates	(	HidTouchScreenState *	states,
		size_t	count
	)

Gets HidTouchScreenState.

Parameters

[out]	states	Output array of HidTouchScreenState.
[in]	count	Size of the states array in entries.

Returns: Total output entries.

◆ hidGetVibrationDeviceInfo()

Result hidGetVibrationDeviceInfo	(	HidVibrationDeviceHandle	handle,
		HidVibrationDeviceInfo *	out
	)

Gets HidVibrationDeviceInfo for the specified device.

Parameters

[in]	handle	HidVibrationDeviceHandle
[out]	out	HidVibrationDeviceInfo

◆ hidInitializePalma()

Result hidInitializePalma ( HidPalmaConnectionHandle handle )

InitializePalma.

Note: Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidInitializeSevenSixAxisSensor()

Result hidInitializeSevenSixAxisSensor ( void )

Initializes the SevenSixAxisSensor.

Note: Only available on [5.0.0+].

◆ hidInitializeVibrationDevices()

Result hidInitializeVibrationDevices	(	HidVibrationDeviceHandle *	handles,
		s32	total_handles,
		HidNpadIdType	id,
		HidNpadStyleTag	style
	)

Gets and initializes vibration handles.

Note: Only the following styles support total_handles 2: HidNpadStyleTag_NpadFullKey, HidNpadStyleTag_NpadHandheld, HidNpadStyleTag_NpadJoyDual, HidNpadStyleTag_NpadHandheldLark, HidNpadStyleTag_NpadSystem, HidNpadStyleTag_NpadSystemExt.

Parameters

[out]	handles	Output array of HidVibrationDeviceHandle.
[in]	total_handles	Total handles for the handles array. Must be 1 or 2, if 2 handles aren't supported by the specified style an error is thrown.
[in]	id	HidNpadIdType
[in]	style	HidNpadStyleTag

◆ hidIsFirmwareUpdateAvailableForSixAxisSensor()

Result hidIsFirmwareUpdateAvailableForSixAxisSensor	(	HidSixAxisSensorHandle	handle,
		bool *	out
	)

IsFirmwareUpdateAvailableForSixAxisSensor.

Note: Only available on [6.0.0+].

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	out	Output flag.

◆ hidIsFirmwareUpdateNeededForNotification()

Result hidIsFirmwareUpdateNeededForNotification ( bool * out )

IsFirmwareUpdateNeededForNotification.

Note: Only available on [9.0.0+].

Parameters

[out] out Output flag.

◆ hidIsSevenSixAxisSensorAtRest()

Result hidIsSevenSixAxisSensorAtRest ( bool * out )

IsSevenSixAxisSensorAtRest.

Note: Only available when hidInitializeSevenSixAxisSensor was previously used.

Parameters

[out] out Output flag.

◆ hidIsSixAxisSensorAtRest()

Result hidIsSixAxisSensorAtRest	(	HidSixAxisSensorHandle	handle,
		bool *	out
	)

IsSixAxisSensorAtRest.

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	out	Output flag.

◆ hidIsSixAxisSensorFusionEnabled()

Result hidIsSixAxisSensorFusionEnabled	(	HidSixAxisSensorHandle	handle,
		bool *	out
	)

IsSixAxisSensorFusionEnabled.

Parameters

[in]	handle	HidSixAxisSensorHandle
[out]	out	Output flag.

◆ hidIsUsbFullKeyControllerConnected()

Result hidIsUsbFullKeyControllerConnected	(	HidNpadIdType	id,
		bool *	out
	)

IsUsbFullKeyControllerConnected.

Note: Only available on [3.0.0+].

Parameters

[in]	id	HidNpadIdType
[out]	out	Output flag.

◆ hidIsUsbFullKeyControllerEnabled()

Result hidIsUsbFullKeyControllerEnabled ( bool * out )

IsUsbFullKeyControllerEnabled.

Note: Only available on [3.0.0+].

Parameters

[out] out Output flag.

◆ hidIsVibrationDeviceMounted()

Result hidIsVibrationDeviceMounted	(	HidVibrationDeviceHandle	handle,
		bool *	flag
	)

Gets whether vibration is available with the specified device.

Note: Only available on [7.0.0+].

Parameters

[in]	handle	HidVibrationDeviceHandle
[out]	flag	Flag

◆ hidIsVibrationPermitted()

Result hidIsVibrationPermitted ( bool * flag )

Gets whether vibration is allowed.

Parameters

[out] flag Flag

◆ hidKeyboardStateGetKey()

static bool hidKeyboardStateGetKey	(	const HidKeyboardState *	state,
		HidKeyboardKey	key
	)

inlinestatic

Gets the state of a key in a HidKeyboardState.

Parameters

[in]	state	HidKeyboardState.
[in]	key	HidKeyboardKey.

Returns: true if the key is pressed, false if not.

◆ hidMergeSingleJoyAsDualJoy()

Result hidMergeSingleJoyAsDualJoy	(	HidNpadIdType	id0,
		HidNpadIdType	id1
	)

Merge two single joy-cons into a dual-mode controller.

Use this after hidSetNpadJoyAssignmentModeDual, when hidSetNpadJoyAssignmentModeSingleByDefault was previously used (this includes using this manually at application exit).

To be successful, id0/id1 must correspond to controllers supporting styles HidNpadStyleTag_NpadJoyLeft/Right, or HidNpadStyleTag_NpadJoyRight/Left.

If successful, the id of the resulting dual controller is set to id0.

Parameters

[in]	id0	HidNpadIdType
[in]	id1	HidNpadIdType

◆ hidPairPalma()

Result hidPairPalma ( HidPalmaConnectionHandle handle )

PairPalma.

Note: Only available on [5.1.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidPermitVibration()

Result hidPermitVibration ( bool flag )

Sets whether vibration is allowed, this also affects the config displayed by System Settings.

Parameters

[in] flag Flag

◆ hidPlayPalmaActivity()

Result hidPlayPalmaActivity	(	HidPalmaConnectionHandle	handle,
		u16	val
	)

PlayPalmaActivity.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	val	Input value.

◆ hidReadPalmaApplicationSection()

Result hidReadPalmaApplicationSection	(	HidPalmaConnectionHandle	handle,
		s32	inval0,
		u64	size
	)

ReadPalmaApplicationSection.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	inval0	First input value.
[in]	size	This must be within the size of HidPalmaApplicationSectionAccessBuffer.

◆ hidReadPalmaPlayLog()

Result hidReadPalmaPlayLog	(	HidPalmaConnectionHandle	handle,
		u16	unk
	)

ReadPalmaPlayLog.

Note: See hidGetPalmaOperationInfo.; Only available on [5.1.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	unk	Unknown

◆ hidReadPalmaStep()

Result hidReadPalmaStep ( HidPalmaConnectionHandle handle )

ReadPalmaStep.

Note: See hidGetPalmaOperationInfo.; hidEnablePalmaStep should be used before this.; Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidReadPalmaUniqueCode()

Result hidReadPalmaUniqueCode ( HidPalmaConnectionHandle handle )

ReadPalmaUniqueCode.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidResetGyroscopeZeroDriftMode()

Result hidResetGyroscopeZeroDriftMode ( HidSixAxisSensorHandle handle )

Resets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle to HidGyroscopeZeroDriftMode_Standard.

Parameters

[in] handle HidSixAxisSensorHandle

◆ hidResetPalmaPlayLog()

Result hidResetPalmaPlayLog	(	HidPalmaConnectionHandle	handle,
		u16	unk
	)

ResetPalmaPlayLog.

Note: See hidGetPalmaOperationInfo.; Only available on [5.1.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	unk	Unknown

◆ hidResetPalmaStep()

Result hidResetPalmaStep ( HidPalmaConnectionHandle handle )

ResetPalmaStep.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidResetSevenSixAxisSensorTimestamp()

Result hidResetSevenSixAxisSensorTimestamp ( void )

Resets the timestamp for the SevenSixAxisSensor.

Note: Only available on [6.0.0+].

◆ hidResetSixAxisSensorFusionParameters()

Result hidResetSixAxisSensorFusionParameters ( HidSixAxisSensorHandle handle )

ResetSixAxisSensorFusionParameters.

Parameters

[in] handle HidSixAxisSensorHandle

◆ hidSendKeyboardLockKeyEvent()

Result hidSendKeyboardLockKeyEvent ( u32 events )

SendKeyboardLockKeyEvent.

Note: Same as hidsysSendKeyboardLockKeyEvent.; Only available on [6.0.0+].

Parameters

[in] events Bitfield of HidKeyboardLockKeyEvent.

◆ hidSendVibrationGcErmCommand()

Result hidSendVibrationGcErmCommand	(	HidVibrationDeviceHandle	handle,
		HidVibrationGcErmCommand	cmd
	)

Send HidVibrationGcErmCommand to the specified device, for HidVibrationDeviceType_GcErm.

Note: Only available on [4.0.0+].

Parameters

[in]	handle	HidVibrationDeviceHandle
[in]	cmd	HidVibrationGcErmCommand

◆ hidSendVibrationValue()

Result hidSendVibrationValue	(	HidVibrationDeviceHandle	handle,
		const HidVibrationValue *	value
	)

Sends the HidVibrationDeviceHandle to the specified device.

Note: With HidVibrationDeviceType_GcErm, use hidSendVibrationGcErmCommand instead.

Parameters

[in]	handle	HidVibrationDeviceHandle
[in]	value	HidVibrationValue

◆ hidSendVibrationValues()

Result hidSendVibrationValues	(	const HidVibrationDeviceHandle *	handles,
		const HidVibrationValue *	values,
		s32	count
	)

Send vibration values[index] to handles[index].

Note: With HidVibrationDeviceType_GcErm, use hidSendVibrationGcErmCommand instead.

Parameters

[in]	handles	Input array of HidVibrationDeviceHandle.
[in]	values	Input array of HidVibrationValue.
[in]	count	Total entries in the handles/values arrays.

◆ hidSetDisallowedPalmaConnection()

Result hidSetDisallowedPalmaConnection	(	const BtdrvAddress *	addrs,
		s32	count
	)

SetDisallowedPalmaConnection.

Note: Only available on [8.0.0+].

Parameters

[in]	addrs	Input array of BtdrvAddress.
[in]	count	Total entries in the addrs array.

◆ hidSetGyroscopeZeroDriftMode()

Result hidSetGyroscopeZeroDriftMode	(	HidSixAxisSensorHandle	handle,
		HidGyroscopeZeroDriftMode	mode
	)

Sets the HidGyroscopeZeroDriftMode for the specified SixAxisSensorHandle.

Parameters

[in]	handle	HidSixAxisSensorHandle
[in]	mode	HidGyroscopeZeroDriftMode

◆ hidSetIsPalmaAllConnectable()

Result hidSetIsPalmaAllConnectable ( bool flag )

Sets whether any Palma can connect.

Note: Only available on [5.1.0+].

Parameters

[in] flag Flag

◆ hidSetIsPalmaPairedConnectable()

Result hidSetIsPalmaPairedConnectable ( bool flag )

Sets whether paired Palma can connect.

Note: Only available on [5.1.0+].

Parameters

[in] flag Flag

◆ hidSetNpadAnalogStickUseCenterClamp()

Result hidSetNpadAnalogStickUseCenterClamp ( bool flag )

SetNpadAnalogStickUseCenterClamp.

Note: Only available on [6.1.0+].

Parameters

[in] flag Flag

◆ hidSetNpadCaptureButtonAssignment()

Result hidSetNpadCaptureButtonAssignment	(	HidNpadStyleTag	style,
		u64	buttons
	)

Assigns the button(s) which trigger the CaptureButton.

Note: Only available on [8.0.0+].

Parameters

[in]	style	HidNpadStyleTag, exactly 1 bit must be set.
[in]	buttons	Bitfield of HidNpadButton, multiple bits can be set.

◆ hidSetNpadCommunicationMode()

Result hidSetNpadCommunicationMode ( HidNpadCommunicationMode mode )

SetNpadCommunicationMode.

Note: [2.0.0+] Stubbed, just returns 0.

Parameters

[in] mode HidNpadCommunicationMode

◆ hidSetNpadHandheldActivationMode()

Result hidSetNpadHandheldActivationMode ( HidNpadHandheldActivationMode mode )

Sets the HidNpadHandheldActivationMode.

Parameters

[in] mode HidNpadHandheldActivationMode

◆ hidSetNpadJoyAssignmentModeDual()

Result hidSetNpadJoyAssignmentModeDual ( HidNpadIdType id )

Use this if you want to use a pair of joy-cons as a single HidNpadIdType_No*.

When used, both joy-cons in a pair should be used with this (HidNpadIdType_No1 and HidNpadIdType_No2 for example).

Note: Used automatically by hidScanInput when required.

Parameters

[in] id HidNpadIdType, must be HidNpadIdType_No*.

◆ hidSetNpadJoyAssignmentModeSingle()

Result hidSetNpadJoyAssignmentModeSingle	(	HidNpadIdType	id,
		HidNpadJoyDeviceType	type
	)

This is the same as hidSetNpadJoyAssignmentModeSingleWithDestination, except without the output params.

Parameters

[in]	id	HidNpadIdType, must be HidNpadIdType_No*.
[in]	type	HidNpadJoyDeviceType

◆ hidSetNpadJoyAssignmentModeSingleByDefault()

Result hidSetNpadJoyAssignmentModeSingleByDefault ( HidNpadIdType id )

This is the same as hidSetNpadJoyAssignmentModeSingle, except HidNpadJoyDeviceType_Left is used for the type.

Parameters

[in] id HidNpadIdType, must be HidNpadIdType_No*.

◆ hidSetNpadJoyAssignmentModeSingleWithDestination()

Result hidSetNpadJoyAssignmentModeSingleWithDestination	(	HidNpadIdType	id,
		HidNpadJoyDeviceType	type,
		bool *	flag,
		HidNpadIdType *	dest
	)

Use this if you want to use a single joy-con as a dedicated HidNpadIdType_No*.

When used, both joy-cons in a pair should be used with this (HidNpadIdType_No1 and HidNpadIdType_No2 for example).

Note: Only available on [5.0.0+].

Parameters

[in]	id	HidNpadIdType, must be HidNpadIdType_No*.
[in]	type	HidNpadJoyDeviceType
[out]	flag	Whether the dest output is set.
[out]	dest	HidNpadIdType

◆ hidSetNpadJoyHoldType()

Result hidSetNpadJoyHoldType ( HidNpadJoyHoldType type )

Sets the HidNpadJoyHoldType.

Note: Used automatically by hidScanInput when required.

Parameters

[in] type HidNpadJoyHoldType

◆ hidSetPalmaDataBaseIdentificationVersion()

Result hidSetPalmaDataBaseIdentificationVersion	(	HidPalmaConnectionHandle	handle,
		s32	version
	)

SetPalmaDataBaseIdentificationVersion.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	version	Version

◆ hidSetPalmaFrModeType()

Result hidSetPalmaFrModeType	(	HidPalmaConnectionHandle	handle,
		HidPalmaFrModeType	type
	)

SetPalmaFrModeType.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	type	HidPalmaFrModeType

◆ hidSetPalmaUniqueCodeInvalid()

Result hidSetPalmaUniqueCodeInvalid ( HidPalmaConnectionHandle handle )

SetPalmaUniqueCodeInvalid.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in] handle HidPalmaConnectionHandle

◆ hidSetSevenSixAxisSensorFusionStrength()

Result hidSetSevenSixAxisSensorFusionStrength ( float strength )

Sets the SevenSixAxisSensor FusionStrength.

Note: Only available on [5.0.0+].

Parameters

[in] strength Strength

◆ hidSetSixAxisSensorFusionParameters()

Result hidSetSixAxisSensorFusionParameters	(	HidSixAxisSensorHandle	handle,
		float	unk0,
		float	unk1
	)

SetSixAxisSensorFusionParameters.

Parameters

[in]	handle	HidSixAxisSensorHandle
[in]	unk0	Must be 0.0f-1.0f.
[in]	unk1	Unknown

◆ hidSetSupportedNpadIdType()

Result hidSetSupportedNpadIdType	(	const HidNpadIdType *	ids,
		size_t	count
	)

Sets which HidNpadIdType are supported.

Note: This is automatically called with HidNpadIdType_No{1-8} and HidNpadIdType_Handheld when required in hidScanInput.

Parameters

[in]	ids	Input array of HidNpadIdType.
[in]	count	Total entries in the ids array. Must be <=10.

◆ hidSetSupportedNpadStyleSet()

Result hidSetSupportedNpadStyleSet ( u32 style_set )

Sets which controller styles are supported.

Note: This is automatically called with the needed styles in hidScanInput when required.

Parameters

[in] style_set Bitfield of HidNpadStyleTag.

◆ hidSetTouchScreenConfiguration()

Result hidSetTouchScreenConfiguration ( const HidTouchScreenConfigurationForNx * config )

SetTouchScreenConfiguration.

Note: Only available on [9.0.0+].

Parameters

[in] config HidTouchScreenConfigurationForNx

◆ hidStartSevenSixAxisSensor()

Result hidStartSevenSixAxisSensor ( void )

Starts the SevenSixAxisSensor.

Note: Only available on [5.0.0+].

◆ hidStartSixAxisSensor()

Result hidStartSixAxisSensor ( HidSixAxisSensorHandle handle )

Starts the SixAxisSensor for the specified handle.

Parameters

[in] handle HidSixAxisSensorHandle

◆ hidStopSevenSixAxisSensor()

Result hidStopSevenSixAxisSensor ( void )

Stops the SevenSixAxisSensor.

Note: Only available on [5.0.0+].

◆ hidStopSixAxisSensor()

Result hidStopSixAxisSensor ( HidSixAxisSensorHandle handle )

Stops the SixAxisSensor for the specified handle.

Parameters

[in] handle HidSixAxisSensorHandle

◆ hidSuspendPalmaFeature()

Result hidSuspendPalmaFeature	(	HidPalmaConnectionHandle	handle,
		u32	features
	)

SuspendPalmaFeature.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	features	Bitfield of HidPalmaFeature.

◆ hidSwapNpadAssignment()

Result hidSwapNpadAssignment	(	HidNpadIdType	id0,
		HidNpadIdType	id1
	)

SwapNpadAssignment.

Parameters

[in]	id0	HidNpadIdType
[in]	id1	HidNpadIdType

◆ hidWritePalmaActivityEntry()

Result hidWritePalmaActivityEntry	(	HidPalmaConnectionHandle	handle,
		u16	unk,
		const HidPalmaActivityEntry *	entry
	)

WritePalmaActivityEntry.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	unk	Unknown
[in]	entry	HidPalmaActivityEntry

◆ hidWritePalmaApplicationSection()

Result hidWritePalmaApplicationSection	(	HidPalmaConnectionHandle	handle,
		s32	inval0,
		u64	size,
		const HidPalmaApplicationSectionAccessBuffer *	buf
	)

WritePalmaApplicationSection.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	inval0	First input value.
[in]	size	Size of the data in HidPalmaApplicationSectionAccessBuffer.
[in]	buf	HidPalmaApplicationSectionAccessBuffer

◆ hidWritePalmaRgbLedPatternEntry()

Result hidWritePalmaRgbLedPatternEntry	(	HidPalmaConnectionHandle	handle,
		u16	unk,
		const void *	buffer,
		size_t	size
	)

WritePalmaRgbLedPatternEntry.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	unk	Unknown
[in]	buffer	Input buffer.
[in]	size	Input buffer size.

◆ hidWritePalmaWaveEntry()

Result hidWritePalmaWaveEntry	(	HidPalmaConnectionHandle	handle,
		HidPalmaWaveSet	wave_set,
		u16	unk,
		const void *	buffer,
		size_t	tmem_size,
		size_t	size
	)

WritePalmaWaveEntry.

Note: See hidGetPalmaOperationInfo.; Only available on [5.0.0+].

Parameters

[in]	handle	HidPalmaConnectionHandle
[in]	wave_set	HidPalmaWaveSet
[in]	unk	Unknown
[in]	buffer	TransferMemory buffer, must be 0x1000-byte aligned.
[in]	tmem_size	TransferMemory buffer size, must be 0x1000-byte aligned.
[in]	size	Actual size of the data in the buffer.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ HidAppletFooterUiType

◆ HidColorAttribute

◆ HidDebugPadAttribute

◆ HidDebugPadButton

◆ HidDeviceType

◆ HidDeviceTypeBits

◆ HidGestureAttribute

◆ HidGestureDirection

◆ HidGestureType

◆ HidGyroscopeZeroDriftMode

◆ HidKeyboardLockKeyEvent

◆ HidMouseAttribute

◆ HidNpadAttribute

◆ HidNpadButton

◆ HidNpadCommunicationMode

◆ HidNpadHandheldActivationMode

◆ HidNpadIdType

◆ HidNpadInterfaceType

◆ HidNpadJoyAssignmentMode

◆ HidNpadJoyDeviceType

◆ HidNpadJoyHoldType

◆ HidNpadLagerType

◆ HidNpadLarkType

◆ HidNpadLuciaType

◆ HidNpadStyleTag

◆ HidPalmaFeature

◆ HidPalmaFrModeType

◆ HidPalmaOperationType

◆ HidPalmaWaveSet

◆ HidSixAxisSensorAttribute

◆ HidTouchAttribute

◆ HidTouchScreenModeForNx

◆ HidVibrationDevicePosition

◆ HidVibrationDeviceType

◆ HidVibrationGcErmCommand

Function Documentation

◆ hidAcquireNpadStyleSetUpdateEventHandle()

◆ hidAcquirePalmaOperationCompleteEvent()

◆ hidBeginPermitVibrationSession()

◆ hidCancelWritePalmaWaveEntry()

◆ hidClearNpadCaptureButtonAssignment()

◆ hidDisconnectNpad()

◆ hidEnablePalmaBoostMode()

◆ hidEnablePalmaStep()

◆ hidEnableSixAxisSensorFusion()

◆ hidEnableUnintendedHomeButtonInputProtection()

◆ hidEnableUsbFullKeyController()

◆ hidEndPermitVibrationSession()

◆ hidFinalizeSevenSixAxisSensor()

◆ hidGetActualVibrationGcErmCommand()

◆ hidGetActualVibrationValue()

◆ hidGetAppletFooterUiAttributesSet()

◆ hidGetAppletFooterUiTypes()

◆ hidGetGestureStates()

◆ hidGetGyroBias()

◆ hidGetGyroscopeZeroDriftMode()

◆ hidGetKeyboardStates()

◆ hidGetMouseStates()

◆ hidGetNpadCommunicationMode()

◆ hidGetNpadControllerColorSingle()

◆ hidGetNpadControllerColorSplit()

◆ hidGetNpadDeviceType()

◆ hidGetNpadHandheldActivationMode()

◆ hidGetNpadInterfaceType()

◆ hidGetNpadJoyAssignment()

◆ hidGetNpadJoyHoldType()

◆ hidGetNpadLagerType()

◆ hidGetNpadOfHighestBatteryLevel()

◆ hidGetNpadPowerInfoSingle()

◆ hidGetNpadPowerInfoSplit()

◆ hidGetNpadStatesFullKey()

◆ hidGetNpadStatesGc()

◆ hidGetNpadStatesHandheld()