libnx  v4.2.1
Data Structures | Typedefs | Enumerations | Functions
applet.h File Reference

Applet (applet) service IPC wrapper. More...

#include "../types.h"
#include "../sf/service.h"
#include "../services/apm.h"
#include "../services/pdm.h"
#include "../services/caps.h"
#include "../services/pm.h"
#include "../services/ncm_types.h"
#include "../services/acc.h"
#include "../services/set.h"
#include "../kernel/tmem.h"
#include "../kernel/event.h"
#include "../nacp.h"

Go to the source code of this file.

Data Structures

struct  AppletHookCookie
 applet hook cookie. More...
 
struct  AppletLockAccessor
 LockAccessor. More...
 
struct  AppletStorage
 applet IStorage More...
 
struct  AppletHolder
 LibraryApplet state. More...
 
struct  AppletApplication
 IApplicationAccessor container. More...
 
struct  AppletGpuErrorHandler
 GpuErrorHandler. More...
 
struct  AppletAttribute
 Used by appletInitialize with __nx_applet_AppletAttribute for cmd OpenLibraryAppletProxy (AppletType_LibraryApplet), on [3.0.0+]. The default for this struct is all-zero. More...
 
struct  LibAppletInfo
 LibraryAppletInfo. More...
 
struct  AppletProcessLaunchReason
 AppletProcessLaunchReason, from GetLaunchReason. More...
 
struct  AppletInfo
 Cached info for the current LibraryApplet, from appletGetAppletInfo. More...
 
struct  AppletIdentityInfo
 IdentityInfo. More...
 
struct  AppletApplicationAttributeForQuest
 Attributes for launching applications for Quest. More...
 
struct  AppletApplicationAttribute
 ApplicationAttribute. More...
 
struct  AppletApplicationLaunchProperty
 ApplicationLaunchProperty. More...
 
struct  AppletApplicationLaunchRequestInfo
 ApplicationLaunchRequestInfo. More...
 
struct  AppletResourceUsageInfo
 AppletResourceUsageInfo, from appletGetAppletResourceUsageInfo. More...
 

Typedefs

typedef void(* AppletHookFn) (AppletHookType hook, void *param)
 applet hook function.
 

Enumerations

enum  AppletType {
  AppletType_None = -2,
  AppletType_Default = -1,
  AppletType_Application = 0,
  AppletType_SystemApplet = 1,
  AppletType_LibraryApplet = 2,
  AppletType_OverlayApplet = 3,
  AppletType_SystemApplication = 4
}
 AppletType.
 
enum  AppletOperationMode {
  AppletOperationMode_Handheld = 0,
  AppletOperationMode_Console = 1
}
 OperationMode. More...
 
enum  AppletHookType {
  AppletHookType_OnFocusState = 0,
  AppletHookType_OnOperationMode,
  AppletHookType_OnPerformanceMode,
  AppletHookType_OnExitRequest,
  AppletHookType_OnResume,
  AppletHookType_OnCaptureButtonShortPressed,
  AppletHookType_OnAlbumScreenShotTaken,
  AppletHookType_RequestToDisplay,
  AppletHookType_Max
}
 applet hook types. More...
 
enum  AppletMessage {
  AppletMessage_ExitRequest = 4,
  AppletMessage_FocusStateChanged = 15,
  AppletMessage_Resume = 16,
  AppletMessage_OperationModeChanged = 30,
  AppletMessage_PerformanceModeChanged = 31,
  AppletMessage_RequestToDisplay = 51,
  AppletMessage_CaptureButtonShortPressed = 90,
  AppletMessage_AlbumScreenShotTaken = 92,
  AppletMessage_AlbumRecordingSaved = 93
}
 AppletMessage, for appletGetMessage. See also AppletHookType. More...
 
enum  AppletFocusState {
  AppletFocusState_InFocus = 1,
  AppletFocusState_OutOfFocus = 2,
  AppletFocusState_Background = 3
}
 FocusState. More...
 
enum  AppletFocusHandlingMode {
  AppletFocusHandlingMode_SuspendHomeSleep = 0,
  AppletFocusHandlingMode_NoSuspend,
  AppletFocusHandlingMode_SuspendHomeSleepNotify,
  AppletFocusHandlingMode_AlwaysSuspend,
  AppletFocusHandlingMode_Max
}
 FocusHandlingMode. More...
 
enum  AppletLaunchParameterKind {
  AppletLaunchParameterKind_UserChannel = 1,
  AppletLaunchParameterKind_PreselectedUser = 2,
  AppletLaunchParameterKind_Unknown = 3
}
 LaunchParameterKind. More...
 
enum  AppletId {
  AppletId_None = 0x00,
  AppletId_application = 0x01,
  AppletId_OverlayApplet = 0x02,
  AppletId_SystemAppletMenu = 0x03,
  AppletId_SystemApplication = 0x04,
  AppletId_LibraryAppletAuth = 0x0A,
  AppletId_LibraryAppletCabinet = 0x0B,
  AppletId_LibraryAppletController = 0x0C,
  AppletId_LibraryAppletDataErase = 0x0D,
  AppletId_LibraryAppletError = 0x0E,
  AppletId_LibraryAppletNetConnect = 0x0F,
  AppletId_LibraryAppletPlayerSelect = 0x10,
  AppletId_LibraryAppletSwkbd = 0x11,
  AppletId_LibraryAppletMiiEdit = 0x12,
  AppletId_LibraryAppletWeb = 0x13,
  AppletId_LibraryAppletShop = 0x14,
  AppletId_LibraryAppletPhotoViewer = 0x15,
  AppletId_LibraryAppletSet = 0x16,
  AppletId_LibraryAppletOfflineWeb = 0x17,
  AppletId_LibraryAppletLoginShare = 0x18,
  AppletId_LibraryAppletWifiWebAuth = 0x19,
  AppletId_LibraryAppletMyPage = 0x1A
}
 AppletId. More...
 
enum  LibAppletMode {
  LibAppletMode_AllForeground = 0,
  LibAppletMode_Background = 1,
  LibAppletMode_NoUi = 2,
  LibAppletMode_BackgroundIndirect = 3,
  LibAppletMode_AllForegroundInitiallyHidden = 4
}
 LibraryAppletMode. More...
 
enum  LibAppletExitReason {
  LibAppletExitReason_Normal = 0,
  LibAppletExitReason_Canceled = 1,
  LibAppletExitReason_Abnormal = 2,
  LibAppletExitReason_Unexpected = 10
}
 LibraryAppletExitReason.
 
enum  AppletApplicationExitReason {
  AppletApplicationExitReason_Normal = 0,
  AppletApplicationExitReason_Unknown1 = 1,
  AppletApplicationExitReason_Unknown2 = 2,
  AppletApplicationExitReason_Unknown3 = 3,
  AppletApplicationExitReason_Unknown4 = 4,
  AppletApplicationExitReason_Unknown5 = 5,
  AppletApplicationExitReason_Unexpected = 100
}
 AppletApplicationExitReason.
 
enum  AppletThemeColorType {
  AppletThemeColorType_Default = 0,
  AppletThemeColorType_Unknown1 = 1,
  AppletThemeColorType_Unknown2 = 2,
  AppletThemeColorType_Unknown3 = 3
}
 ThemeColorType.
 
enum  AppletTvPowerStateMatchingMode {
  AppletTvPowerStateMatchingMode_Unknown0 = 0,
  AppletTvPowerStateMatchingMode_Unknown1 = 1
}
 Mode values for appletSetTvPowerStateMatchingMode. More...
 
enum  AppletSystemButtonType {
  AppletSystemButtonType_HomeButtonShortPressing = 1,
  AppletSystemButtonType_HomeButtonLongPressing = 2,
  AppletSystemButtonType_PowerButtonShortPressing = 3,
  AppletSystemButtonType_PowerButtonLongPressing = 4,
  AppletSystemButtonType_Shutdown = 5,
  AppletSystemButtonType_CaptureButtonShortPressing = 6,
  AppletSystemButtonType_CaptureButtonLongPressing = 7
}
 Type values for appletPerformSystemButtonPressingIfInFocus. More...
 
enum  AppletScreenShotPermission {
  AppletScreenShotPermission_Inherit = 0,
  AppletScreenShotPermission_Enable = 1,
  AppletScreenShotPermission_Disable = 2
}
 Permission values for appletSetScreenShotPermission. More...
 
enum  AppletIdleTimeDetectionExtension {
  AppletIdleTimeDetectionExtension_None = 0,
  AppletIdleTimeDetectionExtension_Extended = 1,
  AppletIdleTimeDetectionExtension_ExtendedUnsafe = 2
}
 Extension values for appletSetIdleTimeDetectionExtension / appletGetIdleTimeDetectionExtension, for extending user inactivity detection. More...
 
enum  AppletInputDetectionPolicy {
  AppletInputDetectionPolicy_Unknown0 = 0,
  AppletInputDetectionPolicy_Unknown1 = 1
}
 Input policy values for appletSetInputDetectionPolicy. More...
 
enum  AppletWirelessPriorityMode {
  AppletWirelessPriorityMode_Default = 1,
  AppletWirelessPriorityMode_OptimizedForWlan = 2
}
 Input mode values for appletSetWirelessPriorityMode. More...
 
enum  AppletCaptureSharedBuffer {
  AppletCaptureSharedBuffer_LastApplication = 0,
  AppletCaptureSharedBuffer_LastForeground = 1,
  AppletCaptureSharedBuffer_CallerApplet = 2
}
 CaptureSharedBuffer for the IDisplayController commands. More...
 
enum  AppletWindowOriginMode {
  AppletWindowOriginMode_LowerLeft = 0,
  AppletWindowOriginMode_UpperLeft = 1
}
 WindowOriginMode. More...
 
enum  AppletProgramSpecifyKind {
  AppletProgramSpecifyKind_ExecuteProgram = 0,
  AppletProgramSpecifyKind_JumpToSubApplicationProgramForDevelopment = 1,
  AppletProgramSpecifyKind_RestartProgram = 2
}
 ProgramSpecifyKind for the ExecuteProgram cmd. Controls the type of the u64 passed to the ExecuteProgram cmd. More...
 

Functions

Result appletInitialize (void)
 Initialize applet, called automatically during app startup.
 
void appletExit (void)
 Exit applet, called automatically during app exit.
 
ServiceappletGetServiceSession_Proxy (void)
 Gets the Service object for the actual "appletOE"/"appletAE" service session.
 
ServiceappletGetServiceSession_AppletCommonFunctions (void)
 Gets the Service object for IAppletCommonFunctions. Only initialized with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [7.0.0+].
 
ServiceappletGetServiceSession_Functions (void)
 Gets the Service object for I*Functions, specific to each AppletType (IApplicationFunctions for AppletType_*Application). Not initialized with AppletType_LibraryApplet.
 
ServiceappletGetServiceSession_GlobalStateController (void)
 Gets the Service object for IGlobalStateController. Only initialized with AppletType_SystemApplet.
 
ServiceappletGetServiceSession_ApplicationCreator (void)
 Gets the Service object for IApplicationCreator. Only initialized with AppletType_SystemApplet.
 
ServiceappletGetServiceSession_LibraryAppletSelfAccessor (void)
 Gets the Service object for ILibraryAppletSelfAccessor. Only initialized with AppletType_LibraryApplet.
 
ServiceappletGetServiceSession_ProcessWindingController (void)
 Gets the Service object for IProcessWindingController. Only initialized with AppletType_LibraryApplet.
 
ServiceappletGetServiceSession_LibraryAppletCreator (void)
 Gets the Service object for ILibraryAppletCreator.
 
ServiceappletGetServiceSession_CommonStateGetter (void)
 Gets the Service object for ICommonStateGetter.
 
ServiceappletGetServiceSession_SelfController (void)
 Gets the Service object for ISelfController.
 
ServiceappletGetServiceSession_WindowController (void)
 Gets the Service object for IWindowController.
 
ServiceappletGetServiceSession_AudioController (void)
 Gets the Service object for IAudioController.
 
ServiceappletGetServiceSession_DisplayController (void)
 Gets the Service object for IDisplayController.
 
ServiceappletGetServiceSession_DebugFunctions (void)
 Gets the Service object for IDebugFunctions.
 
u64 appletGetAppletResourceUserId (void)
 Get the cached AppletResourceUserId.
 
AppletType appletGetAppletType (void)
 Get the AppletType.
 
void appletSetThemeColorType (AppletThemeColorType theme)
 Sets the state field for AppletThemeColorType.
 
AppletThemeColorType appletGetThemeColorType (void)
 Gets the state field for AppletThemeColorType. Used internally by libappletArgsCreate.
 
ICommonStateGetter
Result appletGetCradleStatus (u8 *status)
 Gets the CradleStatus. More...
 
Result appletGetBootMode (PmBootMode *mode)
 Gets the BootMode which originated from pmbmGetBootMode. More...
 
Result appletRequestToAcquireSleepLock (void)
 Request to AcquireSleepLock. More...
 
Result appletReleaseSleepLock (void)
 Release the SleepLock.
 
Result appletReleaseSleepLockTransiently (void)
 Release the SleepLock transiently. More...
 
Result appletGetWakeupCount (u64 *out)
 GetWakeupCount. More...
 
Result appletPushToGeneralChannel (AppletStorage *s)
 Pushes a storage to the general channel. More...
 
Result appletGetHomeButtonReaderLockAccessor (AppletLockAccessor *a)
 Gets a AppletLockAccessor for HomeButtonReader. More...
 
Result appletGetReaderLockAccessorEx (AppletLockAccessor *a, u32 inval)
 Gets a Reader AppletLockAccessor. More...
 
Result appletGetWriterLockAccessorEx (AppletLockAccessor *a, u32 inval)
 Gets a Writer AppletLockAccessor. More...
 
Result appletGetCradleFwVersion (u32 *out0, u32 *out1, u32 *out2, u32 *out3)
 Gets the Dock firmware version. More...
 
Result appletIsVrModeEnabled (bool *out)
 Gets whether VrMode is enabled. More...
 
Result appletSetVrModeEnabled (bool flag)
 Sets whether VrMode is enabled. More...
 
Result appletSetLcdBacklightOffEnabled (bool flag)
 Sets whether the LCD screen backlight is turned off. More...
 
Result appletIsInControllerFirmwareUpdateSection (bool *out)
 Gets the ControllerFirmwareUpdateSection flag. More...
 
Result appletSetVrPositionForDebug (s32 x, s32 y, s32 width, s32 height)
 SetVrPositionForDebug. More...
 
Result appletGetDefaultDisplayResolution (s32 *width, s32 *height)
 Gets the DefaultDisplayResolution. More...
 
Result appletGetDefaultDisplayResolutionChangeEvent (Event *out_event)
 Gets an Event which is signaled when the output from appletGetDefaultDisplayResolution changes. More...
 
Result appletGetHdcpAuthenticationState (s32 *state)
 Gets the HdcpAuthenticationState. More...
 
Result appletGetHdcpAuthenticationStateChangeEvent (Event *out_event)
 Gets an Event which is signaled when the output from appletGetHdcpAuthenticationState changes. More...
 
Result appletSetTvPowerStateMatchingMode (AppletTvPowerStateMatchingMode mode)
 Sets the AppletTvPowerStateMatchingMode. More...
 
Result appletGetApplicationIdByContentActionName (u64 *application_id, const char *name)
 Gets the ApplicationId for the specified ContentActionName string. More...
 
Result appletSetCpuBoostMode (ApmCpuBoostMode mode)
 Sets the ApmCpuBoostMode. More...
 
Result appletCancelCpuBoostMode (void)
 CancelCpuBoostMode. More...
 
Result appletGetBuiltInDisplayType (s32 *out)
 GetBuiltInDisplayType. More...
 
Result appletPerformSystemButtonPressingIfInFocus (AppletSystemButtonType type)
 Perform SystemButtonPressing with the specified AppletSystemButtonType. More...
 
Result appletSetPerformanceConfigurationChangedNotification (bool flag)
 Sets whether PerformanceConfigurationChangedNotification is enabled. More...
 
Result appletGetCurrentPerformanceConfiguration (u32 *PerformanceConfiguration)
 Gets the current PerformanceConfiguration. More...
 
Result appletOpenMyGpuErrorHandler (AppletGpuErrorHandler *g)
 Opens an AppletGpuErrorHandler. More...
 
Result appletGetOperationModeSystemInfo (u32 *info)
 Gets the OperationModeSystemInfo. More...
 
Result appletGetSettingsPlatformRegion (SetSysPlatformRegion *out)
 This uses setsysGetPlatformRegion internally. More...
 
Result appletActivateMigrationService (void)
 ActivateMigrationService. More...
 
Result appletDeactivateMigrationService (void)
 DeactivateMigrationService. More...
 
Result appletDisableSleepTillShutdown (void)
 DisableSleepTillShutdown. More...
 
Result appletSuppressDisablingSleepTemporarily (u64 val)
 SuppressDisablingSleepTemporarily. More...
 
Result appletSetRequestExitToLibraryAppletAtExecuteNextProgramEnabled (void)
 SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled. More...
 
IGpuErrorHandler
void appletGpuErrorHandlerClose (AppletGpuErrorHandler *g)
 Close an AppletGpuErrorHandler. More...
 
Result appletGpuErrorHandlerGetManualGpuErrorInfoSize (AppletGpuErrorHandler *g, u64 *out)
 Gets the size of the info available with appletGpuErrorHandlerGetManualGpuErrorInfo. More...
 
Result appletGpuErrorHandlerGetManualGpuErrorInfo (AppletGpuErrorHandler *g, void *buffer, size_t size, u64 *out)
 GetManualGpuErrorInfo. More...
 
Result appletGpuErrorHandlerGetManualGpuErrorDetectionSystemEvent (AppletGpuErrorHandler *g, Event *out_event)
 GetManualGpuErrorDetectionSystemEvent. More...
 
Result appletGpuErrorHandlerFinishManualGpuErrorHandling (AppletGpuErrorHandler *g)
 FinishManualGpuErrorHandling. More...
 
ISelfController
Result appletLockExit (void)
 Delay exiting until appletUnlockExit is called, with a 15 second timeout once exit is requested. More...
 
Result appletUnlockExit (void)
 Unlocks exiting, see appletLockExit.
 
Result appletEnterFatalSection (void)
 Enter FatalSection.
 
Result appletLeaveFatalSection (void)
 Leave FatalSection.
 
Result appletSetScreenShotPermission (AppletScreenShotPermission permission)
 Controls whether screenshot-capture is allowed. More...
 
Result appletSetRestartMessageEnabled (bool flag)
 Sets whether AppletMessage_Resume is enabled. More...
 
Result appletSetScreenShotAppletIdentityInfo (AppletIdentityInfo *info)
 Sets the AppletIdentityInfo for screenshots. More...
 
Result appletSetControllerFirmwareUpdateSection (bool flag)
 Sets ControllerFirmwareUpdateSection. More...
 
Result appletSetRequiresCaptureButtonShortPressedMessage (bool flag)
 Sets whether AppletMessage_CaptureButtonShortPressed is enabled. More...
 
Result appletSetAlbumImageOrientation (AlbumImageOrientation orientation)
 Sets the Album screenshot ImageOrientation. More...
 
Result appletSetDesirableKeyboardLayout (SetKeyboardLayout layout)
 Sets the DesirableKeyboardLayout. More...
 
Result appletCreateManagedDisplayLayer (u64 *out)
 
Result appletIsSystemBufferSharingEnabled (void)
 Checks whether SystemBufferSharing is enabled, throwing an error otherwise. More...
 
Result appletGetSystemSharedLayerHandle (u64 *SharedBufferHandle, u64 *SharedLayerHandle)
 Gets the System SharedBufferHandle and SharedLayerHandle. More...
 
Result appletGetSystemSharedBufferHandle (u64 *SharedBufferHandle)
 Same as appletGetSystemSharedLayerHandle except this just gets the SharedBufferHandle. More...
 
Result appletCreateManagedDisplaySeparableLayer (u64 *display_layer, u64 *recording_layer)
 CreateManagedDisplaySeparableLayer. More...
 
Result appletSetManagedDisplayLayerSeparationMode (u32 mode)
 SetManagedDisplayLayerSeparationMode. More...
 
Result appletSetHandlesRequestToDisplay (bool flag)
 Sets whether AppletMessage_RequestToDisplay is enabled. More...
 
Result appletApproveToDisplay (void)
 Approve the display requested by AppletMessage_RequestToDisplay, see also appletSetHandlesRequestToDisplay.
 
Result appletOverrideAutoSleepTimeAndDimmingTime (s32 inval0, s32 inval1, s32 inval2, s32 inval3)
 OverrideAutoSleepTimeAndDimmingTime. More...
 
Result appletSetIdleTimeDetectionExtension (AppletIdleTimeDetectionExtension ext)
 Sets the IdleTimeDetectionExtension. More...
 
Result appletGetIdleTimeDetectionExtension (AppletIdleTimeDetectionExtension *ext)
 Gets the value set by appletSetIdleTimeDetectionExtension. More...
 
Result appletSetInputDetectionSourceSet (u32 val)
 Sets the InputDetectionSourceSet. More...
 
Result appletReportUserIsActive (void)
 Reports that the user is active, for idle detection (screen dimming / auto-sleep). More...
 
Result appletGetCurrentIlluminance (float *fLux)
 Gets the current Illuminance from the light sensor. More...
 
Result appletIsIlluminanceAvailable (bool *out)
 Gets whether Illuminance is available. More...
 
Result appletSetAutoSleepDisabled (bool flag)
 Sets AutoSleepDisabled. More...
 
Result appletIsAutoSleepDisabled (bool *out)
 Gets AutoSleepDisabled. More...
 
Result appletGetCurrentIlluminanceEx (bool *bOverLimit, float *fLux)
 Gets the current Illuminance from the light sensor. More...
 
Result appletSetInputDetectionPolicy (AppletInputDetectionPolicy policy)
 Sets the AppletInputDetectionPolicy. More...
 
Result appletSetWirelessPriorityMode (AppletWirelessPriorityMode mode)
 Sets the WirelessPriorityMode. More...
 
Result appletGetProgramTotalActiveTime (u64 *activeTime)
 Gets the total time in nanoseconds that the current process was actively running (not suspended), relative to when appletInitialize was last used. More...
 
Result appletSetAlbumImageTakenNotificationEnabled (bool flag)
 Sets whether AppletMessage_AlbumScreenShotTaken is enabled. More...
 
Result appletSetApplicationAlbumUserData (const void *buffer, size_t size)
 Sets the Application AlbumUserData. More...
 
Result appletSaveCurrentScreenshot (AlbumReportOption option)
 SaveCurrentScreenshot. More...
 
IWindowController
Result appletGetAppletResourceUserIdOfCallerApplet (u64 *out)
 Gets the AppletResourceUserId of the CallerApplet. More...
 
Result appletSetAppletWindowVisibility (bool flag)
 Sets the current applet WindowVisibility. More...
 
Result appletSetAppletGpuTimeSlice (s64 val)
 Sets the AppletGpuTimeSlice. More...
 
IAudioController
Result appletSetExpectedMasterVolume (float mainAppletVolume, float libraryAppletVolume)
 Sets the ExpectedMasterVolume for MainApplet and LibraryApplet. More...
 
Result appletGetExpectedMasterVolume (float *mainAppletVolume, float *libraryAppletVolume)
 Gets the ExpectedMasterVolume for MainApplet and LibraryApplet. More...
 
Result appletChangeMainAppletMasterVolume (float volume, u64 unk)
 Change the MainApplet MasterVolume. More...
 
Result appletSetTransparentVolumeRate (float val)
 Sets the TransparentVolumeRate. More...
 
IDisplayController
Result appletUpdateLastForegroundCaptureImage (void)
 Update the LastForeground CaptureImage.
 
Result appletUpdateCallerAppletCaptureImage (void)
 Update the CallerApplet CaptureImage.
 
Result appletGetLastForegroundCaptureImageEx (void *buffer, size_t size, bool *flag)
 Gets the LastForeground CaptureImage. More...
 
Result appletGetLastApplicationCaptureImageEx (void *buffer, size_t size, bool *flag)
 Gets the LastApplication CaptureImage. More...
 
Result appletGetCallerAppletCaptureImageEx (void *buffer, size_t size, bool *flag)
 Gets the CallerApplet CaptureImage. More...
 
Result appletTakeScreenShotOfOwnLayer (bool flag, AppletCaptureSharedBuffer captureBuf)
 Takes a screenshot of the current applet Layer into the specified CaptureSharedBuffer. More...
 
Result appletCopyBetweenCaptureBuffers (AppletCaptureSharedBuffer dstCaptureBuf, AppletCaptureSharedBuffer srcCaptureBuf)
 Copies image data from a CaptureSharedBuffer to another CaptureSharedBuffer. More...
 
Result appletClearCaptureBuffer (bool flag, AppletCaptureSharedBuffer captureBuf, u32 color)
 Clear the input CaptureSharedBuffer with the specified color. More...
 
Result appletClearAppletTransitionBuffer (u32 color)
 Clear the AppletTransitionBuffer with the specified color. More...
 
Result appletAcquireLastApplicationCaptureSharedBuffer (bool *flag, s32 *id)
 Acquire the LastApplication CaptureSharedBuffer. More...
 
Result appletReleaseLastApplicationCaptureSharedBuffer (void)
 Release the LastApplication CaptureSharedBuffer. More...
 
Result appletAcquireLastForegroundCaptureSharedBuffer (bool *flag, s32 *id)
 Acquire the LastForeground CaptureSharedBuffer. More...
 
Result appletReleaseLastForegroundCaptureSharedBuffer (void)
 Release the LastForeground CaptureSharedBuffer. More...
 
Result appletAcquireCallerAppletCaptureSharedBuffer (bool *flag, s32 *id)
 Acquire the CallerApplet CaptureSharedBuffer. More...
 
Result appletReleaseCallerAppletCaptureSharedBuffer (void)
 Release the CallerApplet CaptureSharedBuffer. More...
 
Result appletTakeScreenShotOfOwnLayerEx (bool flag0, bool immediately, AppletCaptureSharedBuffer captureBuf)
 Takes a screenshot of the current applet Layer into the specified CaptureSharedBuffer. More...
 
IProcessWindingController
Result appletPushContext (AppletStorage *s)
 Pushes a storage to the ContextStack. More...
 
Result appletPopContext (AppletStorage *s)
 Pops a storage from the ContextStack. More...
 
void appletLockAccessorClose (AppletLockAccessor *a)
 Closes a LockAccessor. More...
 
Result appletLockAccessorTryLock (AppletLockAccessor *a, bool *flag)
 TryLock a LockAccessor. More...
 
Result appletLockAccessorLock (AppletLockAccessor *a)
 Lock a LockAccessor. More...
 
Result appletLockAccessorUnlock (AppletLockAccessor *a)
 Unlock a LockAccessor. More...
 
ILibraryAppletCreator
Result appletCreateLibraryApplet (AppletHolder *h, AppletId id, LibAppletMode mode)
 Creates a LibraryApplet. More...
 
Result appletCreateLibraryAppletSelf (AppletHolder *h, AppletId id, LibAppletMode mode)
 Creates a LibraryApplet. More...
 
Result appletTerminateAllLibraryApplets (void)
 TerminateAllLibraryApplets which were created by the current applet. More...
 
Result appletAreAnyLibraryAppletsLeft (bool *out)
 AreAnyLibraryAppletsLeft which were created by the current applet. More...
 
ILibraryAppletAccessor
void appletHolderClose (AppletHolder *h)
 Closes an AppletHolder object.
 
bool appletHolderActive (AppletHolder *h)
 Returns whether the AppletHolder object was initialized.
 
Result appletHolderGetIndirectLayerConsumerHandle (AppletHolder *h, u64 *out)
 Gets the IndirectLayerConsumerHandle loaded during appletCreateLibraryApplet, on [2.0.0+]. More...
 
Result appletHolderStart (AppletHolder *h)
 Starts the LibraryApplet. More...
 
Result appletHolderJump (AppletHolder *h)
 Jumps to the LibraryApplet, with the current-LibraryApplet being terminated. More...
 
Result appletHolderRequestExit (AppletHolder *h)
 Requests the LibraryApplet to exit. More...
 
Result appletHolderTerminate (AppletHolder *h)
 Terminate the LibraryApplet. More...
 
Result appletHolderRequestExitOrTerminate (AppletHolder *h, u64 timeout)
 Uses cmds GetAppletStateChangedEvent and RequestExit, then waits for the LibraryApplet to exit with the specified timeout. More...
 
void appletHolderJoin (AppletHolder *h)
 Waits for the LibraryApplet to exit. More...
 
static EventappletHolderGetExitEvent (AppletHolder *h)
 Gets the LibraryApplet StateChangedEvent. More...
 
bool appletHolderCheckFinished (AppletHolder *h)
 Waits on the LibraryApplet StateChangedEvent with timeout=0, and returns whether it was successful. More...
 
LibAppletExitReason appletHolderGetExitReason (AppletHolder *h)
 Gets the LibAppletExitReason set by appletHolderJoin. More...
 
Result appletHolderSetOutOfFocusApplicationSuspendingEnabled (AppletHolder *h, bool flag)
 Sets OutOfFocusApplicationSuspendingEnabled. More...
 
Result appletHolderPresetLibraryAppletGpuTimeSliceZero (AppletHolder *h)
 PresetLibraryAppletGpuTimeSliceZero. More...
 
Result appletHolderGetPopInteractiveOutDataEvent (AppletHolder *h, Event **out_event)
 Gets the PopInteractiveOutDataEvent. More...
 
bool appletHolderWaitInteractiveOut (AppletHolder *h)
 Waits for the PopInteractiveOutDataEvent and StateChangedEvent. More...
 
Result appletHolderPushInData (AppletHolder *h, AppletStorage *s)
 Pushes a storage for LibraryApplet input. More...
 
Result appletHolderPopOutData (AppletHolder *h, AppletStorage *s)
 Pops a storage from LibraryApplet output. More...
 
Result appletHolderPushExtraStorage (AppletHolder *h, AppletStorage *s)
 Pushes a storage for LibraryApplet Extra storage input. More...
 
Result appletHolderPushInteractiveInData (AppletHolder *h, AppletStorage *s)
 Pushes a storage for LibraryApplet Interactive input. More...
 
Result appletHolderPopInteractiveOutData (AppletHolder *h, AppletStorage *s)
 Pops a storage from LibraryApplet Interactive output. More...
 
Result appletHolderGetLibraryAppletInfo (AppletHolder *h, LibAppletInfo *info)
 Gets the LibAppletInfo for the specified LibraryApplet. More...
 
(ILibraryAppletCreator ->) IStorage
Result appletCreateStorage (AppletStorage *s, s64 size)
 Creates a storage. More...
 
Result appletCreateTransferMemoryStorage (AppletStorage *s, void *buffer, s64 size, bool writable)
 Creates a TransferMemory storage. More...
 
Result appletCreateHandleStorage (AppletStorage *s, s64 inval, Handle handle)
 Creates a HandleStorage. More...
 
Result appletCreateHandleStorageTmem (AppletStorage *s, void *buffer, s64 size)
 Creates a HandleStorage using TransferMemory. More...
 
void appletStorageClose (AppletStorage *s)
 Closes the storage object. More...
 
void appletStorageCloseTmem (AppletStorage *s)
 Closes the TransferMemory in the storage object. For TransferMemory storage created by the current process, this must be called after the LibraryApplet finishes using it (if sent to one).
 
Result appletStorageGetSize (AppletStorage *s, s64 *size)
 Gets the size of the storage. This is not usable with HandleStorage, use appletStorageGetHandle or appletStorageMap instead for that.
 
Result appletStorageWrite (AppletStorage *s, s64 offset, const void *buffer, size_t size)
 Writes to a storage. More...
 
Result appletStorageRead (AppletStorage *s, s64 offset, void *buffer, size_t size)
 Reads from a storage. More...
 
Result appletStorageGetHandle (AppletStorage *s, s64 *out, Handle *handle)
 Gets data for a HandleStorage originally from appletCreateHandleStorage input. More...
 
Result appletStorageMap (AppletStorage *s, void **addr, size_t *size)
 Maps TransferMemory for a HandleStorage. More...
 
IApplicationFunctions: IFunctions for AppletType_*Application.
Result appletPopLaunchParameter (AppletStorage *s, AppletLaunchParameterKind kind)
 Pops a LaunchParameter AppletStorage, the storage will be removed from sysmodule state during this. More...
 
Result appletRequestLaunchApplication (u64 application_id, AppletStorage *s)
 Requests to launch the specified application. More...
 
Result appletRequestLaunchApplicationForQuest (u64 application_id, AppletStorage *s, const AppletApplicationAttributeForQuest *attr)
 Requests to launch the specified application, for kiosk systems. More...
 
Result appletGetDesiredLanguage (u64 *LanguageCode)
 Gets the DesiredLanguage for the current host application control.nacp. More...
 
Result appletGetDisplayVersion (char *displayVersion)
 Gets the DisplayVersion for the current host application control.nacp. More...
 
Result appletBeginBlockingHomeButtonShortAndLongPressed (s64 val)
 Blocks the usage of the home button, for short (Home Menu) and long (Overlay) presses. More...
 
Result appletEndBlockingHomeButtonShortAndLongPressed (void)
 Ends the blocking started by appletBeginBlockingHomeButtonShortAndLongPressed. More...
 
Result appletBeginBlockingHomeButton (s64 val)
 Blocks the usage of the home button, for short presses (Home Menu). More...
 
Result appletEndBlockingHomeButton (void)
 Ends the blocking started by appletBeginBlockingHomeButton. More...
 
void appletNotifyRunning (bool *out)
 Notify that the app is now running, for the Application logo screen. More...
 
Result appletGetPseudoDeviceId (Uuid *out)
 Gets the PseudoDeviceId. More...
 
Result appletSetMediaPlaybackState (bool state)
 Set media playback state. More...
 
Result appletIsGamePlayRecordingSupported (bool *flag)
 Gets whether video recording is supported. More...
 
Result appletSetGamePlayRecordingState (bool state)
 Disable/enable video recording. More...
 
Result appletInitializeGamePlayRecording (void)
 Initializes video recording. More...
 
Result appletRequestFlushGamePlayingMovieForDebug (void)
 Requests to save the video recording, as if the Capture-button was held. More...
 
Result appletRequestToShutdown (void)
 Requests a system shutdown. More...
 
Result appletRequestToReboot (void)
 Requests a system reboot. More...
 
Result appletRequestToSleep (void)
 RequestToSleep. More...
 
Result appletExitAndRequestToShowThanksMessage (void)
 Exit the application and return to the kiosk demo menu. More...
 
Result appletInitializeApplicationCopyrightFrameBuffer (void)
 Initializes the ApplicationCopyrightFrameBuffer, with dimensions 1280x720 + the tmem for it. More...
 
Result appletSetApplicationCopyrightImage (const void *buffer, size_t size, s32 x, s32 y, s32 width, s32 height, AppletWindowOriginMode mode)
 Sets the RGBA8 image for use with appletInitializeApplicationCopyrightFrameBuffer. More...
 
Result appletSetApplicationCopyrightVisibility (bool visible)
 Sets the visibility for the image set by appletSetApplicationCopyrightImage, in screenshots. More...
 
Result appletQueryApplicationPlayStatistics (PdmApplicationPlayStatistics *stats, const u64 *application_ids, s32 count, s32 *total_out)
 Gets ApplicationPlayStatistics. More...
 
Result appletQueryApplicationPlayStatisticsByUid (AccountUid uid, PdmApplicationPlayStatistics *stats, const u64 *application_ids, s32 count, s32 *total_out)
 Same as appletQueryApplicationPlayStatistics except this gets playstats specific to the input userId. More...
 
Result appletExecuteProgram (s32 programIndex, const void *buffer, size_t size)
 Launches Application {current_ApplicationId}+programIndex. More...
 
Result appletJumpToSubApplicationProgramForDevelopment (u64 application_id, const void *buffer, size_t size)
 Launches the specified ApplicationId. More...
 
Result appletRestartProgram (const void *buffer, size_t size)
 Relaunches the current Application. More...
 
Result appletGetPreviousProgramIndex (s32 *programIndex)
 Gets the ProgramIndex of the program which launched this program. More...
 
Result appletSetDelayTimeToAbortOnGpuError (u64 val)
 SetDelayTimeToAbortOnGpuError. More...
 
Result appletGetFriendInvitationStorageChannelEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletTryPopFromFriendInvitationStorageChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletTryPopFromFriendInvitationStorageChannel (AppletStorage *s)
 Pops a storage from the FriendInvitation StorageChannel. More...
 
Result appletGetNotificationStorageChannelEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletTryPopFromNotificationStorageChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletTryPopFromNotificationStorageChannel (AppletStorage *s)
 Pops a storage from the Notification StorageChannel. More...
 
Result appletGetHealthWarningDisappearedSystemEvent (Event *out_event)
 GetHealthWarningDisappearedSystemEvent. More...
 
Result appletSetHdcpAuthenticationActivated (bool flag)
 SetHdcpAuthenticationActivated. More...
 
Result appletGetLastApplicationExitReason (s32 *out)
 GetLastApplicationExitReason. More...
 
Result appletCreateMovieMaker (Service *srv_out, TransferMemory *tmem)
 CreateMovieMaker. More...
 
Result appletPrepareForJit (void)
 Launches the jit-sysmodule when it was not previously launched by this cmd. More...
 
IHomeMenuFunctions: IFunctions for AppletType_SystemApplet.
Result appletRequestToGetForeground (void)
 RequestToGetForeground. More...
 
Result appletLockForeground (void)
 LockForeground. More...
 
Result appletUnlockForeground (void)
 UnlockForeground. More...
 
Result appletPopFromGeneralChannel (AppletStorage *s)
 Pops a storage from the general channel. More...
 
Result appletGetPopFromGeneralChannelEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletPopFromGeneralChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletGetHomeButtonWriterLockAccessor (AppletLockAccessor *a)
 Gets a AppletLockAccessor for HomeButtonWriter. More...
 
Result appletIsSleepEnabled (bool *out)
 IsSleepEnabled. More...
 
Result appletPopRequestLaunchApplicationForDebug (AccountUid *uids, s32 count, u64 *application_id, s32 *total_out)
 PopRequestLaunchApplicationForDebug. More...
 
Result appletIsForceTerminateApplicationDisabledForDebug (bool *out)
 IsForceTerminateApplicationDisabledForDebug. More...
 
Result appletLaunchDevMenu (void)
 Launches DevMenu and the dev Overlay-applet. More...
 
Result appletSetLastApplicationExitReason (s32 reason)
 SetLastApplicationExitReason. More...
 
IGlobalStateController
Result appletStartSleepSequence (bool flag)
 Start the sequence for entering sleep-mode. More...
 
Result appletStartShutdownSequence (void)
 Start the system-shutdown sequence. More...
 
Result appletStartRebootSequence (void)
 Start the system-reboot sequence. More...
 
Result appletIsAutoPowerDownRequested (bool *out)
 IsAutoPowerDownRequested. More...
 
Result appletLoadAndApplyIdlePolicySettings (void)
 LoadAndApplyIdlePolicySettings. More...
 
Result appletNotifyCecSettingsChanged (void)
 NotifyCecSettingsChanged. More...
 
Result appletSetDefaultHomeButtonLongPressTime (s64 val)
 Sets the DefaultHomeButtonLongPressTime. More...
 
Result appletUpdateDefaultDisplayResolution (void)
 UpdateDefaultDisplayResolution. More...
 
Result appletShouldSleepOnBoot (bool *out)
 ShouldSleepOnBoot. More...
 
Result appletGetHdcpAuthenticationFailedEvent (Event *out_event)
 Gets an Event which is signaled for HdcpAuthenticationFailed. More...
 
IApplicationCreator
Result appletCreateApplication (AppletApplication *a, u64 application_id)
 Creates an Application. More...
 
Result appletPopLaunchRequestedApplication (AppletApplication *a)
 Pops a AppletApplication for a requested Application launch. More...
 
Result appletCreateSystemApplication (AppletApplication *a, u64 system_application_id)
 Creates a SystemApplication. More...
 
Result appletPopFloatingApplicationForDevelopment (AppletApplication *a)
 PopFloatingApplicationForDevelopment. More...
 
IApplicationAccessor
void appletApplicationClose (AppletApplication *a)
 Close an AppletApplication. More...
 
bool appletApplicationActive (AppletApplication *a)
 Returns whether the AppletApplication object was initialized. More...
 
Result appletApplicationStart (AppletApplication *a)
 Starts the Application. More...
 
Result appletApplicationRequestExit (AppletApplication *a)
 Requests the Application to exit. More...
 
Result appletApplicationTerminate (AppletApplication *a)
 Terminate the Application. More...
 
void appletApplicationJoin (AppletApplication *a)
 Waits for the Application to exit. More...
 
bool appletApplicationCheckFinished (AppletApplication *a)
 Waits on the Application StateChangedEvent with timeout=0, and returns whether it was successful. More...
 
AppletApplicationExitReason appletApplicationGetExitReason (AppletApplication *a)
 Gets the AppletApplicationExitReason set by appletApplicationJoin. More...
 
Result appletApplicationRequestForApplicationToGetForeground (AppletApplication *a)
 RequestForApplicationToGetForeground. More...
 
Result appletApplicationTerminateAllLibraryApplets (AppletApplication *a)
 TerminateAllLibraryApplets which were created by the Application.
 
Result appletApplicationAreAnyLibraryAppletsLeft (AppletApplication *a, bool *out)
 AreAnyLibraryAppletsLeft which were created by the Application. More...
 
Result appletApplicationRequestExitLibraryAppletOrTerminate (AppletApplication *a, u64 timeout)
 Calls the same func as appletHolderRequestExitOrTerminate with the output IAppletAccessor from the GetCurrentLibraryApplet cmd. More...
 
Result appletApplicationGetApplicationId (AppletApplication *a, u64 *application_id)
 Gets the ApplicationId for the Application. More...
 
Result appletApplicationPushLaunchParameter (AppletApplication *a, AppletLaunchParameterKind kind, AppletStorage *s)
 Pushes a LaunchParameter AppletStorage to the Application. More...
 
Result appletApplicationGetApplicationControlProperty (AppletApplication *a, NacpStruct *nacp)
 Gets the NacpStruct for the Application. More...
 
Result appletApplicationGetApplicationLaunchProperty (AppletApplication *a, AppletApplicationLaunchProperty *out)
 Gets the AppletApplicationLaunchProperty for the Application. More...
 
Result appletApplicationGetApplicationLaunchRequestInfo (AppletApplication *a, AppletApplicationLaunchRequestInfo *out)
 Gets the AppletApplicationLaunchRequestInfo for the Application. More...
 
Result appletApplicationSetUsers (AppletApplication *a, const AccountUid *uids, s32 count, bool flag)
 SetUsers for the Application. More...
 
Result appletApplicationCheckRightsEnvironmentAvailable (AppletApplication *a, bool *out)
 CheckRightsEnvironmentAvailable. More...
 
Result appletApplicationGetNsRightsEnvironmentHandle (AppletApplication *a, u64 *handle)
 GetNsRightsEnvironmentHandle. More...
 
Result appletApplicationGetDesirableUids (AppletApplication *a, AccountUid *uids, s32 count, s32 *total_out)
 Gets an array of userIds for the Application DesirableUids. More...
 
Result appletApplicationReportApplicationExitTimeout (AppletApplication *a)
 ReportApplicationExitTimeout. More...
 
Result appletApplicationSetApplicationAttribute (AppletApplication *a, const AppletApplicationAttribute *attr)
 Sets the AppletApplicationAttribute for the Application. More...
 
Result appletApplicationHasSaveDataAccessPermission (AppletApplication *a, u64 application_id, bool *out)
 Gets whether the savedata specified by the input ApplicationId is accessible. More...
 
Result appletApplicationPushToFriendInvitationStorageChannel (AppletApplication *a, AccountUid uid, const void *buffer, u64 size)
 Creates a storage using the specified input then pushes it to the FriendInvitation StorageChannel. More...
 
Result appletApplicationPushToNotificationStorageChannel (AppletApplication *a, const void *buffer, u64 size)
 Creates a storage using the specified input then pushes it to the Notification StorageChannel. More...
 
Result appletApplicationRequestApplicationSoftReset (AppletApplication *a)
 RequestApplicationSoftReset. More...
 
Result appletApplicationRestartApplicationTimer (AppletApplication *a)
 RestartApplicationTimer. More...
 
ILibraryAppletSelfAccessor
Result appletPopInData (AppletStorage *s)
 Pops a storage from current-LibraryApplet input. More...
 
Result appletPushOutData (AppletStorage *s)
 Pushes a storage for current-LibraryApplet output. More...
 
Result appletPopInteractiveInData (AppletStorage *s)
 Pops a storage from current-LibraryApplet Interactive input. More...
 
Result appletPushInteractiveOutData (AppletStorage *s)
 Pushes a storage for current-LibraryApplet Interactive output. More...
 
Result appletGetPopInDataEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletPopInData where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletGetPopInteractiveInDataEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletPopInteractiveInData where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletGetLibraryAppletInfo (LibAppletInfo *info)
 Gets the LibAppletInfo for the current LibraryApplet. More...
 
Result appletGetMainAppletIdentityInfo (AppletIdentityInfo *info)
 Gets the AppletIdentityInfo for the MainApplet. More...
 
Result appletCanUseApplicationCore (bool *out)
 CanUseApplicationCore. More...
 
Result appletGetCallerAppletIdentityInfo (AppletIdentityInfo *info)
 Gets the AppletIdentityInfo for the CallerApplet. More...
 
Result appletGetMainAppletApplicationControlProperty (NacpStruct *nacp)
 Gets the NacpStruct for the MainApplet. More...
 
Result appletGetMainAppletStorageId (NcmStorageId *storageId)
 Gets the NcmStorageId for the MainApplet. More...
 
Result appletGetCallerAppletIdentityInfoStack (AppletIdentityInfo *stack, s32 count, s32 *total_out)
 Gets an array of AppletIdentityInfo for the CallerStack. More...
 
Result appletGetNextReturnDestinationAppletIdentityInfo (AppletIdentityInfo *info)
 Gets the AppletIdentityInfo for the NextReturnDestinationApplet. More...
 
Result appletGetDesirableKeyboardLayout (SetKeyboardLayout *layout)
 Gets the DesirableKeyboardLayout previously set by appletSetDesirableKeyboardLayout. More...
 
Result appletPopExtraStorage (AppletStorage *s)
 Pops a storage from current-LibraryApplet Extra input. More...
 
Result appletGetPopExtraStorageEvent (Event *out_event)
 Gets an Event which is signaled when a new storage is available with appletPopExtraStorage where previously no storage was available, this event is automatically cleared by the system once the last storage is popped. More...
 
Result appletUnpopInData (AppletStorage *s)
 Unpop a storage for current-LibraryApplet input. More...
 
Result appletUnpopExtraStorage (AppletStorage *s)
 Unpop a storage for current-LibraryApplet Extra input. More...
 
Result appletGetIndirectLayerProducerHandle (u64 *out)
 Gets the IndirectLayerProducerHandle. More...
 
Result appletGetMainAppletApplicationDesiredLanguage (u64 *LanguageCode)
 Gets the DesiredLanguage for the MainApplet. More...
 
Result appletGetCurrentApplicationId (u64 *application_id)
 Gets the ApplicationId for the currently running Application. More...
 
Result appletRequestExitToSelf (void)
 Exits the current applet. More...
 
Result appletCreateGameMovieTrimmer (Service *srv_out, TransferMemory *tmem)
 CreateGameMovieTrimmer. More...
 
Result appletReserveResourceForMovieOperation (void)
 ReserveResourceForMovieOperation. More...
 
Result appletUnreserveResourceForMovieOperation (void)
 UnreserveResourceForMovieOperation. More...
 
Result appletGetMainAppletAvailableUsers (AccountUid *uids, s32 count, bool *flag, s32 *total_out)
 Gets an array of userIds for the MainApplet AvailableUsers. More...
 
Result appletSetApplicationMemoryReservation (u64 val)
 SetApplicationMemoryReservation. More...
 
Result appletShouldSetGpuTimeSliceManually (bool *out)
 ShouldSetGpuTimeSliceManually. More...
 
IOverlayFunctions: IFunctions for AppletType_OverlayApplet.
Result appletBeginToWatchShortHomeButtonMessage (void)
 Stops forwarding the input to the foreground app. More...
 
Result appletEndToWatchShortHomeButtonMessage (void)
 Forwards input to the foreground app. More...
 
Result appletGetApplicationIdForLogo (u64 *application_id)
 Gets the ApplicationId for displaying the logo screen during application launch. More...
 
Result appletSetGpuTimeSliceBoost (u64 val)
 Sets the GpuTimeSliceBoost. More...
 
Result appletSetAutoSleepTimeAndDimmingTimeEnabled (bool flag)
 Sets AutoSleepTimeAndDimmingTimeEnabled. More...
 
Result appletTerminateApplicationAndSetReason (Result reason)
 TerminateApplicationAndSetReason. More...
 
Result appletSetScreenShotPermissionGlobally (bool flag)
 Sets ScreenShotPermissionGlobally. More...
 
Result appletStartShutdownSequenceForOverlay (void)
 Start the system-shutdown sequence. More...
 
Result appletStartRebootSequenceForOverlay (void)
 Start the system-reboot sequence. More...
 
Result appletSetHealthWarningShowingState (bool flag)
 SetHealthWarningShowingState. More...
 
Result appletIsHealthWarningRequired (bool *out)
 IsHealthWarningRequired. More...
 
Result appletBeginToObserveHidInputForDevelop (void)
 Enables HID input for the OverlayApplet, without disabling input for the foreground applet. More...
 
IAppletCommonFunctions
Result appletReadThemeStorage (void *buffer, size_t size, u64 offset, u64 *transfer_size)
 Reads the ThemeStorage for the current applet. More...
 
Result appletWriteThemeStorage (const void *buffer, size_t size, u64 offset)
 Writes the ThemeStorage for the current applet. More...
 
Result appletPushToAppletBoundChannel (AppletStorage *s)
 This is similar to appletPushToAppletBoundChannelForDebug (no DebugMode check), except the used channel is loaded from elsewhere and must be in the range 31-32. More...
 
Result appletTryPopFromAppletBoundChannel (AppletStorage *s)
 This is similar to appletTryPopFromAppletBoundChannelForDebug (no DebugMode check), except the used channel is loaded from elsewhere and must be in the range 31-32. More...
 
Result appletGetDisplayLogicalResolution (s32 *width, s32 *height)
 Gets the DisplayLogicalResolution. More...
 
Result appletSetDisplayMagnification (float x, float y, float width, float height)
 Sets the DisplayMagnification. More...
 
Result appletSetHomeButtonDoubleClickEnabled (bool flag)
 Sets whether HomeButtonDoubleClick is enabled. More...
 
Result appletGetHomeButtonDoubleClickEnabled (bool *out)
 Gets whether HomeButtonDoubleClick is enabled. More...
 
Result appletIsHomeButtonShortPressedBlocked (bool *out)
 IsHomeButtonShortPressedBlocked. More...
 
Result appletIsVrModeCurtainRequired (bool *out)
 IsVrModeCurtainRequired. More...
 
Result appletSetCpuBoostRequestPriority (s32 priority)
 SetCpuBoostRequestPriority. More...
 
IDebugFunctions
Result appletOpenMainApplication (AppletApplication *a)
 Open an AppletApplication for the currently running Application. More...
 
Result appletPerformSystemButtonPressing (AppletSystemButtonType type)
 Perform SystemButtonPressing with the specified AppletSystemButtonType. More...
 
Result appletInvalidateTransitionLayer (void)
 InvalidateTransitionLayer.
 
Result appletRequestLaunchApplicationWithUserAndArgumentForDebug (u64 application_id, const AccountUid *uids, s32 total_uids, bool flag, const void *buffer, size_t size)
 Requests to launch the specified Application, with the specified users. More...
 
Result appletGetAppletResourceUsageInfo (AppletResourceUsageInfo *info)
 Gets the AppletResourceUsageInfo. More...
 
Result appletPushToAppletBoundChannelForDebug (AppletStorage *s, s32 channel)
 The channel must match the value already stored in state when the state value is non-zero, otherwise an error is returned. More...
 
Result appletTryPopFromAppletBoundChannelForDebug (AppletStorage *s, s32 channel)
 The channel must not be 0 and must match the value previously saved by appletPushToAppletBoundChannelForDebug, otherwise errors are returned. More...
 
Result appletAlarmSettingNotificationEnableAppEventReserve (AppletStorage *s, u64 application_id)
 Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state. More...
 
Result appletAlarmSettingNotificationDisableAppEventReserve (void)
 Clears the StorageChannel/saved-ApplicationId used by appletAlarmSettingNotificationEnableAppEventReserve. More...
 
Result appletAlarmSettingNotificationPushAppEventNotify (const void *buffer, u64 size)
 Same as appletApplicationPushToNotificationStorageChannel except this uses the MainApplication. More...
 
Result appletFriendInvitationSetApplicationParameter (AppletStorage *s, u64 application_id)
 Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state. More...
 
Result appletFriendInvitationClearApplicationParameter (void)
 Clears the StorageChannel/saved-ApplicationId used by appletFriendInvitationSetApplicationParameter. More...
 
Result appletFriendInvitationPushApplicationParameter (AccountUid uid, const void *buffer, u64 size)
 Same as appletApplicationPushToFriendInvitationStorageChannel except this uses the MainApplication. More...
 
Common cmds
Result appletSetTerminateResult (Result res)
 SetTerminateResult. More...
 
Result appletGetLaunchStorageInfoForDebug (NcmStorageId *app_storageId, NcmStorageId *update_storageId)
 Gets the LaunchStorageInfo. More...
 
Result appletGetGpuErrorDetectedSystemEvent (Event *out_event)
 Gets an Event which is signaled for GpuErrorDetected. More...
 
Result appletSetHandlingHomeButtonShortPressedEnabled (bool flag)
 Sets HandlingHomeButtonShortPressedEnabled. More...
 
State / other
AppletInfoappletGetAppletInfo (void)
 Gets the cached AppletInfo loaded during appletInitialize. More...
 
Result appletGetMessage (u32 *msg)
 Gets a notification message, see AppletMessage.
 
bool appletProcessMessage (u32 msg)
 Processes the current applet status using the specified msg. More...
 
bool appletMainLoop (void)
 Processes the current applet status. More...
 
void appletHook (AppletHookCookie *cookie, AppletHookFn callback, void *param)
 Sets up an applet status hook. More...
 
void appletUnhook (AppletHookCookie *cookie)
 Removes an applet status hook. More...
 
AppletOperationMode appletGetOperationMode (void)
 These return state which is updated by appletMainLoop() when notifications are received.
 
ApmPerformanceMode appletGetPerformanceMode (void)
 
AppletFocusState appletGetFocusState (void)
 
Result appletSetFocusHandlingMode (AppletFocusHandlingMode mode)
 Sets the current AppletFocusHandlingMode. More...
 

Detailed Description

Applet (applet) service IPC wrapper.

Note
For wrappers which launch LibraryApplets etc, see switch/applets/.
Author
yellows8

Enumeration Type Documentation

◆ AppletCaptureSharedBuffer

CaptureSharedBuffer for the IDisplayController commands.

Enumerator
AppletCaptureSharedBuffer_LastApplication 

LastApplication.

AppletCaptureSharedBuffer_LastForeground 

LastForeground.

AppletCaptureSharedBuffer_CallerApplet 

CallerApplet.

◆ AppletFocusHandlingMode

FocusHandlingMode.

Enumerator
AppletFocusHandlingMode_SuspendHomeSleep 

Suspend only when HOME menu is open / console is sleeping (default).

AppletFocusHandlingMode_NoSuspend 

Don't suspend when out of focus.

AppletFocusHandlingMode_SuspendHomeSleepNotify 

Suspend only when HOME menu is open / console is sleeping but still receive OnFocusState hook.

AppletFocusHandlingMode_AlwaysSuspend 

Always suspend when out of focus, regardless of the reason.

AppletFocusHandlingMode_Max 

Number of focus handling modes.

◆ AppletFocusState

FocusState.

Enumerator
AppletFocusState_InFocus 

Applet is focused.

AppletFocusState_OutOfFocus 

Out of focus - LibraryApplet open.

AppletFocusState_Background 

Out of focus - HOME menu open / console is sleeping.

◆ AppletHookType

applet hook types.

Enumerator
AppletHookType_OnFocusState 

AppletMessage_FocusStateChanged

AppletHookType_OnOperationMode 

AppletMessage_OperationModeChanged

AppletHookType_OnPerformanceMode 

AppletMessage_PerformanceModeChanged

AppletHookType_OnExitRequest 

::AppletMessage_ExitRequested

AppletHookType_OnResume 

AppletMessage_Resume

AppletHookType_OnCaptureButtonShortPressed 

AppletMessage_CaptureButtonShortPressed

AppletHookType_OnAlbumScreenShotTaken 

AppletMessage_AlbumScreenShotTaken

AppletHookType_RequestToDisplay 

AppletMessage_RequestToDisplay

AppletHookType_Max 

Number of applet hook types.

◆ AppletId

enum AppletId

AppletId.

Enumerator
AppletId_None 

None.

AppletId_application 

Application. Not valid for use with LibraryApplets.

AppletId_OverlayApplet 

010000000000100C "overlayDisp"

AppletId_SystemAppletMenu 

0100000000001000 "qlaunch" (SystemAppletMenu)

AppletId_SystemApplication 

0100000000001012 "starter" SystemApplication.

AppletId_LibraryAppletAuth 

0100000000001001 "auth"

AppletId_LibraryAppletCabinet 

0100000000001002 "cabinet"

AppletId_LibraryAppletController 

0100000000001003 "controller"

AppletId_LibraryAppletDataErase 

0100000000001004 "dataErase"

AppletId_LibraryAppletError 

0100000000001005 "error"

AppletId_LibraryAppletNetConnect 

0100000000001006 "netConnect"

AppletId_LibraryAppletPlayerSelect 

0100000000001007 "playerSelect"

AppletId_LibraryAppletSwkbd 

0100000000001008 "swkbd"

AppletId_LibraryAppletMiiEdit 

0100000000001009 "miiEdit"

AppletId_LibraryAppletWeb 

010000000000100A "LibAppletWeb" WebApplet applet

AppletId_LibraryAppletShop 

010000000000100B "LibAppletShop" ShopN applet

AppletId_LibraryAppletPhotoViewer 

010000000000100D "photoViewer"

AppletId_LibraryAppletSet 

010000000000100E "set" (This applet is currently not present on retail devices.)

AppletId_LibraryAppletOfflineWeb 

010000000000100F "LibAppletOff" offlineWeb applet

AppletId_LibraryAppletLoginShare 

0100000000001010 "LibAppletLns" loginShare web-applet

AppletId_LibraryAppletWifiWebAuth 

0100000000001011 "LibAppletAuth" wifiWebAuth applet

AppletId_LibraryAppletMyPage 

0100000000001013 "myPage"

◆ AppletIdleTimeDetectionExtension

Extension values for appletSetIdleTimeDetectionExtension / appletGetIdleTimeDetectionExtension, for extending user inactivity detection.

Enumerator
AppletIdleTimeDetectionExtension_None 

No extension.

AppletIdleTimeDetectionExtension_Extended 

Extended.

AppletIdleTimeDetectionExtension_ExtendedUnsafe 

ExtendedUnsafe.

◆ AppletInputDetectionPolicy

Input policy values for appletSetInputDetectionPolicy.

Enumerator
AppletInputDetectionPolicy_Unknown0 

Unknown.

AppletInputDetectionPolicy_Unknown1 

Unknown.

◆ AppletLaunchParameterKind

LaunchParameterKind.

Enumerator
AppletLaunchParameterKind_UserChannel 

UserChannel. Application-specific LaunchParameter.

AppletLaunchParameterKind_PreselectedUser 

account PreselectedUser

AppletLaunchParameterKind_Unknown 

Unknown if used by anything?

◆ AppletMessage

AppletMessage, for appletGetMessage. See also AppletHookType.

Enumerator
AppletMessage_ExitRequest 

Exit request.

AppletMessage_FocusStateChanged 

FocusState changed.

AppletMessage_Resume 

Current applet execution was resumed.

AppletMessage_OperationModeChanged 

OperationMode changed.

AppletMessage_PerformanceModeChanged 

PerformanceMode changed.

AppletMessage_RequestToDisplay 

Display requested, see appletApproveToDisplay.

AppletMessage_CaptureButtonShortPressed 

Capture button was short-pressed.

AppletMessage_AlbumScreenShotTaken 

Screenshot was taken.

AppletMessage_AlbumRecordingSaved 

AlbumRecordingSaved.

◆ AppletOperationMode

OperationMode.

Enumerator
AppletOperationMode_Handheld 

Handheld.

AppletOperationMode_Console 

Console (Docked / TV-mode)

◆ AppletProgramSpecifyKind

ProgramSpecifyKind for the ExecuteProgram cmd. Controls the type of the u64 passed to the ExecuteProgram cmd.

Enumerator
AppletProgramSpecifyKind_ExecuteProgram 

u8 ProgramIndex.

AppletProgramSpecifyKind_JumpToSubApplicationProgramForDevelopment 

u64 application_id. Only available when DebugMode is enabled.

AppletProgramSpecifyKind_RestartProgram 

u64 = value 0.

◆ AppletScreenShotPermission

Permission values for appletSetScreenShotPermission.

Enumerator
AppletScreenShotPermission_Inherit 

Inherit from parent applet.

AppletScreenShotPermission_Enable 

Enable.

AppletScreenShotPermission_Disable 

Disable.

◆ AppletSystemButtonType

Type values for appletPerformSystemButtonPressingIfInFocus.

Enumerator
AppletSystemButtonType_HomeButtonShortPressing 

Short-pressing with the HOME-button.

AppletSystemButtonType_HomeButtonLongPressing 

Long-pressing with the HOME-button.

AppletSystemButtonType_PowerButtonShortPressing 

Short-pressing with the Power-button. Only available with appletPerformSystemButtonPressing.

AppletSystemButtonType_PowerButtonLongPressing 

Long-pressing with the Power-button. Only available with appletPerformSystemButtonPressing.

AppletSystemButtonType_Shutdown 

Shutdown the system, as if the Power-button was held for longer than AppletSystemButtonType_PowerButtonLongPressing. Only available with appletPerformSystemButtonPressing.

AppletSystemButtonType_CaptureButtonShortPressing 

Short-pressing with the Capture-button.

AppletSystemButtonType_CaptureButtonLongPressing 

Long-pressing with the Capture-button.

◆ AppletTvPowerStateMatchingMode

Mode values for appletSetTvPowerStateMatchingMode.

Enumerator
AppletTvPowerStateMatchingMode_Unknown0 

Unknown.

AppletTvPowerStateMatchingMode_Unknown1 

Unknown.

◆ AppletWindowOriginMode

WindowOriginMode.

Enumerator
AppletWindowOriginMode_LowerLeft 

LowerLeft.

AppletWindowOriginMode_UpperLeft 

UpperLeft.

◆ AppletWirelessPriorityMode

Input mode values for appletSetWirelessPriorityMode.

Enumerator
AppletWirelessPriorityMode_Default 

Default.

AppletWirelessPriorityMode_OptimizedForWlan 

OptimizedForWlan.

◆ LibAppletMode

LibraryAppletMode.

Enumerator
LibAppletMode_AllForeground 

Foreground.

LibAppletMode_Background 

Background.

LibAppletMode_NoUi 

No UI.

LibAppletMode_BackgroundIndirect 

Background with indirect display, see appletHolderGetIndirectLayerConsumerHandle.

LibAppletMode_AllForegroundInitiallyHidden 

Foreground except initially hidden.

Function Documentation

◆ appletAcquireCallerAppletCaptureSharedBuffer()

Result appletAcquireCallerAppletCaptureSharedBuffer ( bool *  flag,
s32 id 
)

Acquire the CallerApplet CaptureSharedBuffer.

Note
Only available with [4.0.0+].
Parameters
[out]flagOutput flag.
[out]idOutput ID.

◆ appletAcquireLastApplicationCaptureSharedBuffer()

Result appletAcquireLastApplicationCaptureSharedBuffer ( bool *  flag,
s32 id 
)

Acquire the LastApplication CaptureSharedBuffer.

Note
Only available with [4.0.0+].
Parameters
[out]flagOutput flag.
[out]idOutput ID.

◆ appletAcquireLastForegroundCaptureSharedBuffer()

Result appletAcquireLastForegroundCaptureSharedBuffer ( bool *  flag,
s32 id 
)

Acquire the LastForeground CaptureSharedBuffer.

Note
Only available with [4.0.0+].
Parameters
[out]flagOutput flag.
[out]idOutput ID.

◆ appletActivateMigrationService()

Result appletActivateMigrationService ( void  )

ActivateMigrationService.

Note
Only available with [10.0.0+].

◆ appletAlarmSettingNotificationDisableAppEventReserve()

Result appletAlarmSettingNotificationDisableAppEventReserve ( void  )

Clears the StorageChannel/saved-ApplicationId used by appletAlarmSettingNotificationEnableAppEventReserve.

Note
Only available on [9.0.0+].

◆ appletAlarmSettingNotificationEnableAppEventReserve()

Result appletAlarmSettingNotificationEnableAppEventReserve ( AppletStorage s,
u64  application_id 
)

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

Note
Only available on [9.0.0+].
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.
[in]application_idApplicationId

◆ appletAlarmSettingNotificationPushAppEventNotify()

Result appletAlarmSettingNotificationPushAppEventNotify ( const void *  buffer,
u64  size 
)

Same as appletApplicationPushToNotificationStorageChannel except this uses the MainApplication.

Note
Only available on [9.0.0+].
Parameters
[in]bufferInput buffer.
[in]sizeInput buffer size.

◆ appletApplicationActive()

bool appletApplicationActive ( AppletApplication a)

Returns whether the AppletApplication object was initialized.

Parameters
aAppletApplication

◆ appletApplicationAreAnyLibraryAppletsLeft()

Result appletApplicationAreAnyLibraryAppletsLeft ( AppletApplication a,
bool *  out 
)

AreAnyLibraryAppletsLeft which were created by the Application.

Parameters
aAppletApplication
[out]outOutput flag.

◆ appletApplicationCheckFinished()

bool appletApplicationCheckFinished ( AppletApplication a)

Waits on the Application StateChangedEvent with timeout=0, and returns whether it was successful.

Parameters
aAppletApplication

◆ appletApplicationCheckRightsEnvironmentAvailable()

Result appletApplicationCheckRightsEnvironmentAvailable ( AppletApplication a,
bool *  out 
)

CheckRightsEnvironmentAvailable.

Note
Only available on [6.0.0+].
Parameters
aAppletApplication
[out]outOutput flag.

◆ appletApplicationClose()

void appletApplicationClose ( AppletApplication a)

Close an AppletApplication.

Parameters
aAppletApplication

◆ appletApplicationGetApplicationControlProperty()

Result appletApplicationGetApplicationControlProperty ( AppletApplication a,
NacpStruct nacp 
)

Gets the NacpStruct for the Application.

Note
Not usable when the AppletApplication is for an AppletType_SystemApplication.
Parameters
aAppletApplication
[out]nacpNacpStruct

◆ appletApplicationGetApplicationId()

Result appletApplicationGetApplicationId ( AppletApplication a,
u64 application_id 
)

Gets the ApplicationId for the Application.

Parameters
aAppletApplication
[out]application_idOutput ApplicationId.

◆ appletApplicationGetApplicationLaunchProperty()

Result appletApplicationGetApplicationLaunchProperty ( AppletApplication a,
AppletApplicationLaunchProperty out 
)

Gets the AppletApplicationLaunchProperty for the Application.

Note
Only available on [2.0.0+]. Not usable when the AppletApplication is for an AppletType_SystemApplication.
Parameters
aAppletApplication
[out]outAppletApplicationLaunchProperty

◆ appletApplicationGetApplicationLaunchRequestInfo()

Result appletApplicationGetApplicationLaunchRequestInfo ( AppletApplication a,
AppletApplicationLaunchRequestInfo out 
)

Gets the AppletApplicationLaunchRequestInfo for the Application.

Note
Only available on [6.0.0+].
Parameters
aAppletApplication
[out]outAppletApplicationLaunchRequestInfo

◆ appletApplicationGetDesirableUids()

Result appletApplicationGetDesirableUids ( AppletApplication a,
AccountUid uids,
s32  count,
s32 total_out 
)

Gets an array of userIds for the Application DesirableUids.

Note
Only available on [6.0.0+].
qlaunch only uses 1 userId with this.
Parameters
aAppletApplication
[out]uidsOutput array of AccountUid.
[in]countSize of the uids array in entries, must be at least the size stored in state.
[out]total_outTotal output entries.

◆ appletApplicationGetExitReason()

AppletApplicationExitReason appletApplicationGetExitReason ( AppletApplication a)

◆ appletApplicationGetNsRightsEnvironmentHandle()

Result appletApplicationGetNsRightsEnvironmentHandle ( AppletApplication a,
u64 handle 
)

GetNsRightsEnvironmentHandle.

Note
Only available on [6.0.0+].
Parameters
aAppletApplication
[out]handleOutput NsRightsEnvironmentHandle.

◆ appletApplicationHasSaveDataAccessPermission()

Result appletApplicationHasSaveDataAccessPermission ( AppletApplication a,
u64  application_id,
bool *  out 
)

Gets whether the savedata specified by the input ApplicationId is accessible.

Note
Only available on [8.0.0+].
Parameters
aAppletApplication
[in]application_idApplicationId for the savedata.
[out]outOutput flag.

◆ appletApplicationJoin()

void appletApplicationJoin ( AppletApplication a)

Waits for the Application to exit.

Parameters
aAppletApplication

◆ appletApplicationPushLaunchParameter()

Result appletApplicationPushLaunchParameter ( AppletApplication a,
AppletLaunchParameterKind  kind,
AppletStorage s 
)

Pushes a LaunchParameter AppletStorage to the Application.

Note
This uses appletStorageClose automatically.
Parameters
aAppletApplication
[in]kindAppletLaunchParameterKind
[in]sInput storage.

◆ appletApplicationPushToFriendInvitationStorageChannel()

Result appletApplicationPushToFriendInvitationStorageChannel ( AppletApplication a,
AccountUid  uid,
const void *  buffer,
u64  size 
)

Creates a storage using the specified input then pushes it to the FriendInvitation StorageChannel.

Note
The system will clear the StorageChannel before pushing the storage.
Only available on [9.0.0+].
Parameters
aAppletApplication
[in]uidAccountUid
[in]bufferInput buffer.
[in]sizeInput buffer size.

◆ appletApplicationPushToNotificationStorageChannel()

Result appletApplicationPushToNotificationStorageChannel ( AppletApplication a,
const void *  buffer,
u64  size 
)

Creates a storage using the specified input then pushes it to the Notification StorageChannel.

Note
The system will clear the StorageChannel before pushing the storage.
Only available on [9.0.0+].
Parameters
aAppletApplication
[in]bufferInput buffer.
[in]sizeInput buffer size.

◆ appletApplicationReportApplicationExitTimeout()

Result appletApplicationReportApplicationExitTimeout ( AppletApplication a)

ReportApplicationExitTimeout.

Note
Only available on [6.0.0+].
Parameters
aAppletApplication

◆ appletApplicationRequestApplicationSoftReset()

Result appletApplicationRequestApplicationSoftReset ( AppletApplication a)

RequestApplicationSoftReset.

Note
Only available on [10.0.0+].
Parameters
aAppletApplication

◆ appletApplicationRequestExit()

Result appletApplicationRequestExit ( AppletApplication a)

Requests the Application to exit.

Parameters
aAppletApplication

◆ appletApplicationRequestExitLibraryAppletOrTerminate()

Result appletApplicationRequestExitLibraryAppletOrTerminate ( AppletApplication a,
u64  timeout 
)

Calls the same func as appletHolderRequestExitOrTerminate with the output IAppletAccessor from the GetCurrentLibraryApplet cmd.

Parameters
aAppletApplication
[in]timeoutTimeout in nanoseconds. UINT64_MAX for no timeout.

◆ appletApplicationRequestForApplicationToGetForeground()

Result appletApplicationRequestForApplicationToGetForeground ( AppletApplication a)

RequestForApplicationToGetForeground.

Parameters
aAppletApplication

◆ appletApplicationRestartApplicationTimer()

Result appletApplicationRestartApplicationTimer ( AppletApplication a)

RestartApplicationTimer.

Note
Only available on [10.0.0+].
Parameters
aAppletApplication

◆ appletApplicationSetApplicationAttribute()

Result appletApplicationSetApplicationAttribute ( AppletApplication a,
const AppletApplicationAttribute attr 
)

Sets the AppletApplicationAttribute for the Application.

Note
Only available on [8.0.0+].
Parameters
aAppletApplication
[in]attrAppletApplicationAttribute

◆ appletApplicationSetUsers()

Result appletApplicationSetUsers ( AppletApplication a,
const AccountUid uids,
s32  count,
bool  flag 
)

SetUsers for the Application.

Note
Only available on [6.0.0+].
Parameters
aAppletApplication
[in]uidsInput array of AccountUid.
[in]countSize of the uids array in entries, must be <=ACC_USER_LIST_SIZE.
[in]flagWhen this flag is true, this just clears the users_available state flag to 0 and returns.

◆ appletApplicationStart()

Result appletApplicationStart ( AppletApplication a)

Starts the Application.

Parameters
aAppletApplication

◆ appletApplicationTerminate()

Result appletApplicationTerminate ( AppletApplication a)

Terminate the Application.

Parameters
aAppletApplication

◆ appletAreAnyLibraryAppletsLeft()

Result appletAreAnyLibraryAppletsLeft ( bool *  out)

AreAnyLibraryAppletsLeft which were created by the current applet.

Parameters
[out]outOutput flag.

◆ appletBeginBlockingHomeButton()

Result appletBeginBlockingHomeButton ( s64  val)

Blocks the usage of the home button, for short presses (Home Menu).

Note
Only available with AppletType_*Application.
Parameters
valUnknown nanoseconds. Value 0 can be used.

◆ appletBeginBlockingHomeButtonShortAndLongPressed()

Result appletBeginBlockingHomeButtonShortAndLongPressed ( s64  val)

Blocks the usage of the home button, for short (Home Menu) and long (Overlay) presses.

Note
Only available with AppletType_*Application.
Parameters
valUnknown. Official sw only uses hard-coded value 0 for this.

◆ appletBeginToObserveHidInputForDevelop()

Result appletBeginToObserveHidInputForDevelop ( void  )

Enables HID input for the OverlayApplet, without disabling input for the foreground applet.

Generally appletBeginToWatchShortHomeButtonMessage / appletEndToWatchShortHomeButtonMessage should be used instead.

Note
Only available with AppletType_OverlayApplet on [5.0.0+].

◆ appletBeginToWatchShortHomeButtonMessage()

Result appletBeginToWatchShortHomeButtonMessage ( void  )

Stops forwarding the input to the foreground app.

Note
Only available with AppletType_OverlayApplet.
You have to call this to receive inputs through the hid service when running as the overlay applet.

◆ appletCancelCpuBoostMode()

Result appletCancelCpuBoostMode ( void  )

CancelCpuBoostMode.

Note
Only available with [10.0.0+].

◆ appletCanUseApplicationCore()

Result appletCanUseApplicationCore ( bool *  out)

CanUseApplicationCore.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]outOutput flag.

◆ appletChangeMainAppletMasterVolume()

Result appletChangeMainAppletMasterVolume ( float  volume,
u64  unk 
)

Change the MainApplet MasterVolume.

Parameters
[in]volumeMainApplet MasterVolume.
[in]unkUnknown.

◆ appletClearAppletTransitionBuffer()

Result appletClearAppletTransitionBuffer ( u32  color)

Clear the AppletTransitionBuffer with the specified color.

Note
Only available with [3.0.0+].
Parameters
[in]colorRGBA8 color.

◆ appletClearCaptureBuffer()

Result appletClearCaptureBuffer ( bool  flag,
AppletCaptureSharedBuffer  captureBuf,
u32  color 
)

Clear the input CaptureSharedBuffer with the specified color.

Note
Only available with [3.0.0+].
Parameters
[in]flagFlag.
[in]captureBufAppletCaptureSharedBuffer
[in]colorRGBA8 color.

◆ appletCopyBetweenCaptureBuffers()

Result appletCopyBetweenCaptureBuffers ( AppletCaptureSharedBuffer  dstCaptureBuf,
AppletCaptureSharedBuffer  srcCaptureBuf 
)

Copies image data from a CaptureSharedBuffer to another CaptureSharedBuffer.

Note
Only available with [5.0.0+].
Parameters
[in]dstCaptureBufDestination AppletCaptureSharedBuffer.
[in]srcCaptureBufSource AppletCaptureSharedBuffer.

◆ appletCreateApplication()

Result appletCreateApplication ( AppletApplication a,
u64  application_id 
)

Creates an Application.

Note
Only available with AppletType_SystemApplet.
Parameters
[out]aAppletApplication
[in]application_idApplicationId.

◆ appletCreateGameMovieTrimmer()

Result appletCreateGameMovieTrimmer ( Service srv_out,
TransferMemory tmem 
)

CreateGameMovieTrimmer.

Do not use this directly, use grcTrimGameMovie instead.

Note
Only available with AppletType_LibraryApplet on [4.0.0+].
See also appletReserveResourceForMovieOperation and appletUnreserveResourceForMovieOperation.
Parameters
[out]srv_outOutput Service for grc IGameMovieTrimmer.
[in]tmemTransferMemory

◆ appletCreateHandleStorage()

Result appletCreateHandleStorage ( AppletStorage s,
s64  inval,
Handle  handle 
)

Creates a HandleStorage.

Note
Only available on [2.0.0+].
Parameters
sStorage object.
invalArbitrary input value.
handleArbitrary input handle.

◆ appletCreateHandleStorageTmem()

Result appletCreateHandleStorageTmem ( AppletStorage s,
void *  buffer,
s64  size 
)

Creates a HandleStorage using TransferMemory.

Wrapper for appletCreateHandleStorage.

Parameters
sStorage object.
bufferTransferMemory buffer, will be automatically allocated if NULL.
sizeSize of storage.

◆ appletCreateLibraryApplet()

Result appletCreateLibraryApplet ( AppletHolder h,
AppletId  id,
LibAppletMode  mode 
)

Creates a LibraryApplet.

Parameters
hAppletHolder object.
idSee AppletId.
modeSee LibAppletMode.

◆ appletCreateLibraryAppletSelf()

Result appletCreateLibraryAppletSelf ( AppletHolder h,
AppletId  id,
LibAppletMode  mode 
)

Creates a LibraryApplet.

This is for when a LibraryApplet creates itself.

Note
Identical to appletCreateLibraryApplet except this sets the creating_self flag to true.
Parameters
hAppletHolder object.
idSee AppletId.
modeSee LibAppletMode.

◆ appletCreateManagedDisplaySeparableLayer()

Result appletCreateManagedDisplaySeparableLayer ( u64 display_layer,
u64 recording_layer 
)

CreateManagedDisplaySeparableLayer.

Note
Only available with [10.0.0+].
Parameters
[out]display_layerOutput display_layer.
[out]recording_layerOutput recording_layer.

◆ appletCreateMovieMaker()

Result appletCreateMovieMaker ( Service srv_out,
TransferMemory tmem 
)

CreateMovieMaker.

Do not use this directly, use grcCreateMovieMaker instead.

Note
Only available with AppletType_*Application on [5.0.0+].
Parameters
[out]srv_outOutput Service for applet IMovieMaker.
[in]tmemTransferMemory

◆ appletCreateStorage()

Result appletCreateStorage ( AppletStorage s,
s64  size 
)

Creates a storage.

Parameters
sStorage object.
sizeSize of storage.

◆ appletCreateSystemApplication()

Result appletCreateSystemApplication ( AppletApplication a,
u64  system_application_id 
)

Creates a SystemApplication.

Note
Only available with AppletType_SystemApplet.
Parameters
[out]aAppletApplication
[in]system_application_idSystemApplicationId.

◆ appletCreateTransferMemoryStorage()

Result appletCreateTransferMemoryStorage ( AppletStorage s,
void *  buffer,
s64  size,
bool  writable 
)

Creates a TransferMemory storage.

Parameters
sStorage object.
bufferTransferMemory buffer, will be automatically allocated if NULL.
sizeSize of storage.
writableControls whether writing to the storage is allowed with appletStorageWrite.

◆ appletDeactivateMigrationService()

Result appletDeactivateMigrationService ( void  )

DeactivateMigrationService.

Note
Only available with [10.0.0+].

◆ appletDisableSleepTillShutdown()

Result appletDisableSleepTillShutdown ( void  )

DisableSleepTillShutdown.

Note
Only available with [11.0.0+].

◆ appletEndBlockingHomeButton()

Result appletEndBlockingHomeButton ( void  )

Ends the blocking started by appletBeginBlockingHomeButton.

Note
Only available with AppletType_*Application.

◆ appletEndBlockingHomeButtonShortAndLongPressed()

Result appletEndBlockingHomeButtonShortAndLongPressed ( void  )

Ends the blocking started by appletBeginBlockingHomeButtonShortAndLongPressed.

Note
Only available with AppletType_*Application.

◆ appletEndToWatchShortHomeButtonMessage()

Result appletEndToWatchShortHomeButtonMessage ( void  )

Forwards input to the foreground app.

Note
Only available with AppletType_OverlayApplet.
After calling this the overlay applet won't receive any input until appletBeginToWatchShortHomeButtonMessage is called again.

◆ appletExecuteProgram()

Result appletExecuteProgram ( s32  programIndex,
const void *  buffer,
size_t  size 
)

Launches Application {current_ApplicationId}+programIndex.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_*Application on [5.0.0+].
Creates the storage if needed. Uses cmd ClearUserChannel. Uses cmd UnpopToUserChannel when the storage was created. Lastly cmd ExecuteProgramCmd is used.
Parameters
[in]programIndexProgramIndex, must be 0x0-0xFF. 0 is the same as the current application. ProgramIndex values where the application is not installed should not be used.
[in]bufferOptional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL.
[in]sizeSize of the above buffer, 0 to not use the storage. Must be <=0x1000.

◆ appletExitAndRequestToShowThanksMessage()

Result appletExitAndRequestToShowThanksMessage ( void  )

Exit the application and return to the kiosk demo menu.

This terminates the current process. This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_*Application on [4.0.0+], on kiosk systems (QuestFlag set).

◆ appletFriendInvitationClearApplicationParameter()

Result appletFriendInvitationClearApplicationParameter ( void  )

Clears the StorageChannel/saved-ApplicationId used by appletFriendInvitationSetApplicationParameter.

Note
Only available on [9.0.0+].

◆ appletFriendInvitationPushApplicationParameter()

Result appletFriendInvitationPushApplicationParameter ( AccountUid  uid,
const void *  buffer,
u64  size 
)

Same as appletApplicationPushToFriendInvitationStorageChannel except this uses the MainApplication.

Note
Only available on [9.0.0+].
Parameters
[in]uidAccountUid
[in]bufferInput buffer.
[in]sizeInput buffer size.

◆ appletFriendInvitationSetApplicationParameter()

Result appletFriendInvitationSetApplicationParameter ( AppletStorage s,
u64  application_id 
)

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

Note
Only available on [9.0.0+].
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.
[in]application_idApplicationId

◆ appletGetAppletInfo()

AppletInfo* appletGetAppletInfo ( void  )

Gets the cached AppletInfo loaded during appletInitialize.

This will return NULL when the info is not initialized, due to not running as AppletType_LibraryApplet, or when any of the used cmds fail.

Note
Only available with AppletType_LibraryApplet.

◆ appletGetAppletResourceUsageInfo()

Result appletGetAppletResourceUsageInfo ( AppletResourceUsageInfo info)

Gets the AppletResourceUsageInfo.

Note
Only available on [6.0.0+].
Parameters
[out]infoAppletResourceUsageInfo

◆ appletGetAppletResourceUserIdOfCallerApplet()

Result appletGetAppletResourceUserIdOfCallerApplet ( u64 out)

Gets the AppletResourceUserId of the CallerApplet.

Note
Only available with [6.0.0+].
Parameters
[out]outAppletResourceUserId

◆ appletGetApplicationIdByContentActionName()

Result appletGetApplicationIdByContentActionName ( u64 application_id,
const char *  name 
)

Gets the ApplicationId for the specified ContentActionName string.

Note
Only available when the current applet is an AppletType_SystemApplication on [5.1.0+].
Parameters
[out]application_idApplicationId.
[in]nameContentActionName string.

◆ appletGetApplicationIdForLogo()

Result appletGetApplicationIdForLogo ( u64 application_id)

Gets the ApplicationId for displaying the logo screen during application launch.

Note
Only available with AppletType_OverlayApplet.
Parameters
[out]application_idOutput ApplicationId, 0 when no application is running.

◆ appletGetBootMode()

Result appletGetBootMode ( PmBootMode mode)

Gets the BootMode which originated from pmbmGetBootMode.

Parameters
[out]modePmBootMode

◆ appletGetBuiltInDisplayType()

Result appletGetBuiltInDisplayType ( s32 out)

GetBuiltInDisplayType.

Note
Only available with [11.0.0+].
Parameters
[out]outOutput value.

◆ appletGetCallerAppletCaptureImageEx()

Result appletGetCallerAppletCaptureImageEx ( void *  buffer,
size_t  size,
bool *  flag 
)

Gets the CallerApplet CaptureImage.

Parameters
[out]bufferOutput buffer containing the 1280x720 RGBA8 image.
[out]sizeBuffer size, must match 0x384000.
[out]flagOutput flag.

◆ appletGetCallerAppletIdentityInfo()

Result appletGetCallerAppletIdentityInfo ( AppletIdentityInfo info)

Gets the AppletIdentityInfo for the CallerApplet.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]infoAppletIdentityInfo

◆ appletGetCallerAppletIdentityInfoStack()

Result appletGetCallerAppletIdentityInfoStack ( AppletIdentityInfo stack,
s32  count,
s32 total_out 
)

Gets an array of AppletIdentityInfo for the CallerStack.

Note
Only available with AppletType_LibraryApplet on [3.0.0+].
Parameters
[out]stackOutput array of AppletIdentityInfo.
[in]countSize of the stack array.
[out]total_outTotal output entries.

◆ appletGetCradleFwVersion()

Result appletGetCradleFwVersion ( u32 out0,
u32 out1,
u32 out2,
u32 out3 
)

Gets the Dock firmware version.

Note
Only available with [2.0.0+].
Parameters
[out]out0First output value.
[out]out1Second output value.
[out]out2Third output value.
[out]out3Fourth output value.

◆ appletGetCradleStatus()

Result appletGetCradleStatus ( u8 status)

Gets the CradleStatus.

Parameters
[out]statusOutput Dock status.

◆ appletGetCurrentApplicationId()

Result appletGetCurrentApplicationId ( u64 application_id)

Gets the ApplicationId for the currently running Application.

Note
Only available with AppletType_LibraryApplet on [8.0.0+].
Parameters
[out]application_idOutput ApplicationId, 0 when no Application is running.

◆ appletGetCurrentIlluminance()

Result appletGetCurrentIlluminance ( float *  fLux)

Gets the current Illuminance from the light sensor.

Note
Only available with [3.0.0+].
Parameters
fLuxOutput fLux

◆ appletGetCurrentIlluminanceEx()

Result appletGetCurrentIlluminanceEx ( bool *  bOverLimit,
float *  fLux 
)

Gets the current Illuminance from the light sensor.

Same as appletGetCurrentIlluminance except for the additional param.

Note
Only available with [5.0.0+].
Parameters
bOverLimitOutput bOverLimit
fLuxOutput fLux

◆ appletGetCurrentPerformanceConfiguration()

Result appletGetCurrentPerformanceConfiguration ( u32 PerformanceConfiguration)

Gets the current PerformanceConfiguration.

Note
Only available with [7.0.0+].
Parameters
PerformanceConfigurationOutput PerformanceConfiguration.

◆ appletGetDefaultDisplayResolution()

Result appletGetDefaultDisplayResolution ( s32 width,
s32 height 
)

Gets the DefaultDisplayResolution.

Note
Only available with [3.0.0+].
Parameters
[out]widthOutput width.
[out]heightOutput height.

◆ appletGetDefaultDisplayResolutionChangeEvent()

Result appletGetDefaultDisplayResolutionChangeEvent ( Event out_event)

Gets an Event which is signaled when the output from appletGetDefaultDisplayResolution changes.

Note
Only available with [3.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=true.

◆ appletGetDesirableKeyboardLayout()

Result appletGetDesirableKeyboardLayout ( SetKeyboardLayout layout)

Gets the DesirableKeyboardLayout previously set by appletSetDesirableKeyboardLayout.

An error is returned when it's not set.

Note
Only available with AppletType_LibraryApplet on [4.0.0+].
Parameters
[out]layoutOutput SetKeyboardLayout.

◆ appletGetDesiredLanguage()

Result appletGetDesiredLanguage ( u64 LanguageCode)

Gets the DesiredLanguage for the current host application control.nacp.

Note
Only available with AppletType_*Application.
Parameters
[out]LanguageCodeOutput LanguageCode, see set.h.

◆ appletGetDisplayLogicalResolution()

Result appletGetDisplayLogicalResolution ( s32 width,
s32 height 
)

Gets the DisplayLogicalResolution.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [8.0.0+].
Parameters
[out]widthOutput width.
[out]heightOutput height.

◆ appletGetDisplayVersion()

Result appletGetDisplayVersion ( char *  displayVersion)

Gets the DisplayVersion for the current host application control.nacp.

Note
Only available with AppletType_*Application.
Parameters
[out]displayVersionOutput DisplayVersion string, must be at least 0x10-bytes. This is always NUL-terminated.

◆ appletGetExpectedMasterVolume()

Result appletGetExpectedMasterVolume ( float *  mainAppletVolume,
float *  libraryAppletVolume 
)

Gets the ExpectedMasterVolume for MainApplet and LibraryApplet.

Note
See also appletSetExpectedMasterVolume.
Parameters
[out]mainAppletVolumeMainApplet ExpectedMasterVolume. Optional, can be NULL. Used with cmd GetMainAppletExpectedMasterVolume when not NULL.
[out]libraryAppletVolumeLibraryApplet ExpectedMasterVolume. Optional, can be NULL. Used with cmd GetLibraryAppletExpectedMasterVolume when not NULL.

◆ appletGetFriendInvitationStorageChannelEvent()

Result appletGetFriendInvitationStorageChannelEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletTryPopFromFriendInvitationStorageChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
This is used by friendsGetFriendInvitationNotificationEvent.
Only available with AppletType_*Application on [9.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetGpuErrorDetectedSystemEvent()

Result appletGetGpuErrorDetectedSystemEvent ( Event out_event)

Gets an Event which is signaled for GpuErrorDetected.

Note
Only available with AppletType_*Application on [8.0.0+], or with AppletType_LibraryApplet on [9.0.0+].
The Event must be closed by the user once finished with it.
Official sw waits on this Event from a seperate thread, triggering an abort when it's signaled.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetHdcpAuthenticationFailedEvent()

Result appletGetHdcpAuthenticationFailedEvent ( Event out_event)

Gets an Event which is signaled for HdcpAuthenticationFailed.

Note
Only available with AppletType_SystemApplet on [4.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetHdcpAuthenticationState()

Result appletGetHdcpAuthenticationState ( s32 state)

Gets the HdcpAuthenticationState.

Note
Only available with [4.0.0+].
Parameters
[out]stateOutput state.

◆ appletGetHdcpAuthenticationStateChangeEvent()

Result appletGetHdcpAuthenticationStateChangeEvent ( Event out_event)

Gets an Event which is signaled when the output from appletGetHdcpAuthenticationState changes.

Note
Only available with [4.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=true.

◆ appletGetHealthWarningDisappearedSystemEvent()

Result appletGetHealthWarningDisappearedSystemEvent ( Event out_event)

GetHealthWarningDisappearedSystemEvent.

Note
Only available with AppletType_*Application on [9.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetHomeButtonDoubleClickEnabled()

Result appletGetHomeButtonDoubleClickEnabled ( bool *  out)

Gets whether HomeButtonDoubleClick is enabled.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [8.0.0+].
Parameters
[out]outOutput flag.

◆ appletGetHomeButtonReaderLockAccessor()

Result appletGetHomeButtonReaderLockAccessor ( AppletLockAccessor a)

Gets a AppletLockAccessor for HomeButtonReader.

Note
Similar to using appletGetReaderLockAccessorEx with inval=0.
Parameters
aLockAccessor object.

◆ appletGetHomeButtonWriterLockAccessor()

Result appletGetHomeButtonWriterLockAccessor ( AppletLockAccessor a)

Gets a AppletLockAccessor for HomeButtonWriter.

Note
Only available with AppletType_SystemApplet.
Similar to using appletGetWriterLockAccessorEx with inval=0.
Parameters
aLockAccessor object.

◆ appletGetIdleTimeDetectionExtension()

Result appletGetIdleTimeDetectionExtension ( AppletIdleTimeDetectionExtension ext)

Gets the value set by appletSetIdleTimeDetectionExtension.

Parameters
[out]extAppletIdleTimeDetectionExtension

◆ appletGetIndirectLayerProducerHandle()

Result appletGetIndirectLayerProducerHandle ( u64 out)

Gets the IndirectLayerProducerHandle.

Note
Only available with AppletType_LibraryApplet on [2.0.0+].
Parameters
[out]outOutput IndirectLayerProducerHandle.

◆ appletGetLastApplicationCaptureImageEx()

Result appletGetLastApplicationCaptureImageEx ( void *  buffer,
size_t  size,
bool *  flag 
)

Gets the LastApplication CaptureImage.

Parameters
[out]bufferOutput buffer containing the 1280x720 RGBA8 image.
[out]sizeBuffer size, must match 0x384000.
[out]flagOutput flag.

◆ appletGetLastApplicationExitReason()

Result appletGetLastApplicationExitReason ( s32 out)

GetLastApplicationExitReason.

Note
Only available with AppletType_*Application on [11.0.0+].
Parameters
[out]outOutput value.

◆ appletGetLastForegroundCaptureImageEx()

Result appletGetLastForegroundCaptureImageEx ( void *  buffer,
size_t  size,
bool *  flag 
)

Gets the LastForeground CaptureImage.

Parameters
[out]bufferOutput buffer containing the 1280x720 RGBA8 image.
[out]sizeBuffer size, must match 0x384000.
[out]flagOutput flag.

◆ appletGetLaunchStorageInfoForDebug()

Result appletGetLaunchStorageInfoForDebug ( NcmStorageId app_storageId,
NcmStorageId update_storageId 
)

Gets the LaunchStorageInfo.

Note
Only available with AppletType_*Application on [2.0.0+], or with AppletType_LibraryApplet on [9.0.0+].
Parameters
[out]app_storageIdSame as AppletApplicationLaunchProperty::app_storageId.
[out]update_storageIdSame as AppletApplicationLaunchProperty::update_storageId.

◆ appletGetLibraryAppletInfo()

Result appletGetLibraryAppletInfo ( LibAppletInfo info)

Gets the LibAppletInfo for the current LibraryApplet.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]infoLibAppletInfo

◆ appletGetMainAppletApplicationControlProperty()

Result appletGetMainAppletApplicationControlProperty ( NacpStruct nacp)

Gets the NacpStruct for the MainApplet.

Note
Only available with AppletType_LibraryApplet on [2.0.0+].
Parameters
[out]nacpNacpStruct

◆ appletGetMainAppletApplicationDesiredLanguage()

Result appletGetMainAppletApplicationDesiredLanguage ( u64 LanguageCode)

Gets the DesiredLanguage for the MainApplet.

Note
Only available with AppletType_LibraryApplet on [4.0.0+].
Parameters
[out]LanguageCodeOutput LanguageCode, see set.h.

◆ appletGetMainAppletAvailableUsers()

Result appletGetMainAppletAvailableUsers ( AccountUid uids,
s32  count,
bool *  flag,
s32 total_out 
)

Gets an array of userIds for the MainApplet AvailableUsers.

Note
Only available with AppletType_LibraryApplet on [6.0.0+].
Parameters
[out]uidsOutput array of AccountUid.
[in]countSize of the uids array in entries, must be at least ACC_USER_LIST_SIZE.
[out]flagWhen true, this indicates that no users are available.
[out]total_outTotal output entries. This is -1 when flag is true.

◆ appletGetMainAppletIdentityInfo()

Result appletGetMainAppletIdentityInfo ( AppletIdentityInfo info)

Gets the AppletIdentityInfo for the MainApplet.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]infoAppletIdentityInfo

◆ appletGetMainAppletStorageId()

Result appletGetMainAppletStorageId ( NcmStorageId storageId)

Gets the NcmStorageId for the MainApplet.

Note
Only available with AppletType_LibraryApplet on [2.0.0+].
Parameters
[out]storageIdNcmStorageId

◆ appletGetNextReturnDestinationAppletIdentityInfo()

Result appletGetNextReturnDestinationAppletIdentityInfo ( AppletIdentityInfo info)

Gets the AppletIdentityInfo for the NextReturnDestinationApplet.

Note
Only available with AppletType_LibraryApplet on [4.0.0+].
Parameters
[out]infoAppletIdentityInfo

◆ appletGetNotificationStorageChannelEvent()

Result appletGetNotificationStorageChannelEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletTryPopFromNotificationStorageChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
This is used by notifGetNotificationSystemEvent.
Only available with AppletType_*Application on [9.0.0+].
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetOperationModeSystemInfo()

Result appletGetOperationModeSystemInfo ( u32 info)

Gets the OperationModeSystemInfo.

Note
Only available with [7.0.0+].
Parameters
[out]infoOutput info.

◆ appletGetPopExtraStorageEvent()

Result appletGetPopExtraStorageEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletPopExtraStorage where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
Only available with AppletType_LibraryApplet.
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetPopFromGeneralChannelEvent()

Result appletGetPopFromGeneralChannelEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletPopFromGeneralChannel where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
Only available with AppletType_SystemApplet.
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetPopInDataEvent()

Result appletGetPopInDataEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletPopInData where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
Only available with AppletType_LibraryApplet.
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetPopInteractiveInDataEvent()

Result appletGetPopInteractiveInDataEvent ( Event out_event)

Gets an Event which is signaled when a new storage is available with appletPopInteractiveInData where previously no storage was available, this event is automatically cleared by the system once the last storage is popped.

Note
Only available with AppletType_LibraryApplet.
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGetPreviousProgramIndex()

Result appletGetPreviousProgramIndex ( s32 programIndex)

Gets the ProgramIndex of the program which launched this program.

Note
Only available with AppletType_*Application on [5.0.0+].
Parameters
[out]programIndexProgramIndex, -1 when there was no previous program.

◆ appletGetProgramTotalActiveTime()

Result appletGetProgramTotalActiveTime ( u64 activeTime)

Gets the total time in nanoseconds that the current process was actively running (not suspended), relative to when appletInitialize was last used.

Note
Only available with [6.0.0+].
Parameters
[out]activeTimeOutput nanoseconds value.

◆ appletGetPseudoDeviceId()

Result appletGetPseudoDeviceId ( Uuid out)

Gets the PseudoDeviceId.

This is derived from the output of a ns command, and from data in the host application control.nacp.

Note
Only available with AppletType_*Application on [2.0.0+].
Parameters
[out]outOutput PseudoDeviceId.

◆ appletGetReaderLockAccessorEx()

Result appletGetReaderLockAccessorEx ( AppletLockAccessor a,
u32  inval 
)

Gets a Reader AppletLockAccessor.

Note
Only available with [2.0.0+].
Parameters
aLockAccessor object.
[in]invalInput value, must be 0-3. 0 = HomeButton.

◆ appletGetSettingsPlatformRegion()

Result appletGetSettingsPlatformRegion ( SetSysPlatformRegion out)

This uses setsysGetPlatformRegion internally.

Note
Only available with [9.0.0+].
Parameters
[out]outSetSysPlatformRegion

◆ appletGetSystemSharedBufferHandle()

Result appletGetSystemSharedBufferHandle ( u64 SharedBufferHandle)

Same as appletGetSystemSharedLayerHandle except this just gets the SharedBufferHandle.

Note
Only available with [5.0.0+]. Not usable with AppletType_*Application.
Parameters
[out]SharedBufferHandleOutput System SharedBufferHandle.

◆ appletGetSystemSharedLayerHandle()

Result appletGetSystemSharedLayerHandle ( u64 SharedBufferHandle,
u64 SharedLayerHandle 
)

Gets the System SharedBufferHandle and SharedLayerHandle.

Note
Only available with [4.0.0+]. Not usable with AppletType_*Application.
Parameters
[out]SharedBufferHandleOutput System SharedBufferHandle.
[out]SharedLayerHandleOutput System SharedLayerHandle.

◆ appletGetWakeupCount()

Result appletGetWakeupCount ( u64 out)

GetWakeupCount.

Note
Only available with [11.0.0+].
Parameters
[out]outOutput value.

◆ appletGetWriterLockAccessorEx()

Result appletGetWriterLockAccessorEx ( AppletLockAccessor a,
u32  inval 
)

Gets a Writer AppletLockAccessor.

Note
Only available with [7.0.0+]. On older sysvers, this is only available with AppletType_SystemApplet on [2.0.0+].
Parameters
aLockAccessor object.
[in]invalInput value, must be 0-3. 0 = HomeButton.

◆ appletGpuErrorHandlerClose()

void appletGpuErrorHandlerClose ( AppletGpuErrorHandler g)

◆ appletGpuErrorHandlerFinishManualGpuErrorHandling()

Result appletGpuErrorHandlerFinishManualGpuErrorHandling ( AppletGpuErrorHandler g)

FinishManualGpuErrorHandling.

Parameters
gAppletGpuErrorHandler

◆ appletGpuErrorHandlerGetManualGpuErrorDetectionSystemEvent()

Result appletGpuErrorHandlerGetManualGpuErrorDetectionSystemEvent ( AppletGpuErrorHandler g,
Event out_event 
)

GetManualGpuErrorDetectionSystemEvent.

Parameters
gAppletGpuErrorHandler
Note
The Event must be closed by the user once finished with it.
Parameters
[out]out_eventOutput Event with autoclear=false.

◆ appletGpuErrorHandlerGetManualGpuErrorInfo()

Result appletGpuErrorHandlerGetManualGpuErrorInfo ( AppletGpuErrorHandler g,
void *  buffer,
size_t  size,
u64 out 
)

GetManualGpuErrorInfo.

Parameters
gAppletGpuErrorHandler
[out]bufferOutput buffer.
[in]sizeOutput buffer size, must be >= the output size from appletGpuErrorHandlerGetManualGpuErrorInfoSize.
[out]outOutput value.

◆ appletGpuErrorHandlerGetManualGpuErrorInfoSize()

Result appletGpuErrorHandlerGetManualGpuErrorInfoSize ( AppletGpuErrorHandler g,
u64 out 
)

Gets the size of the info available with appletGpuErrorHandlerGetManualGpuErrorInfo.

Parameters
gAppletGpuErrorHandler
[out]outOutput size.

◆ appletHolderCheckFinished()

bool appletHolderCheckFinished ( AppletHolder h)

Waits on the LibraryApplet StateChangedEvent with timeout=0, and returns whether it was successful.

Parameters
hAppletHolder object.

◆ appletHolderGetExitEvent()

static Event* appletHolderGetExitEvent ( AppletHolder h)
inlinestatic

Gets the LibraryApplet StateChangedEvent.

Parameters
hAppletHolder object.

◆ appletHolderGetExitReason()

LibAppletExitReason appletHolderGetExitReason ( AppletHolder h)

Gets the LibAppletExitReason set by appletHolderJoin.

Parameters
hAppletHolder object.

◆ appletHolderGetIndirectLayerConsumerHandle()

Result appletHolderGetIndirectLayerConsumerHandle ( AppletHolder h,
u64 out 
)

Gets the IndirectLayerConsumerHandle loaded during appletCreateLibraryApplet, on [2.0.0+].

Note
Only available when LibAppletMode is LibAppletMode_BackgroundIndirect.
Parameters
hAppletHolder object.
outOutput IndirectLayerConsumerHandle.

◆ appletHolderGetLibraryAppletInfo()

Result appletHolderGetLibraryAppletInfo ( AppletHolder h,
LibAppletInfo info 
)

Gets the LibAppletInfo for the specified LibraryApplet.

Parameters
hAppletHolder object.
[out]infoLibAppletInfo

◆ appletHolderGetPopInteractiveOutDataEvent()

Result appletHolderGetPopInteractiveOutDataEvent ( AppletHolder h,
Event **  out_event 
)

Gets the PopInteractiveOutDataEvent.

Parameters
hAppletHolder object.
[out]out_eventOutput Event.

◆ appletHolderJoin()

void appletHolderJoin ( AppletHolder h)

Waits for the LibraryApplet to exit.

Parameters
hAppletHolder object.

◆ appletHolderJump()

Result appletHolderJump ( AppletHolder h)

Jumps to the LibraryApplet, with the current-LibraryApplet being terminated.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_LibraryApplet.
Parameters
hAppletHolder object.

◆ appletHolderPopInteractiveOutData()

Result appletHolderPopInteractiveOutData ( AppletHolder h,
AppletStorage s 
)

Pops a storage from LibraryApplet Interactive output.

Parameters
hAppletHolder object.
[out]sStorage object.

◆ appletHolderPopOutData()

Result appletHolderPopOutData ( AppletHolder h,
AppletStorage s 
)

Pops a storage from LibraryApplet output.

Parameters
hAppletHolder object.
[out]sStorage object.

◆ appletHolderPresetLibraryAppletGpuTimeSliceZero()

Result appletHolderPresetLibraryAppletGpuTimeSliceZero ( AppletHolder h)

PresetLibraryAppletGpuTimeSliceZero.

Note
Only available with [10.0.0+].
Parameters
hAppletHolder object.

◆ appletHolderPushExtraStorage()

Result appletHolderPushExtraStorage ( AppletHolder h,
AppletStorage s 
)

Pushes a storage for LibraryApplet Extra storage input.

Note
This uses appletStorageClose automatically.
Parameters
hAppletHolder object.
[in]sStorage object.

◆ appletHolderPushInData()

Result appletHolderPushInData ( AppletHolder h,
AppletStorage s 
)

Pushes a storage for LibraryApplet input.

Note
This uses appletStorageClose automatically.
Parameters
hAppletHolder object.
[in]sStorage object.

◆ appletHolderPushInteractiveInData()

Result appletHolderPushInteractiveInData ( AppletHolder h,
AppletStorage s 
)

Pushes a storage for LibraryApplet Interactive input.

Note
This uses appletStorageClose automatically.
Parameters
hAppletHolder object.
[in]sStorage object.

◆ appletHolderRequestExit()

Result appletHolderRequestExit ( AppletHolder h)

Requests the LibraryApplet to exit.

The command is only used if appletHolderCheckFinished returns false.

Parameters
hAppletHolder object.

◆ appletHolderRequestExitOrTerminate()

Result appletHolderRequestExitOrTerminate ( AppletHolder h,
u64  timeout 
)

Uses cmds GetAppletStateChangedEvent and RequestExit, then waits for the LibraryApplet to exit with the specified timeout.

If a timeout occurs, the Terminate cmd is used.

Parameters
hAppletHolder object.
[in]timeoutTimeout in nanoseconds. UINT64_MAX for no timeout.

◆ appletHolderSetOutOfFocusApplicationSuspendingEnabled()

Result appletHolderSetOutOfFocusApplicationSuspendingEnabled ( AppletHolder h,
bool  flag 
)

Sets OutOfFocusApplicationSuspendingEnabled.

Note
Only available with AppletType_*Application.
Parameters
hAppletHolder object.
[in]flagFlag

◆ appletHolderStart()

Result appletHolderStart ( AppletHolder h)

Starts the LibraryApplet.

Parameters
hAppletHolder object.

◆ appletHolderTerminate()

Result appletHolderTerminate ( AppletHolder h)

Terminate the LibraryApplet.

Parameters
hAppletHolder object.

◆ appletHolderWaitInteractiveOut()

bool appletHolderWaitInteractiveOut ( AppletHolder h)

Waits for the PopInteractiveOutDataEvent and StateChangedEvent.

Returns
false for error / when StateChangedEvent was signaled, and true when PopInteractiveOutDataEvent was signaled. The latter is signaled when a new storage is available with appletHolderPopInteractiveOutData where previously no storage was available (this willl not clear the event), this event is automatically cleared by the system once the last storage is popped.
Parameters
hAppletHolder object.

◆ appletHook()

void appletHook ( AppletHookCookie cookie,
AppletHookFn  callback,
void *  param 
)

Sets up an applet status hook.

Parameters
cookieHook cookie to use.
callbackFunction to call when applet's status changes.
paramUser-defined parameter to pass to the callback.

◆ appletInitializeApplicationCopyrightFrameBuffer()

Result appletInitializeApplicationCopyrightFrameBuffer ( void  )

Initializes the ApplicationCopyrightFrameBuffer, with dimensions 1280x720 + the tmem for it.

This is used as an overlay for screenshots.

Note
Only available with AppletType_*Application on [5.0.0+].
Cleanup for this is handled automatically during app exit in appletExit.

◆ appletInitializeGamePlayRecording()

Result appletInitializeGamePlayRecording ( void  )

Initializes video recording.

This allocates a 0x6000000-byte buffer for the TransferMemory, cleanup is handled automatically during app exit in appletExit. Only available with AppletType_Application on [3.0.0+], hence errors from this can be ignored. Video recording is only fully available system-side with [4.0.0+]. Only usable when running under an application which supports video recording. Using this is only needed when the host application control.nacp has VideoCaptureMode set to Enabled, with Automatic appletInitializeGamePlayRecording is not needed.

◆ appletIsAutoPowerDownRequested()

Result appletIsAutoPowerDownRequested ( bool *  out)

IsAutoPowerDownRequested.

Uses an idle:sys cmd internally.

Note
Only available with AppletType_SystemApplet on [7.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsAutoSleepDisabled()

Result appletIsAutoSleepDisabled ( bool *  out)

Gets AutoSleepDisabled.

Note
Only available with [5.0.0+].
Parameters
[out]outOutput flag

◆ appletIsForceTerminateApplicationDisabledForDebug()

Result appletIsForceTerminateApplicationDisabledForDebug ( bool *  out)

IsForceTerminateApplicationDisabledForDebug.

Note
Only available with AppletType_SystemApplet on [9.0.0+].
Parameters
[out]outOutput flag. 0 when DebugMode is not enabled, otherwise this is loaded from a system-setting.

◆ appletIsGamePlayRecordingSupported()

Result appletIsGamePlayRecordingSupported ( bool *  flag)

Gets whether video recording is supported.

See also appletInitializeGamePlayRecording.

◆ appletIsHealthWarningRequired()

Result appletIsHealthWarningRequired ( bool *  out)

IsHealthWarningRequired.

Note
Only available with AppletType_OverlayApplet on [10.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsHomeButtonShortPressedBlocked()

Result appletIsHomeButtonShortPressedBlocked ( bool *  out)

IsHomeButtonShortPressedBlocked.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [10.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsIlluminanceAvailable()

Result appletIsIlluminanceAvailable ( bool *  out)

Gets whether Illuminance is available.

Note
Only available with [3.0.0+].
Parameters
outOutput flag

◆ appletIsInControllerFirmwareUpdateSection()

Result appletIsInControllerFirmwareUpdateSection ( bool *  out)

Gets the ControllerFirmwareUpdateSection flag.

Note
Only available with [3.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsSleepEnabled()

Result appletIsSleepEnabled ( bool *  out)

IsSleepEnabled.

Note
Only available with AppletType_SystemApplet on [11.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsSystemBufferSharingEnabled()

Result appletIsSystemBufferSharingEnabled ( void  )

Checks whether SystemBufferSharing is enabled, throwing an error otherwise.

Note
Only available with [4.0.0+]. Not usable with AppletType_*Application.

◆ appletIsVrModeCurtainRequired()

Result appletIsVrModeCurtainRequired ( bool *  out)

IsVrModeCurtainRequired.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [11.0.0+].
Parameters
[out]outOutput flag.

◆ appletIsVrModeEnabled()

Result appletIsVrModeEnabled ( bool *  out)

Gets whether VrMode is enabled.

Note
Only available with [3.0.0+].
Parameters
outOutput flag

◆ appletJumpToSubApplicationProgramForDevelopment()

Result appletJumpToSubApplicationProgramForDevelopment ( u64  application_id,
const void *  buffer,
size_t  size 
)

Launches the specified ApplicationId.

Note
Only available with AppletType_*Application on [5.0.0+], with DebugMode enabled.
Creates the storage if needed. Uses cmd ClearUserChannel. Uses cmd UnpopToUserChannel when the storage was created. Lastly cmd ExecuteProgramCmd is used.
Parameters
[in]application_idApplicationId.
[in]bufferOptional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL.
[in]sizeSize of the above buffer, 0 to not use the storage. Must be <=0x1000.

◆ appletLaunchDevMenu()

Result appletLaunchDevMenu ( void  )

Launches DevMenu and the dev Overlay-applet.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_SystemApplet on [8.0.0+].
This verifies that DebugMode is enabled, then uses a ns cmd. That cmd then loads the system-settings for these two ProgramIds (which normally only exist on devunits), and verifies that these programs are installed + launches them.

◆ appletLoadAndApplyIdlePolicySettings()

Result appletLoadAndApplyIdlePolicySettings ( void  )

LoadAndApplyIdlePolicySettings.

Uses an idle:sys cmd internally.

Note
Only available with AppletType_SystemApplet.

◆ appletLockAccessorClose()

void appletLockAccessorClose ( AppletLockAccessor a)

Closes a LockAccessor.

Parameters
aLockAccessor object.

◆ appletLockAccessorLock()

Result appletLockAccessorLock ( AppletLockAccessor a)

Lock a LockAccessor.

Note
Similar to appletLockAccessorTryLock, except this uses timeout UINT64_MAX with the eventWait call, and this uses TryLock repeatedly until the output flag value is true.
Parameters
aLockAccessor object.

◆ appletLockAccessorTryLock()

Result appletLockAccessorTryLock ( AppletLockAccessor a,
bool *  flag 
)

TryLock a LockAccessor.

Parameters
aLockAccessor object.
[out]flagWhether locking was successful, when false this indicates that this func should be called again.

◆ appletLockAccessorUnlock()

Result appletLockAccessorUnlock ( AppletLockAccessor a)

Unlock a LockAccessor.

Parameters
aLockAccessor object.

◆ appletLockExit()

Result appletLockExit ( void  )

Delay exiting until appletUnlockExit is called, with a 15 second timeout once exit is requested.

Note
When exit is requested appletMainLoop will return false, hence any main-loop using appletMainLoop will exit. This allows the app to handle cleanup post-main-loop instead of being force-terminated.
If the above timeout occurs after exit was requested where appletUnlockExit was not called, the process will be forced-terminated.
appletUnlockExit must be used before main() returns.

◆ appletLockForeground()

Result appletLockForeground ( void  )

LockForeground.

Note
Only available with AppletType_SystemApplet.

◆ appletMainLoop()

bool appletMainLoop ( void  )

Processes the current applet status.

Generally used within a main loop.

Note
Uses appletGetMessage and appletProcessMessage internally.
Returns
Whether the application should continue running.

◆ appletNotifyCecSettingsChanged()

Result appletNotifyCecSettingsChanged ( void  )

NotifyCecSettingsChanged.

Uses an omm cmd internally.

Note
Only available with AppletType_SystemApplet on [2.0.0+].

◆ appletNotifyRunning()

void appletNotifyRunning ( bool *  out)

Notify that the app is now running, for the Application logo screen.

This throws a fatal-error on failure.

Note
This will just return when applet-type isn't AppletType_Application, or when this was already used previously. Used automatically by appletInitialize when __nx_applet_auto_notifyrunning is set to true (the default value).

◆ appletOpenMainApplication()

Result appletOpenMainApplication ( AppletApplication a)

Open an AppletApplication for the currently running Application.

Note
Should not be used when no Application is running.
Only available on [1.0.0-9.2.0].
Parameters
[out]aAppletApplication

◆ appletOpenMyGpuErrorHandler()

Result appletOpenMyGpuErrorHandler ( AppletGpuErrorHandler g)

Opens an AppletGpuErrorHandler.

Note
The cached value loaded from setsysGetDebugModeFlag must be 1, otherwise an error is returned.
Only available with [11.0.0+].
Parameters
[out]gAppletGpuErrorHandler

◆ appletOverrideAutoSleepTimeAndDimmingTime()

Result appletOverrideAutoSleepTimeAndDimmingTime ( s32  inval0,
s32  inval1,
s32  inval2,
s32  inval3 
)

OverrideAutoSleepTimeAndDimmingTime.

Parameters
[in]inval0Unknown input value.
[in]inval1Unknown input value.
[in]inval2Unknown input value.
[in]inval3Unknown input value.

◆ appletPerformSystemButtonPressing()

Result appletPerformSystemButtonPressing ( AppletSystemButtonType  type)

Perform SystemButtonPressing with the specified AppletSystemButtonType.

Parameters
[in]typeAppletSystemButtonType

◆ appletPerformSystemButtonPressingIfInFocus()

Result appletPerformSystemButtonPressingIfInFocus ( AppletSystemButtonType  type)

Perform SystemButtonPressing with the specified AppletSystemButtonType.

Internally this cmd checks a state field, verifies that the type is allowed, then runs the same func as appletPerformSystemButtonPressing internally.

Note
Only available with [6.0.0+].
Parameters
[in]typeAppletSystemButtonType

◆ appletPopContext()

Result appletPopContext ( AppletStorage s)

Pops a storage from the ContextStack.

Normally this should only be used when AppletInfo::caller_flag is true.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]sStorage object.

◆ appletPopExtraStorage()

Result appletPopExtraStorage ( AppletStorage s)

Pops a storage from current-LibraryApplet Extra input.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]sStorage object.

◆ appletPopFloatingApplicationForDevelopment()

Result appletPopFloatingApplicationForDevelopment ( AppletApplication a)

PopFloatingApplicationForDevelopment.

Note
Only available with AppletType_SystemApplet. Should not be used if no FloatingApplication is available.
Parameters
[out]aAppletApplication

◆ appletPopFromGeneralChannel()

Result appletPopFromGeneralChannel ( AppletStorage s)

Pops a storage from the general channel.

Note
Only available with AppletType_SystemApplet.
Parameters
[out]sStorage object.

◆ appletPopInData()

Result appletPopInData ( AppletStorage s)

Pops a storage from current-LibraryApplet input.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]sStorage object.

◆ appletPopInteractiveInData()

Result appletPopInteractiveInData ( AppletStorage s)

Pops a storage from current-LibraryApplet Interactive input.

Note
Only available with AppletType_LibraryApplet.
Parameters
[out]sStorage object.

◆ appletPopLaunchParameter()

Result appletPopLaunchParameter ( AppletStorage s,
AppletLaunchParameterKind  kind 
)

Pops a LaunchParameter AppletStorage, the storage will be removed from sysmodule state during this.

Parameters
[out]sOutput storage.
kindSee AppletLaunchParameterKind.
Note
Only available with AppletType_*Application.
See also acc.h accountGetPreselectedUser (wrapper for appletPopLaunchParameter etc).

◆ appletPopLaunchRequestedApplication()

Result appletPopLaunchRequestedApplication ( AppletApplication a)

Pops a AppletApplication for a requested Application launch.

Note
Only available with AppletType_SystemApplet.
Parameters
[out]aAppletApplication

◆ appletPopRequestLaunchApplicationForDebug()

Result appletPopRequestLaunchApplicationForDebug ( AccountUid uids,
s32  count,
u64 application_id,
s32 total_out 
)

PopRequestLaunchApplicationForDebug.

Note
Only available with AppletType_SystemApplet on [6.0.0+].
Parameters
[out]uidsOutput array of AccountUid.
[in]countSize of the uids array in entries, must be at least the size stored in state.
[out]application_idOutput ApplicationId.
[out]total_outTotal output userID entries.

◆ appletPrepareForJit()

Result appletPrepareForJit ( void  )

Launches the jit-sysmodule when it was not previously launched by this cmd.

Returns 0 when it was previously launched.

Note
Only available with AppletType_*Application on [5.0.0+].
Requires the jit-sysmodule to actually be installed.

◆ appletProcessMessage()

bool appletProcessMessage ( u32  msg)

Processes the current applet status using the specified msg.

Parameters
msgNotification message, normally from appletGetMessage.
Returns
Whether the application should continue running.

◆ appletPushContext()

Result appletPushContext ( AppletStorage s)

Pushes a storage to the ContextStack.

Normally this should only be used when AppletInfo::caller_flag is true.

Note
Only available with AppletType_LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletPushInteractiveOutData()

Result appletPushInteractiveOutData ( AppletStorage s)

Pushes a storage for current-LibraryApplet Interactive output.

Note
Only available with AppletType_LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletPushOutData()

Result appletPushOutData ( AppletStorage s)

Pushes a storage for current-LibraryApplet output.

Note
Only available with AppletType_LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletPushToAppletBoundChannel()

Result appletPushToAppletBoundChannel ( AppletStorage s)

This is similar to appletPushToAppletBoundChannelForDebug (no DebugMode check), except the used channel is loaded from elsewhere and must be in the range 31-32.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [9.0.0+].
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletPushToAppletBoundChannelForDebug()

Result appletPushToAppletBoundChannelForDebug ( AppletStorage s,
s32  channel 
)

The channel must match the value already stored in state when the state value is non-zero, otherwise an error is returned.

When the state value is 0, the channel is written into state. Then the input storage is pushed to the StorageChannel.

Note
Only available on [9.0.0+]. DebugMode must be enabled.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.
[in]channelChannel.

◆ appletPushToGeneralChannel()

Result appletPushToGeneralChannel ( AppletStorage s)

Pushes a storage to the general channel.

Used for sending requests to SystemApplet.

Note
This is not usable under an Application, however it is usable under a LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletQueryApplicationPlayStatistics()

Result appletQueryApplicationPlayStatistics ( PdmApplicationPlayStatistics stats,
const u64 application_ids,
s32  count,
s32 total_out 
)

Gets ApplicationPlayStatistics.

Note
Only available with AppletType_*Application on [5.0.0+].
The input ApplicationIds must be allowed via control.nacp with the current host application. The minimum allowed ApplicationId is the ApplicationId for the current application.
Parameters
statsOutput PdmApplicationPlayStatistics array.
application_idsInput ApplicationIds array.
countTotal entries in the input/output arrays.
total_outTotal output entries.

◆ appletQueryApplicationPlayStatisticsByUid()

Result appletQueryApplicationPlayStatisticsByUid ( AccountUid  uid,
PdmApplicationPlayStatistics stats,
const u64 application_ids,
s32  count,
s32 total_out 
)

Same as appletQueryApplicationPlayStatistics except this gets playstats specific to the input userId.

Note
Only available with AppletType_*Application on [6.0.0+].
Parameters
[in]uidAccountUid
[out]statsOutput PdmApplicationPlayStatistics array.
[in]application_idsInput ApplicationIds array.
[in]countTotal entries in the input/output arrays.
[out]total_outTotal output entries.

◆ appletReadThemeStorage()

Result appletReadThemeStorage ( void *  buffer,
size_t  size,
u64  offset,
u64 transfer_size 
)

Reads the ThemeStorage for the current applet.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [7.0.0+].
offset(+size) must be <=0x400.
Parameters
[out]bufferOutput buffer data.
[in]sizeSize to read.
[in]offsetOffset within the ThemeStorage.
[out]transfer_sizeActual read size.

◆ appletReleaseCallerAppletCaptureSharedBuffer()

Result appletReleaseCallerAppletCaptureSharedBuffer ( void  )

Release the CallerApplet CaptureSharedBuffer.

Note
Only available with [4.0.0+].

◆ appletReleaseLastApplicationCaptureSharedBuffer()

Result appletReleaseLastApplicationCaptureSharedBuffer ( void  )

Release the LastApplication CaptureSharedBuffer.

Note
Only available with [4.0.0+].

◆ appletReleaseLastForegroundCaptureSharedBuffer()

Result appletReleaseLastForegroundCaptureSharedBuffer ( void  )

Release the LastForeground CaptureSharedBuffer.

Note
Only available with [4.0.0+].

◆ appletReleaseSleepLockTransiently()

Result appletReleaseSleepLockTransiently ( void  )

Release the SleepLock transiently.

Note
On success, this then uses cmd GetAcquiredSleepLockEvent and waits on that event.

◆ appletReportUserIsActive()

Result appletReportUserIsActive ( void  )

Reports that the user is active, for idle detection (screen dimming / auto-sleep).

This is equivalent to when the user uses HID input.

Note
Only available with [2.0.0+].

◆ appletRequestExitToSelf()

Result appletRequestExitToSelf ( void  )

Exits the current applet.

Same as appletHolderRequestExit except this is for the current applet.

Note
Only available with AppletType_LibraryApplet on [6.0.0+].

◆ appletRequestFlushGamePlayingMovieForDebug()

Result appletRequestFlushGamePlayingMovieForDebug ( void  )

Requests to save the video recording, as if the Capture-button was held.

Note
Only available with AppletType_*Application on [4.0.0+].

◆ appletRequestLaunchApplication()

Result appletRequestLaunchApplication ( u64  application_id,
AppletStorage s 
)

Requests to launch the specified application.

Note
Only available with AppletType_*Application, or AppletType_LibraryApplet on [5.0.0+].
Parameters
[in]application_idApplicationId. Value 0 can be used to relaunch the current application.
[in]sOptional AppletStorage object, can be NULL. This is automatically closed. When NULL on pre-4.0.0 (or with AppletType_LibraryApplet), this will internally create a tmp storage with size 0 for use with the cmd. This is the storage available to the launched application via appletPopLaunchParameter with AppletLaunchParameterKind_UserChannel.

◆ appletRequestLaunchApplicationForQuest()

Result appletRequestLaunchApplicationForQuest ( u64  application_id,
AppletStorage s,
const AppletApplicationAttributeForQuest attr 
)

Requests to launch the specified application, for kiosk systems.

Note
Only available with AppletType_*Application on [3.0.0+].
Identical to appletRequestLaunchApplication, except this allows the user to specify the attribute fields instead of the defaults being used.
Parameters
[in]application_idApplicationId
[in]sOptional AppletStorage object, can be NULL. This is automatically closed. When NULL on pre-4.0.0, this will internally create a tmp storage with size 0 for use with the cmd. This is the storage available to the launched application via appletPopLaunchParameter with AppletLaunchParameterKind_UserChannel.
[in]attrKiosk application attributes.

◆ appletRequestLaunchApplicationWithUserAndArgumentForDebug()

Result appletRequestLaunchApplicationWithUserAndArgumentForDebug ( u64  application_id,
const AccountUid uids,
s32  total_uids,
bool  flag,
const void *  buffer,
size_t  size 
)

Requests to launch the specified Application, with the specified users.

Note
Only available on [6.0.0+].
Parameters
[in]application_idApplicationId.
[in]uidsInput array of AccountUid.
[in]total_uidsTotal input uids, must be <=ACC_USER_LIST_SIZE.
[in]flagWhether to use the specified buffer to create a storage which will be pushed for AppletLaunchParameterKind_UserChannel.
[in]bufferBuffer containing the above storage data.
[in]sizeSize of the storage buffer.

◆ appletRequestToAcquireSleepLock()

Result appletRequestToAcquireSleepLock ( void  )

Request to AcquireSleepLock.

Note
On success, this then uses cmd GetAcquiredSleepLockEvent and waits on that event.

◆ appletRequestToGetForeground()

Result appletRequestToGetForeground ( void  )

RequestToGetForeground.

Note
Only available with AppletType_SystemApplet.

◆ appletRequestToReboot()

Result appletRequestToReboot ( void  )

Requests a system reboot.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_*Application on [3.0.0+].

◆ appletRequestToShutdown()

Result appletRequestToShutdown ( void  )

Requests a system shutdown.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_*Application on [3.0.0+].

◆ appletRequestToSleep()

Result appletRequestToSleep ( void  )

RequestToSleep.

Note
Only available with AppletType_*Application on [10.0.0+].

◆ appletReserveResourceForMovieOperation()

Result appletReserveResourceForMovieOperation ( void  )

ReserveResourceForMovieOperation.

Must be used at some point prior to appletCreateGameMovieTrimmer.

Note
Only available with AppletType_LibraryApplet on [5.0.0+].

◆ appletRestartProgram()

Result appletRestartProgram ( const void *  buffer,
size_t  size 
)

Relaunches the current Application.

Note
Only available with AppletType_*Application on [5.0.0+].
Creates the storage if needed. Uses cmd ClearUserChannel. Uses cmd UnpopToUserChannel when the storage was created. Lastly cmd ExecuteProgramCmd is used.
Parameters
[in]bufferOptional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL.
[in]sizeSize of the above buffer, 0 to not use the storage. Must be <=0x1000.

◆ appletSaveCurrentScreenshot()

Result appletSaveCurrentScreenshot ( AlbumReportOption  option)

SaveCurrentScreenshot.

Note
Only available with [11.0.0+].
Parameters
[in]optionAlbumReportOption

◆ appletSetAlbumImageOrientation()

Result appletSetAlbumImageOrientation ( AlbumImageOrientation  orientation)

Sets the Album screenshot ImageOrientation.

Note
Only available with [3.0.0+].
Parameters
[in]orientationAlbumImageOrientation

◆ appletSetAlbumImageTakenNotificationEnabled()

Result appletSetAlbumImageTakenNotificationEnabled ( bool  flag)

Sets whether AppletMessage_AlbumScreenShotTaken is enabled.

Note
Only available with [7.0.0+].
Parameters
[in]flagWhether to enable the notification.

◆ appletSetAppletGpuTimeSlice()

Result appletSetAppletGpuTimeSlice ( s64  val)

Sets the AppletGpuTimeSlice.

Note
Only available with [7.0.0+].
Parameters
[in]valInput value, must not be negative.

◆ appletSetAppletWindowVisibility()

Result appletSetAppletWindowVisibility ( bool  flag)

Sets the current applet WindowVisibility.

Note
Only available with [7.0.0+].
Parameters
[in]flagFlag

◆ appletSetApplicationAlbumUserData()

Result appletSetApplicationAlbumUserData ( const void *  buffer,
size_t  size 
)

Sets the Application AlbumUserData.

Note
Only available with [8.0.0+].
Parameters
[in]bufferBuffer containing arbitrary UserData.
[in]sizeBuffer size, must be <=0x400.

◆ appletSetApplicationCopyrightImage()

Result appletSetApplicationCopyrightImage ( const void *  buffer,
size_t  size,
s32  x,
s32  y,
s32  width,
s32  height,
AppletWindowOriginMode  mode 
)

Sets the RGBA8 image for use with appletInitializeApplicationCopyrightFrameBuffer.

Overrides the current image, if this was already used previously.

Note
Only available with AppletType_*Application on [5.0.0+].
The specified coordinates and width/height must be within the bounds of the framebuffer setup by appletInitializeApplicationCopyrightFrameBuffer.
Parameters
[in]bufferInput image buffer.
[in]sizeInput image buffer size.
[in]xX coordinate. Must not be negative.
[in]yY coordinate. Must not be negative.
[in]widthImage width. Must be >=1.
[in]heightImage height. Must be >=1.
[in]modeAppletWindowOriginMode

◆ appletSetApplicationCopyrightVisibility()

Result appletSetApplicationCopyrightVisibility ( bool  visible)

Sets the visibility for the image set by appletSetApplicationCopyrightImage, in screenshots.

Note
Only available with AppletType_*Application on [5.0.0+].
Parameters
[in]visibleWhether the image is visible. The default is true.

◆ appletSetApplicationMemoryReservation()

Result appletSetApplicationMemoryReservation ( u64  val)

SetApplicationMemoryReservation.

Note
Only available with AppletType_LibraryApplet on [10.0.0+].
An Application must be currently running.
Parameters
[in]valInput value.

◆ appletSetAutoSleepDisabled()

Result appletSetAutoSleepDisabled ( bool  flag)

Sets AutoSleepDisabled.

Note
Only available with [5.0.0+].
Parameters
[in]flagFlag

◆ appletSetAutoSleepTimeAndDimmingTimeEnabled()

Result appletSetAutoSleepTimeAndDimmingTimeEnabled ( bool  flag)

Sets AutoSleepTimeAndDimmingTimeEnabled.

Note
Only available with AppletType_OverlayApplet on [2.0.0+].
Parameters
[in]flagFlag

◆ appletSetControllerFirmwareUpdateSection()

Result appletSetControllerFirmwareUpdateSection ( bool  flag)

Sets ControllerFirmwareUpdateSection.

Note
Only available with [3.0.0+].
This throws error 0x40280 when the internal state flag already matches the input value.
Parameters
[in]flagFlag

◆ appletSetCpuBoostMode()

Result appletSetCpuBoostMode ( ApmCpuBoostMode  mode)

Sets the ApmCpuBoostMode.

Note
Only available with 7.0.0+.
Parameters
modeApmCpuBoostMode.

◆ appletSetCpuBoostRequestPriority()

Result appletSetCpuBoostRequestPriority ( s32  priority)

SetCpuBoostRequestPriority.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [11.0.0+].
Parameters
[in]priorityPriority

◆ appletSetDefaultHomeButtonLongPressTime()

Result appletSetDefaultHomeButtonLongPressTime ( s64  val)

Sets the DefaultHomeButtonLongPressTime.

Note
Only available with AppletType_SystemApplet on [3.0.0+].
Parameters
[in]valInput value.

◆ appletSetDelayTimeToAbortOnGpuError()

Result appletSetDelayTimeToAbortOnGpuError ( u64  val)

SetDelayTimeToAbortOnGpuError.

Note
Only available with AppletType_*Application on [11.0.0+].
Parameters
[in]valInput nanoseconds value.

◆ appletSetDesirableKeyboardLayout()

Result appletSetDesirableKeyboardLayout ( SetKeyboardLayout  layout)

Sets the DesirableKeyboardLayout.

Note
Only available with [4.0.0+].
Parameters
[in]layoutInput SetKeyboardLayout.

◆ appletSetDisplayMagnification()

Result appletSetDisplayMagnification ( float  x,
float  y,
float  width,
float  height 
)

Sets the DisplayMagnification.

This is essentially layer image crop, for everything non-Overlay.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [8.0.0+].
x and width are multiplied with the same width value returned by appletGetDisplayLogicalResolution, so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.
Parameters
[in]xX position.
[in]yY position.
[in]widthWidth.
[in]heightHeight.

◆ appletSetExpectedMasterVolume()

Result appletSetExpectedMasterVolume ( float  mainAppletVolume,
float  libraryAppletVolume 
)

Sets the ExpectedMasterVolume for MainApplet and LibraryApplet.

Note
Used by some official apps before/after launching LibraryApplets. Prior to changing the volume, the official app uses appletGetExpectedMasterVolume, with the output being used to restore the volume after LibraryApplet handling.
Parameters
[in]mainAppletVolumeMainApplet ExpectedMasterVolume.
[in]libraryAppletVolumeLibraryApplet ExpectedMasterVolume.

◆ appletSetFocusHandlingMode()

Result appletSetFocusHandlingMode ( AppletFocusHandlingMode  mode)

Sets the current AppletFocusHandlingMode.

Note
Should only be called with AppletType_Application.

◆ appletSetGamePlayRecordingState()

Result appletSetGamePlayRecordingState ( bool  state)

Disable/enable video recording.

Only available after appletInitializeGamePlayRecording was used. See also appletInitializeGamePlayRecording.

◆ appletSetGpuTimeSliceBoost()

Result appletSetGpuTimeSliceBoost ( u64  val)

Sets the GpuTimeSliceBoost.

Note
Only available with AppletType_OverlayApplet.
Parameters
[in]valInput value.

◆ appletSetHandlesRequestToDisplay()

Result appletSetHandlesRequestToDisplay ( bool  flag)

Sets whether AppletMessage_RequestToDisplay is enabled.

Note
Sets an internal state flag. When the input flag is 0, this will in additional run the same code as appletApproveToDisplay.
Parameters
[in]flagFlag

◆ appletSetHandlingHomeButtonShortPressedEnabled()

Result appletSetHandlingHomeButtonShortPressedEnabled ( bool  flag)

Sets HandlingHomeButtonShortPressedEnabled.

Note
Only available with AppletType_OverlayApplet on [8.0.0+]. Or with non-AppletType_OverlayApplet on [9.1.0+].
Parameters
[in]flagFlag

◆ appletSetHdcpAuthenticationActivated()

Result appletSetHdcpAuthenticationActivated ( bool  flag)

SetHdcpAuthenticationActivated.

Note
Only available with AppletType_*Application on [9.0.0+].
Parameters
[in]flagWhether HdcpAuthentication is activated.

◆ appletSetHealthWarningShowingState()

Result appletSetHealthWarningShowingState ( bool  flag)

SetHealthWarningShowingState.

Note
Only available with AppletType_OverlayApplet on [9.0.0+].
Parameters
[in]flagFlag

◆ appletSetHomeButtonDoubleClickEnabled()

Result appletSetHomeButtonDoubleClickEnabled ( bool  flag)

Sets whether HomeButtonDoubleClick is enabled.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [8.0.0+].
Parameters
[in]flagFlag

◆ appletSetIdleTimeDetectionExtension()

Result appletSetIdleTimeDetectionExtension ( AppletIdleTimeDetectionExtension  ext)

Sets the IdleTimeDetectionExtension.

Parameters
[in]extAppletIdleTimeDetectionExtension Must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.

◆ appletSetInputDetectionPolicy()

Result appletSetInputDetectionPolicy ( AppletInputDetectionPolicy  policy)

Sets the AppletInputDetectionPolicy.

Note
Only available with [9.0.0+].
Parameters
[in]policyAppletInputDetectionPolicy

◆ appletSetInputDetectionSourceSet()

Result appletSetInputDetectionSourceSet ( u32  val)

Sets the InputDetectionSourceSet.

Parameters
[in]valInput value.

◆ appletSetLastApplicationExitReason()

Result appletSetLastApplicationExitReason ( s32  reason)

SetLastApplicationExitReason.

Note
Only available with AppletType_SystemApplet on [11.0.0+].
Parameters
[in]reasonReason

◆ appletSetLcdBacklightOffEnabled()

Result appletSetLcdBacklightOffEnabled ( bool  flag)

Sets whether the LCD screen backlight is turned off.

Note
Only available with [4.0.0+].
Parameters
[in]flagFlag

◆ appletSetManagedDisplayLayerSeparationMode()

Result appletSetManagedDisplayLayerSeparationMode ( u32  mode)

SetManagedDisplayLayerSeparationMode.

Note
Only available with [10.0.0+].
Parameters
[in]modeMode. Must be 0-1.

◆ appletSetMediaPlaybackState()

Result appletSetMediaPlaybackState ( bool  state)

Set media playback state.

If state is set to true, screen dimming and auto sleep is disabled. For *Application, this uses cmd SetMediaPlaybackStateForApplication, otherwise cmd SetMediaPlaybackState is used.

◆ appletSetPerformanceConfigurationChangedNotification()

Result appletSetPerformanceConfigurationChangedNotification ( bool  flag)

Sets whether PerformanceConfigurationChangedNotification is enabled.

Note
Only available with [7.0.0+].
Parameters
[in]flagWhether to enable the notification.

◆ appletSetRequestExitToLibraryAppletAtExecuteNextProgramEnabled()

Result appletSetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ( void  )

SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled.

Note
Only available with [11.0.0+].

◆ appletSetRequiresCaptureButtonShortPressedMessage()

Result appletSetRequiresCaptureButtonShortPressedMessage ( bool  flag)

Sets whether AppletMessage_CaptureButtonShortPressed is enabled.

Note
Only available with [3.0.0+].
When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.
Parameters
[in]flagWhether to enable the notification.

◆ appletSetRestartMessageEnabled()

Result appletSetRestartMessageEnabled ( bool  flag)

Sets whether AppletMessage_Resume is enabled.

Parameters
[in]flagWhether to enable the notification.

◆ appletSetScreenShotAppletIdentityInfo()

Result appletSetScreenShotAppletIdentityInfo ( AppletIdentityInfo info)

Sets the AppletIdentityInfo for screenshots.

Parameters
[in]infoAppletIdentityInfo

◆ appletSetScreenShotPermission()

Result appletSetScreenShotPermission ( AppletScreenShotPermission  permission)

Controls whether screenshot-capture is allowed.

Parameters
permissionAppletScreenShotPermission

◆ appletSetScreenShotPermissionGlobally()

Result appletSetScreenShotPermissionGlobally ( bool  flag)

Sets ScreenShotPermissionGlobally.

Note
Only available with AppletType_OverlayApplet on [3.0.0+].
Parameters
[in]flagFlag

◆ appletSetTerminateResult()

Result appletSetTerminateResult ( Result  res)

SetTerminateResult.

Note
Only available with AppletType_*Application. Or with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [9.0.0+].
Parameters
[in]resResult

◆ appletSetTransparentVolumeRate()

Result appletSetTransparentVolumeRate ( float  val)

Sets the TransparentVolumeRate.

Parameters
[in]valInput value.

◆ appletSetTvPowerStateMatchingMode()

Result appletSetTvPowerStateMatchingMode ( AppletTvPowerStateMatchingMode  mode)

Sets the AppletTvPowerStateMatchingMode.

Note
Only available with [5.0.0+].
Parameters
[in]modeAppletTvPowerStateMatchingMode

◆ appletSetVrModeEnabled()

Result appletSetVrModeEnabled ( bool  flag)

Sets whether VrMode is enabled.

Note
This is only fully usable system-side with [6.0.0+].
For checking Parental Controls, see pctlIsStereoVisionPermitted.
On pre-7.0.0 this uses cmd SetVrModeEnabled internally, while on [7.0.0+] this uses cmds BeginVrModeEx/EndVrModeEx.
Parameters
flagFlag

◆ appletSetVrPositionForDebug()

Result appletSetVrPositionForDebug ( s32  x,
s32  y,
s32  width,
s32  height 
)

SetVrPositionForDebug.

Note
The cached value loaded from setsysGetDebugModeFlag must be 1, otherwise an error is returned.
Only available with [11.0.0+].
Parameters
[in]xX, must not be negative. x+width must be <=1280.
[in]yY, must not be negative. y+height must be <=720.
[in]widthWidth, must be 1-1280.
[in]heightHeight, must be 1-720.

◆ appletSetWirelessPriorityMode()

Result appletSetWirelessPriorityMode ( AppletWirelessPriorityMode  mode)

Sets the WirelessPriorityMode.

Note
Only available with [4.0.0+].
Parameters
[in]modeAppletWirelessPriorityMode

◆ appletShouldSetGpuTimeSliceManually()

Result appletShouldSetGpuTimeSliceManually ( bool *  out)

ShouldSetGpuTimeSliceManually.

Note
Only available with AppletType_LibraryApplet on [10.0.0+].
Parameters
[out]outOutput flag.

◆ appletShouldSleepOnBoot()

Result appletShouldSleepOnBoot ( bool *  out)

ShouldSleepOnBoot.

Uses an omm cmd internally.

Note
Only available with AppletType_SystemApplet on [3.0.0+].
Parameters
[out]outOutput flag.

◆ appletStartRebootSequence()

Result appletStartRebootSequence ( void  )

Start the system-reboot sequence.

Note
Only available with AppletType_SystemApplet.

◆ appletStartRebootSequenceForOverlay()

Result appletStartRebootSequenceForOverlay ( void  )

Start the system-reboot sequence.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_OverlayApplet on [6.0.0+].

◆ appletStartShutdownSequence()

Result appletStartShutdownSequence ( void  )

Start the system-shutdown sequence.

Note
Only available with AppletType_SystemApplet.

◆ appletStartShutdownSequenceForOverlay()

Result appletStartShutdownSequenceForOverlay ( void  )

Start the system-shutdown sequence.

This will enter an infinite-sleep-loop on success.

Note
Only available with AppletType_OverlayApplet on [6.0.0+].

◆ appletStartSleepSequence()

Result appletStartSleepSequence ( bool  flag)

Start the sequence for entering sleep-mode.

Note
Only available with AppletType_SystemApplet.
Parameters
[in]flagFlag, official sw uses hard-coded value = true.

◆ appletStorageClose()

void appletStorageClose ( AppletStorage s)

Closes the storage object.

TransferMemory closing is seperate, see appletStorageCloseTmem. Other applet functions which push an input storage will automatically call this.

◆ appletStorageGetHandle()

Result appletStorageGetHandle ( AppletStorage s,
s64 out,
Handle handle 
)

Gets data for a HandleStorage originally from appletCreateHandleStorage input.

Note
Only available on [2.0.0+].
Parameters
sStorage object.
outOutput value.
handleOutput handle.

◆ appletStorageMap()

Result appletStorageMap ( AppletStorage s,
void **  addr,
size_t *  size 
)

Maps TransferMemory for a HandleStorage.

Wrapper for appletCreateHandleStorage.

Note
The TransferMemory can be unmapped with appletStorageCloseTmem.
Do not use this if the AppletStorage already contains initialized TransferMemory state.
Parameters
sStorage object.
addrOutput mapped address (optional).
sizeOutput size (optional).

◆ appletStorageRead()

Result appletStorageRead ( AppletStorage s,
s64  offset,
void *  buffer,
size_t  size 
)

Reads from a storage.

offset(+size) must be within the actual storage size.

Note
This is not usable with HandleStorage.
Parameters
sStorage object.
offsetOffset in storage.
bufferInput data.
sizeData size.

◆ appletStorageWrite()

Result appletStorageWrite ( AppletStorage s,
s64  offset,
const void *  buffer,
size_t  size 
)

Writes to a storage.

offset(+size) must be within the actual storage size.

Note
This is not usable with HandleStorage.
Parameters
sStorage object.
offsetOffset in storage.
bufferInput data.
sizeData size.

◆ appletSuppressDisablingSleepTemporarily()

Result appletSuppressDisablingSleepTemporarily ( u64  val)

SuppressDisablingSleepTemporarily.

Parameters
[in]valNanoseconds value.
Note
Only available with [11.0.0+].

◆ appletTakeScreenShotOfOwnLayer()

Result appletTakeScreenShotOfOwnLayer ( bool  flag,
AppletCaptureSharedBuffer  captureBuf 
)

Takes a screenshot of the current applet Layer into the specified CaptureSharedBuffer.

Note
Only available with [2.0.0+].
Parameters
[in]flagFlag.
[in]captureBufAppletCaptureSharedBuffer

◆ appletTakeScreenShotOfOwnLayerEx()

Result appletTakeScreenShotOfOwnLayerEx ( bool  flag0,
bool  immediately,
AppletCaptureSharedBuffer  captureBuf 
)

Takes a screenshot of the current applet Layer into the specified CaptureSharedBuffer.

Same as appletTakeScreenShotOfOwnLayer except for the additional immediately param.

Note
Only available with [6.0.0+].
Parameters
[in]flag0Flag0.
[in]immediatelyWhether the screenshot should be taken immediately.
[in]captureBufAppletCaptureSharedBuffer

◆ appletTerminateAllLibraryApplets()

Result appletTerminateAllLibraryApplets ( void  )

TerminateAllLibraryApplets which were created by the current applet.

Note
Normally LibraryApplet cleanup should be handled via AppletHolder.

◆ appletTerminateApplicationAndSetReason()

Result appletTerminateApplicationAndSetReason ( Result  reason)

TerminateApplicationAndSetReason.

Note
Only available with AppletType_OverlayApplet on [2.0.0+].
Parameters
[in]reasonResult reason.

◆ appletTryPopFromAppletBoundChannel()

Result appletTryPopFromAppletBoundChannel ( AppletStorage s)

This is similar to appletTryPopFromAppletBoundChannelForDebug (no DebugMode check), except the used channel is loaded from elsewhere and must be in the range 31-32.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [9.0.0+].
Parameters
[out]sStorage object.

◆ appletTryPopFromAppletBoundChannelForDebug()

Result appletTryPopFromAppletBoundChannelForDebug ( AppletStorage s,
s32  channel 
)

The channel must not be 0 and must match the value previously saved by appletPushToAppletBoundChannelForDebug, otherwise errors are returned.

Then the output storage is popped from the StorageChannel.

Note
Only available on [9.0.0+]. DebugMode must be enabled.
Parameters
[out]sStorage object.
[in]channelChannel.

◆ appletTryPopFromFriendInvitationStorageChannel()

Result appletTryPopFromFriendInvitationStorageChannel ( AppletStorage s)

Pops a storage from the FriendInvitation StorageChannel.

Note
This is used by friendsTryPopFriendInvitationNotificationInfo.
Only available with AppletType_*Application on [9.0.0+].
Parameters
[out]sStorage object.

◆ appletTryPopFromNotificationStorageChannel()

Result appletTryPopFromNotificationStorageChannel ( AppletStorage s)

Pops a storage from the Notification StorageChannel.

Note
This is used by notifTryPopNotifiedApplicationParameter.
Only available with AppletType_*Application on [9.0.0+].
Parameters
[out]sStorage object.

◆ appletUnhook()

void appletUnhook ( AppletHookCookie cookie)

Removes an applet status hook.

Parameters
cookieHook cookie to remove.

◆ appletUnlockForeground()

Result appletUnlockForeground ( void  )

UnlockForeground.

Note
Only available with AppletType_SystemApplet.

◆ appletUnpopExtraStorage()

Result appletUnpopExtraStorage ( AppletStorage s)

Unpop a storage for current-LibraryApplet Extra input.

Note
Only available with AppletType_LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletUnpopInData()

Result appletUnpopInData ( AppletStorage s)

Unpop a storage for current-LibraryApplet input.

Note
Only available with AppletType_LibraryApplet.
This uses appletStorageClose automatically.
Parameters
[in]sStorage object.

◆ appletUnreserveResourceForMovieOperation()

Result appletUnreserveResourceForMovieOperation ( void  )

UnreserveResourceForMovieOperation.

Must be used at some point after all finished with GameMovieTrimmer usage (appletCreateGameMovieTrimmer).

Note
Only available with AppletType_LibraryApplet on [5.0.0+].

◆ appletUpdateDefaultDisplayResolution()

Result appletUpdateDefaultDisplayResolution ( void  )

UpdateDefaultDisplayResolution.

Uses an omm cmd internally.

Note
Only available with AppletType_SystemApplet on [3.0.0+].

◆ appletWriteThemeStorage()

Result appletWriteThemeStorage ( const void *  buffer,
size_t  size,
u64  offset 
)

Writes the ThemeStorage for the current applet.

Note
Only available with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [7.0.0+].
offset(+size) must be <=0x400.
Parameters
[in]bufferInput buffer data.
[in]sizeSize to write.
[in]offsetOffset within the ThemeStorage.