|
libnx
v4.8.0
|
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. | |
Functions | |
| Result | appletInitialize (void) |
| Initialize applet, called automatically during app startup. | |
| void | appletExit (void) |
| Exit applet, called automatically during app exit. | |
| Service * | appletGetServiceSession_Proxy (void) |
| Gets the Service object for the actual "appletOE"/"appletAE" service session. | |
| Service * | appletGetServiceSession_AppletCommonFunctions (void) |
| Gets the Service object for IAppletCommonFunctions. Only initialized with AppletType_SystemApplet, AppletType_LibraryApplet, or AppletType_OverlayApplet, on [7.0.0+]. | |
| Service * | appletGetServiceSession_Functions (void) |
| Gets the Service object for I*Functions, specific to each AppletType (IApplicationFunctions for AppletType_*Application). Not initialized with AppletType_LibraryApplet pre-15.0.0. On [15.0.0+] with AppletType_LibraryApplet this returns the object for IHomeMenuFunctions. | |
| Service * | appletGetServiceSession_GlobalStateController (void) |
| Gets the Service object for IGlobalStateController. Only initialized with AppletType_SystemApplet, or on [15.0.0+] with AppletType_LibraryApplet/AppletType_OverlayApplet. | |
| Service * | appletGetServiceSession_ApplicationCreator (void) |
| Gets the Service object for IApplicationCreator. Only initialized with AppletType_SystemApplet. | |
| Service * | appletGetServiceSession_LibraryAppletSelfAccessor (void) |
| Gets the Service object for ILibraryAppletSelfAccessor. Only initialized with AppletType_LibraryApplet. | |
| Service * | appletGetServiceSession_ProcessWindingController (void) |
| Gets the Service object for IProcessWindingController. Only initialized with AppletType_LibraryApplet. | |
| Service * | appletGetServiceSession_LibraryAppletCreator (void) |
| Gets the Service object for ILibraryAppletCreator. | |
| Service * | appletGetServiceSession_CommonStateGetter (void) |
| Gets the Service object for ICommonStateGetter. | |
| Service * | appletGetServiceSession_SelfController (void) |
| Gets the Service object for ISelfController. | |
| Service * | appletGetServiceSession_WindowController (void) |
| Gets the Service object for IWindowController. | |
| Service * | appletGetServiceSession_AudioController (void) |
| Gets the Service object for IAudioController. | |
| Service * | appletGetServiceSession_DisplayController (void) |
| Gets the Service object for IDisplayController. | |
| Service * | appletGetServiceSession_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 Event * | appletHolderGetExitEvent (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 and on [15.0.0+] for AppletType_LibraryApplet. | |
| 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 | |
| AppletInfo * | appletGetAppletInfo (void) |
| Gets the cached AppletInfo loaded during appletInitialize. More... | |
| Event * | appletGetMessageEvent (void) |
| Gets the event associated with notification messages. | |
| 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... | |
Applet (applet) service IPC wrapper.
FocusHandlingMode.
| enum AppletFocusState |
| enum AppletHookType |
applet hook types.
| enum AppletId |
AppletId.
Extension values for appletSetIdleTimeDetectionExtension / appletGetIdleTimeDetectionExtension, for extending user inactivity detection.
| Enumerator | |
|---|---|
| AppletIdleTimeDetectionExtension_None | No extension. |
| AppletIdleTimeDetectionExtension_Extended | Extended. |
| AppletIdleTimeDetectionExtension_ExtendedUnsafe | ExtendedUnsafe. |
Input policy values for appletSetInputDetectionPolicy.
| Enumerator | |
|---|---|
| AppletInputDetectionPolicy_Unknown0 | Unknown. |
| AppletInputDetectionPolicy_Unknown1 | Unknown. |
| enum 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. |
| enum AppletOperationMode |
ProgramSpecifyKind for the ExecuteProgram cmd. Controls the type of the u64 passed to the ExecuteProgram cmd.
Permission values for appletSetScreenShotPermission.
| Enumerator | |
|---|---|
| AppletScreenShotPermission_Inherit | Inherit from parent applet. |
| AppletScreenShotPermission_Enable | Enable. |
| AppletScreenShotPermission_Disable | Disable. |
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. |
Mode values for appletSetTvPowerStateMatchingMode.
| Enumerator | |
|---|---|
| AppletTvPowerStateMatchingMode_Unknown0 | Unknown. |
| AppletTvPowerStateMatchingMode_Unknown1 | Unknown. |
Input mode values for appletSetWirelessPriorityMode.
| Enumerator | |
|---|---|
| AppletWirelessPriorityMode_Default | Default. |
| AppletWirelessPriorityMode_OptimizedForWlan | OptimizedForWlan. |
| enum 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. |
Acquire the CallerApplet CaptureSharedBuffer.
| [out] | flag | Output flag. |
| [out] | id | Output ID. |
Acquire the LastApplication CaptureSharedBuffer.
| [out] | flag | Output flag. |
| [out] | id | Output ID. |
Acquire the LastForeground CaptureSharedBuffer.
| [out] | flag | Output flag. |
| [out] | id | Output ID. |
| Result appletActivateMigrationService | ( | void | ) |
ActivateMigrationService.
| Result appletAlarmSettingNotificationDisableAppEventReserve | ( | void | ) |
Clears the StorageChannel/saved-ApplicationId used by appletAlarmSettingNotificationEnableAppEventReserve.
| Result appletAlarmSettingNotificationEnableAppEventReserve | ( | AppletStorage * | s, |
| u64 | application_id | ||
| ) |
Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.
| [in] | s | Storage object. |
| [in] | application_id | ApplicationId |
Same as appletApplicationPushToNotificationStorageChannel except this uses the MainApplication.
| [in] | buffer | Input buffer. |
| [in] | size | Input buffer size. |
| bool appletApplicationActive | ( | AppletApplication * | a | ) |
Returns whether the AppletApplication object was initialized.
| a | AppletApplication |
| Result appletApplicationAreAnyLibraryAppletsLeft | ( | AppletApplication * | a, |
| bool * | out | ||
| ) |
AreAnyLibraryAppletsLeft which were created by the Application.
| a | AppletApplication | |
| [out] | out | Output flag. |
| bool appletApplicationCheckFinished | ( | AppletApplication * | a | ) |
Waits on the Application StateChangedEvent with timeout=0, and returns whether it was successful.
| a | AppletApplication |
| Result appletApplicationCheckRightsEnvironmentAvailable | ( | AppletApplication * | a, |
| bool * | out | ||
| ) |
CheckRightsEnvironmentAvailable.
| a | AppletApplication | |
| [out] | out | Output flag. |
| void appletApplicationClose | ( | AppletApplication * | a | ) |
Close an AppletApplication.
| a | AppletApplication |
| Result appletApplicationGetApplicationControlProperty | ( | AppletApplication * | a, |
| NacpStruct * | nacp | ||
| ) |
Gets the NacpStruct for the Application.
| a | AppletApplication | |
| [out] | nacp | NacpStruct |
| Result appletApplicationGetApplicationId | ( | AppletApplication * | a, |
| u64 * | application_id | ||
| ) |
Gets the ApplicationId for the Application.
| a | AppletApplication | |
| [out] | application_id | Output ApplicationId. |
| Result appletApplicationGetApplicationLaunchProperty | ( | AppletApplication * | a, |
| AppletApplicationLaunchProperty * | out | ||
| ) |
Gets the AppletApplicationLaunchProperty for the Application.
| a | AppletApplication | |
| [out] | out | AppletApplicationLaunchProperty |
| Result appletApplicationGetApplicationLaunchRequestInfo | ( | AppletApplication * | a, |
| AppletApplicationLaunchRequestInfo * | out | ||
| ) |
Gets the AppletApplicationLaunchRequestInfo for the Application.
| a | AppletApplication | |
| [out] | out | AppletApplicationLaunchRequestInfo |
| Result appletApplicationGetDesirableUids | ( | AppletApplication * | a, |
| AccountUid * | uids, | ||
| s32 | count, | ||
| s32 * | total_out | ||
| ) |
Gets an array of userIds for the Application DesirableUids.
| a | AppletApplication | |
| [out] | uids | Output array of AccountUid. |
| [in] | count | Size of the uids array in entries, must be at least the size stored in state. |
| [out] | total_out | Total output entries. |
| AppletApplicationExitReason appletApplicationGetExitReason | ( | AppletApplication * | a | ) |
Gets the AppletApplicationExitReason set by appletApplicationJoin.
| a | AppletApplication |
| Result appletApplicationGetNsRightsEnvironmentHandle | ( | AppletApplication * | a, |
| u64 * | handle | ||
| ) |
GetNsRightsEnvironmentHandle.
| a | AppletApplication | |
| [out] | handle | Output NsRightsEnvironmentHandle. |
| Result appletApplicationHasSaveDataAccessPermission | ( | AppletApplication * | a, |
| u64 | application_id, | ||
| bool * | out | ||
| ) |
Gets whether the savedata specified by the input ApplicationId is accessible.
| a | AppletApplication | |
| [in] | application_id | ApplicationId for the savedata. |
| [out] | out | Output flag. |
| void appletApplicationJoin | ( | AppletApplication * | a | ) |
Waits for the Application to exit.
| a | AppletApplication |
| Result appletApplicationPushLaunchParameter | ( | AppletApplication * | a, |
| AppletLaunchParameterKind | kind, | ||
| AppletStorage * | s | ||
| ) |
Pushes a LaunchParameter AppletStorage to the Application.
| a | AppletApplication | |
| [in] | kind | AppletLaunchParameterKind |
| [in] | s | Input storage. |
| 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.
| a | AppletApplication | |
| [in] | uid | AccountUid |
| [in] | buffer | Input buffer. |
| [in] | size | Input buffer size. |
| Result appletApplicationPushToNotificationStorageChannel | ( | AppletApplication * | a, |
| const void * | buffer, | ||
| u64 | size | ||
| ) |
Creates a storage using the specified input then pushes it to the Notification StorageChannel.
| a | AppletApplication | |
| [in] | buffer | Input buffer. |
| [in] | size | Input buffer size. |
| Result appletApplicationReportApplicationExitTimeout | ( | AppletApplication * | a | ) |
| Result appletApplicationRequestApplicationSoftReset | ( | AppletApplication * | a | ) |
| Result appletApplicationRequestExit | ( | AppletApplication * | a | ) |
Requests the Application to exit.
| a | AppletApplication |
| Result appletApplicationRequestExitLibraryAppletOrTerminate | ( | AppletApplication * | a, |
| u64 | timeout | ||
| ) |
Calls the same func as appletHolderRequestExitOrTerminate with the output IAppletAccessor from the GetCurrentLibraryApplet cmd.
| a | AppletApplication | |
| [in] | timeout | Timeout in nanoseconds. UINT64_MAX for no timeout. |
| Result appletApplicationRequestForApplicationToGetForeground | ( | AppletApplication * | a | ) |
RequestForApplicationToGetForeground.
| a | AppletApplication |
| Result appletApplicationRestartApplicationTimer | ( | AppletApplication * | a | ) |
| Result appletApplicationSetApplicationAttribute | ( | AppletApplication * | a, |
| const AppletApplicationAttribute * | attr | ||
| ) |
Sets the AppletApplicationAttribute for the Application.
| a | AppletApplication | |
| [in] | attr | AppletApplicationAttribute |
| Result appletApplicationSetUsers | ( | AppletApplication * | a, |
| const AccountUid * | uids, | ||
| s32 | count, | ||
| bool | flag | ||
| ) |
SetUsers for the Application.
| a | AppletApplication | |
| [in] | uids | Input array of AccountUid. |
| [in] | count | Size of the uids array in entries, must be <=ACC_USER_LIST_SIZE. |
| [in] | flag | When this flag is true, this just clears the users_available state flag to 0 and returns. |
| Result appletApplicationStart | ( | AppletApplication * | a | ) |
Starts the Application.
| a | AppletApplication |
| Result appletApplicationTerminate | ( | AppletApplication * | a | ) |
Terminate the Application.
| a | AppletApplication |
| Result appletAreAnyLibraryAppletsLeft | ( | bool * | out | ) |
AreAnyLibraryAppletsLeft which were created by the current applet.
| [out] | out | Output flag. |
Blocks the usage of the home button, for short presses (Home Menu).
| val | Unknown nanoseconds. Value 0 can be used. |
Blocks the usage of the home button, for short (Home Menu) and long (Overlay) presses.
| val | Unknown. Official sw only uses hard-coded value 0 for this. |
| Result appletBeginToObserveHidInputForDevelop | ( | void | ) |
Enables HID input for the OverlayApplet, without disabling input for the foreground applet.
Generally appletBeginToWatchShortHomeButtonMessage / appletEndToWatchShortHomeButtonMessage should be used instead.
| Result appletBeginToWatchShortHomeButtonMessage | ( | void | ) |
Stops forwarding the input to the foreground app.
| Result appletCancelCpuBoostMode | ( | void | ) |
CancelCpuBoostMode.
| Result appletCanUseApplicationCore | ( | bool * | out | ) |
CanUseApplicationCore.
| [out] | out | Output flag. |
Change the MainApplet MasterVolume.
| [in] | volume | MainApplet MasterVolume. |
| [in] | unk | Unknown. |
Clear the AppletTransitionBuffer with the specified color.
| [in] | color | RGBA8 color. |
| Result appletClearCaptureBuffer | ( | bool | flag, |
| AppletCaptureSharedBuffer | captureBuf, | ||
| u32 | color | ||
| ) |
Clear the input CaptureSharedBuffer with the specified color.
| [in] | flag | Flag. |
| [in] | captureBuf | AppletCaptureSharedBuffer |
| [in] | color | RGBA8 color. |
| Result appletCopyBetweenCaptureBuffers | ( | AppletCaptureSharedBuffer | dstCaptureBuf, |
| AppletCaptureSharedBuffer | srcCaptureBuf | ||
| ) |
Copies image data from a CaptureSharedBuffer to another CaptureSharedBuffer.
| [in] | dstCaptureBuf | Destination AppletCaptureSharedBuffer. |
| [in] | srcCaptureBuf | Source AppletCaptureSharedBuffer. |
| Result appletCreateApplication | ( | AppletApplication * | a, |
| u64 | application_id | ||
| ) |
Creates an Application.
| [out] | a | AppletApplication |
| [in] | application_id | ApplicationId. |
| Result appletCreateGameMovieTrimmer | ( | Service * | srv_out, |
| TransferMemory * | tmem | ||
| ) |
CreateGameMovieTrimmer.
Do not use this directly, use grcTrimGameMovie instead.
| [out] | srv_out | Output Service for grc IGameMovieTrimmer. |
| [in] | tmem | TransferMemory |
| Result appletCreateHandleStorage | ( | AppletStorage * | s, |
| s64 | inval, | ||
| Handle | handle | ||
| ) |
Creates a HandleStorage.
| s | Storage object. |
| inval | Arbitrary input value. |
| handle | Arbitrary input handle. |
| Result appletCreateHandleStorageTmem | ( | AppletStorage * | s, |
| void * | buffer, | ||
| s64 | size | ||
| ) |
Creates a HandleStorage using TransferMemory.
Wrapper for appletCreateHandleStorage.
| s | Storage object. |
| buffer | TransferMemory buffer, will be automatically allocated if NULL. |
| size | Size of storage. |
| Result appletCreateLibraryApplet | ( | AppletHolder * | h, |
| AppletId | id, | ||
| LibAppletMode | mode | ||
| ) |
Creates a LibraryApplet.
| h | AppletHolder object. |
| id | See AppletId. |
| mode | See LibAppletMode. |
| Result appletCreateLibraryAppletSelf | ( | AppletHolder * | h, |
| AppletId | id, | ||
| LibAppletMode | mode | ||
| ) |
Creates a LibraryApplet.
This is for when a LibraryApplet creates itself.
| h | AppletHolder object. |
| id | See AppletId. |
| mode | See LibAppletMode. |
CreateManagedDisplaySeparableLayer.
| [out] | display_layer | Output display_layer. |
| [out] | recording_layer | Output recording_layer. |
| Result appletCreateMovieMaker | ( | Service * | srv_out, |
| TransferMemory * | tmem | ||
| ) |
CreateMovieMaker.
Do not use this directly, use grcCreateMovieMaker instead.
| [out] | srv_out | Output Service for applet IMovieMaker. |
| [in] | tmem | TransferMemory |
| Result appletCreateStorage | ( | AppletStorage * | s, |
| s64 | size | ||
| ) |
Creates a storage.
| s | Storage object. |
| size | Size of storage. |
| Result appletCreateSystemApplication | ( | AppletApplication * | a, |
| u64 | system_application_id | ||
| ) |
Creates a SystemApplication.
| [out] | a | AppletApplication |
| [in] | system_application_id | SystemApplicationId. |
| Result appletCreateTransferMemoryStorage | ( | AppletStorage * | s, |
| void * | buffer, | ||
| s64 | size, | ||
| bool | writable | ||
| ) |
Creates a TransferMemory storage.
| s | Storage object. |
| buffer | TransferMemory buffer, will be automatically allocated if NULL. |
| size | Size of storage. |
| writable | Controls whether writing to the storage is allowed with appletStorageWrite. |
| Result appletDeactivateMigrationService | ( | void | ) |
DeactivateMigrationService.
| Result appletDisableSleepTillShutdown | ( | void | ) |
DisableSleepTillShutdown.
| Result appletEndBlockingHomeButton | ( | void | ) |
Ends the blocking started by appletBeginBlockingHomeButton.
| Result appletEndBlockingHomeButtonShortAndLongPressed | ( | void | ) |
Ends the blocking started by appletBeginBlockingHomeButtonShortAndLongPressed.
| Result appletEndToWatchShortHomeButtonMessage | ( | void | ) |
Forwards input to the foreground app.
Launches Application {current_ApplicationId}+programIndex.
This will enter an infinite-sleep-loop on success.
| [in] | programIndex | ProgramIndex, 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] | buffer | Optional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL. |
| [in] | size | Size of the above buffer, 0 to not use the storage. Must be <=0x1000. |
| 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.
| Result appletFriendInvitationClearApplicationParameter | ( | void | ) |
Clears the StorageChannel/saved-ApplicationId used by appletFriendInvitationSetApplicationParameter.
| Result appletFriendInvitationPushApplicationParameter | ( | AccountUid | uid, |
| const void * | buffer, | ||
| u64 | size | ||
| ) |
Same as appletApplicationPushToFriendInvitationStorageChannel except this uses the MainApplication.
| [in] | uid | AccountUid |
| [in] | buffer | Input buffer. |
| [in] | size | Input buffer size. |
| Result appletFriendInvitationSetApplicationParameter | ( | AppletStorage * | s, |
| u64 | application_id | ||
| ) |
Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.
| [in] | s | Storage object. |
| [in] | application_id | ApplicationId |
| 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.
| Result appletGetAppletResourceUsageInfo | ( | AppletResourceUsageInfo * | info | ) |
Gets the AppletResourceUsageInfo.
| [out] | info | AppletResourceUsageInfo |
Gets the AppletResourceUserId of the CallerApplet.
| [out] | out | AppletResourceUserId |
Gets the ApplicationId for the specified ContentActionName string.
| [out] | application_id | ApplicationId. |
| [in] | name | ContentActionName string. |
Gets the ApplicationId for displaying the logo screen during application launch.
| [out] | application_id | Output ApplicationId, 0 when no application is running. |
| Result appletGetBootMode | ( | PmBootMode * | mode | ) |
Gets the BootMode which originated from pmbmGetBootMode.
| [out] | mode | PmBootMode |
GetBuiltInDisplayType.
| [out] | out | Output value. |
| Result appletGetCallerAppletCaptureImageEx | ( | void * | buffer, |
| size_t | size, | ||
| bool * | flag | ||
| ) |
Gets the CallerApplet CaptureImage.
| [out] | buffer | Output buffer containing the 1280x720 RGBA8 image. |
| [out] | size | Buffer size, must match 0x384000. |
| [out] | flag | Output flag. |
| Result appletGetCallerAppletIdentityInfo | ( | AppletIdentityInfo * | info | ) |
Gets the AppletIdentityInfo for the CallerApplet.
| [out] | info | AppletIdentityInfo |
| Result appletGetCallerAppletIdentityInfoStack | ( | AppletIdentityInfo * | stack, |
| s32 | count, | ||
| s32 * | total_out | ||
| ) |
Gets an array of AppletIdentityInfo for the CallerStack.
| [out] | stack | Output array of AppletIdentityInfo. |
| [in] | count | Size of the stack array. |
| [out] | total_out | Total output entries. |
Gets the Dock firmware version.
| [out] | out0 | First output value. |
| [out] | out1 | Second output value. |
| [out] | out2 | Third output value. |
| [out] | out3 | Fourth output value. |
Gets the CradleStatus.
| [out] | status | Output Dock status. |
Gets the ApplicationId for the currently running Application.
| [out] | application_id | Output ApplicationId, 0 when no Application is running. |
| Result appletGetCurrentIlluminance | ( | float * | fLux | ) |
Gets the current Illuminance from the light sensor.
| fLux | Output fLux |
| Result appletGetCurrentIlluminanceEx | ( | bool * | bOverLimit, |
| float * | fLux | ||
| ) |
Gets the current Illuminance from the light sensor.
Same as appletGetCurrentIlluminance except for the additional param.
| bOverLimit | Output bOverLimit |
| fLux | Output fLux |
Gets the current PerformanceConfiguration.
| PerformanceConfiguration | Output PerformanceConfiguration. |
Gets the DefaultDisplayResolution.
| [out] | width | Output width. |
| [out] | height | Output height. |
Gets an Event which is signaled when the output from appletGetDefaultDisplayResolution changes.
| [out] | out_event | Output Event with autoclear=true. |
| Result appletGetDesirableKeyboardLayout | ( | SetKeyboardLayout * | layout | ) |
Gets the DesirableKeyboardLayout previously set by appletSetDesirableKeyboardLayout.
An error is returned when it's not set.
| [out] | layout | Output SetKeyboardLayout. |
Gets the DesiredLanguage for the current host application control.nacp.
| [out] | LanguageCode | Output LanguageCode, see set.h. |
Gets the DisplayLogicalResolution.
| [out] | width | Output width. |
| [out] | height | Output height. |
| Result appletGetDisplayVersion | ( | char * | displayVersion | ) |
Gets the DisplayVersion for the current host application control.nacp.
| [out] | displayVersion | Output DisplayVersion string, must be at least 0x10-bytes. This is always NUL-terminated. |
| Result appletGetExpectedMasterVolume | ( | float * | mainAppletVolume, |
| float * | libraryAppletVolume | ||
| ) |
Gets the ExpectedMasterVolume for MainApplet and LibraryApplet.
| [out] | mainAppletVolume | MainApplet ExpectedMasterVolume. Optional, can be NULL. Used with cmd GetMainAppletExpectedMasterVolume when not NULL. |
| [out] | libraryAppletVolume | LibraryApplet ExpectedMasterVolume. Optional, can be NULL. Used with cmd GetLibraryAppletExpectedMasterVolume when not NULL. |
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.
| [out] | out_event | Output Event with autoclear=false. |
Gets an Event which is signaled for GpuErrorDetected.
| [out] | out_event | Output Event with autoclear=false. |
Gets an Event which is signaled for HdcpAuthenticationFailed.
| [out] | out_event | Output Event with autoclear=false. |
Gets the HdcpAuthenticationState.
| [out] | state | Output state. |
Gets an Event which is signaled when the output from appletGetHdcpAuthenticationState changes.
| [out] | out_event | Output Event with autoclear=true. |
| Result appletGetHomeButtonDoubleClickEnabled | ( | bool * | out | ) |
Gets whether HomeButtonDoubleClick is enabled.
| [out] | out | Output flag. |
| Result appletGetHomeButtonReaderLockAccessor | ( | AppletLockAccessor * | a | ) |
Gets a AppletLockAccessor for HomeButtonReader.
| a | LockAccessor object. |
| Result appletGetHomeButtonWriterLockAccessor | ( | AppletLockAccessor * | a | ) |
Gets a AppletLockAccessor for HomeButtonWriter.
| a | LockAccessor object. |
| Result appletGetIdleTimeDetectionExtension | ( | AppletIdleTimeDetectionExtension * | ext | ) |
Gets the value set by appletSetIdleTimeDetectionExtension.
| [out] | ext | AppletIdleTimeDetectionExtension |
Gets the IndirectLayerProducerHandle.
| [out] | out | Output IndirectLayerProducerHandle. |
| Result appletGetLastApplicationCaptureImageEx | ( | void * | buffer, |
| size_t | size, | ||
| bool * | flag | ||
| ) |
Gets the LastApplication CaptureImage.
| [out] | buffer | Output buffer containing the 1280x720 RGBA8 image. |
| [out] | size | Buffer size, must match 0x384000. |
| [out] | flag | Output flag. |
GetLastApplicationExitReason.
| [out] | out | Output value. |
| Result appletGetLastForegroundCaptureImageEx | ( | void * | buffer, |
| size_t | size, | ||
| bool * | flag | ||
| ) |
Gets the LastForeground CaptureImage.
| [out] | buffer | Output buffer containing the 1280x720 RGBA8 image. |
| [out] | size | Buffer size, must match 0x384000. |
| [out] | flag | Output flag. |
| Result appletGetLaunchStorageInfoForDebug | ( | NcmStorageId * | app_storageId, |
| NcmStorageId * | update_storageId | ||
| ) |
Gets the LaunchStorageInfo.
| [out] | app_storageId | Same as AppletApplicationLaunchProperty::app_storageId. |
| [out] | update_storageId | Same as AppletApplicationLaunchProperty::update_storageId. |
| Result appletGetLibraryAppletInfo | ( | LibAppletInfo * | info | ) |
Gets the LibAppletInfo for the current LibraryApplet.
| [out] | info | LibAppletInfo |
| Result appletGetMainAppletApplicationControlProperty | ( | NacpStruct * | nacp | ) |
Gets the NacpStruct for the MainApplet.
| [out] | nacp | NacpStruct |
Gets the DesiredLanguage for the MainApplet.
| [out] | LanguageCode | Output LanguageCode, see set.h. |
| Result appletGetMainAppletAvailableUsers | ( | AccountUid * | uids, |
| s32 | count, | ||
| bool * | flag, | ||
| s32 * | total_out | ||
| ) |
Gets an array of userIds for the MainApplet AvailableUsers.
| [out] | uids | Output array of AccountUid. |
| [in] | count | Size of the uids array in entries, must be at least ACC_USER_LIST_SIZE. |
| [out] | flag | When true, this indicates that no users are available. |
| [out] | total_out | Total output entries. This is -1 when flag is true. |
| Result appletGetMainAppletIdentityInfo | ( | AppletIdentityInfo * | info | ) |
Gets the AppletIdentityInfo for the MainApplet.
| [out] | info | AppletIdentityInfo |
| Result appletGetMainAppletStorageId | ( | NcmStorageId * | storageId | ) |
Gets the NcmStorageId for the MainApplet.
| [out] | storageId | NcmStorageId |
| Result appletGetNextReturnDestinationAppletIdentityInfo | ( | AppletIdentityInfo * | info | ) |
Gets the AppletIdentityInfo for the NextReturnDestinationApplet.
| [out] | info | AppletIdentityInfo |
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.
| [out] | out_event | Output Event with autoclear=false. |
Gets the OperationModeSystemInfo.
| [out] | info | Output info. |
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.
| [out] | out_event | Output Event with autoclear=false. |
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.
| [out] | out_event | Output Event with autoclear=false. |
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.
| [out] | out_event | Output Event with autoclear=false. |
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.
| [out] | out_event | Output Event with autoclear=false. |
Gets the ProgramIndex of the program which launched this program.
| [out] | programIndex | ProgramIndex, -1 when there was no previous program. |
Gets the total time in nanoseconds that the current process was actively running (not suspended), relative to when appletInitialize was last used.
| [out] | activeTime | Output nanoseconds value. |
Gets the PseudoDeviceId.
This is derived from the output of a ns command, and from data in the host application control.nacp.
| [out] | out | Output PseudoDeviceId. |
| Result appletGetReaderLockAccessorEx | ( | AppletLockAccessor * | a, |
| u32 | inval | ||
| ) |
Gets a Reader AppletLockAccessor.
| a | LockAccessor object. | |
| [in] | inval | Input value, must be 0-3. 0 = HomeButton. |
| Result appletGetSettingsPlatformRegion | ( | SetSysPlatformRegion * | out | ) |
This uses setsysGetPlatformRegion internally.
| [out] | out | SetSysPlatformRegion |
Same as appletGetSystemSharedLayerHandle except this just gets the SharedBufferHandle.
| [out] | SharedBufferHandle | Output System SharedBufferHandle. |
Gets the System SharedBufferHandle and SharedLayerHandle.
| [out] | SharedBufferHandle | Output System SharedBufferHandle. |
| [out] | SharedLayerHandle | Output System SharedLayerHandle. |
GetWakeupCount.
| [out] | out | Output value. |
| Result appletGetWriterLockAccessorEx | ( | AppletLockAccessor * | a, |
| u32 | inval | ||
| ) |
Gets a Writer AppletLockAccessor.
| a | LockAccessor object. | |
| [in] | inval | Input value, must be 0-3. 0 = HomeButton. |
| void appletGpuErrorHandlerClose | ( | AppletGpuErrorHandler * | g | ) |
Close an AppletGpuErrorHandler.
| g | AppletGpuErrorHandler |
| Result appletGpuErrorHandlerFinishManualGpuErrorHandling | ( | AppletGpuErrorHandler * | g | ) |
FinishManualGpuErrorHandling.
| g | AppletGpuErrorHandler |
| Result appletGpuErrorHandlerGetManualGpuErrorDetectionSystemEvent | ( | AppletGpuErrorHandler * | g, |
| Event * | out_event | ||
| ) |
GetManualGpuErrorDetectionSystemEvent.
| g | AppletGpuErrorHandler |
| [out] | out_event | Output Event with autoclear=false. |
| Result appletGpuErrorHandlerGetManualGpuErrorInfo | ( | AppletGpuErrorHandler * | g, |
| void * | buffer, | ||
| size_t | size, | ||
| u64 * | out | ||
| ) |
GetManualGpuErrorInfo.
| g | AppletGpuErrorHandler | |
| [out] | buffer | Output buffer. |
| [in] | size | Output buffer size, must be >= the output size from appletGpuErrorHandlerGetManualGpuErrorInfoSize. |
| [out] | out | Output value. |
| Result appletGpuErrorHandlerGetManualGpuErrorInfoSize | ( | AppletGpuErrorHandler * | g, |
| u64 * | out | ||
| ) |
Gets the size of the info available with appletGpuErrorHandlerGetManualGpuErrorInfo.
| g | AppletGpuErrorHandler | |
| [out] | out | Output size. |
| bool appletHolderCheckFinished | ( | AppletHolder * | h | ) |
Waits on the LibraryApplet StateChangedEvent with timeout=0, and returns whether it was successful.
| h | AppletHolder object. |
|
inlinestatic |
Gets the LibraryApplet StateChangedEvent.
| h | AppletHolder object. |
| LibAppletExitReason appletHolderGetExitReason | ( | AppletHolder * | h | ) |
Gets the LibAppletExitReason set by appletHolderJoin.
| h | AppletHolder object. |
| Result appletHolderGetIndirectLayerConsumerHandle | ( | AppletHolder * | h, |
| u64 * | out | ||
| ) |
Gets the IndirectLayerConsumerHandle loaded during appletCreateLibraryApplet, on [2.0.0+].
| h | AppletHolder object. |
| out | Output IndirectLayerConsumerHandle. |
| Result appletHolderGetLibraryAppletInfo | ( | AppletHolder * | h, |
| LibAppletInfo * | info | ||
| ) |
Gets the LibAppletInfo for the specified LibraryApplet.
| h | AppletHolder object. | |
| [out] | info | LibAppletInfo |
| Result appletHolderGetPopInteractiveOutDataEvent | ( | AppletHolder * | h, |
| Event ** | out_event | ||
| ) |
Gets the PopInteractiveOutDataEvent.
| h | AppletHolder object. | |
| [out] | out_event | Output Event. |
| void appletHolderJoin | ( | AppletHolder * | h | ) |
Waits for the LibraryApplet to exit.
| h | AppletHolder object. |
| Result appletHolderJump | ( | AppletHolder * | h | ) |
Jumps to the LibraryApplet, with the current-LibraryApplet being terminated.
This will enter an infinite-sleep-loop on success.
| h | AppletHolder object. |
| Result appletHolderPopInteractiveOutData | ( | AppletHolder * | h, |
| AppletStorage * | s | ||
| ) |
Pops a storage from LibraryApplet Interactive output.
| h | AppletHolder object. | |
| [out] | s | Storage object. |
| Result appletHolderPopOutData | ( | AppletHolder * | h, |
| AppletStorage * | s | ||
| ) |
Pops a storage from LibraryApplet output.
| h | AppletHolder object. | |
| [out] | s | Storage object. |
| Result appletHolderPresetLibraryAppletGpuTimeSliceZero | ( | AppletHolder * | h | ) |
PresetLibraryAppletGpuTimeSliceZero.
| h | AppletHolder object. |
| Result appletHolderPushExtraStorage | ( | AppletHolder * | h, |
| AppletStorage * | s | ||
| ) |
Pushes a storage for LibraryApplet Extra storage input.
| h | AppletHolder object. | |
| [in] | s | Storage object. |
| Result appletHolderPushInData | ( | AppletHolder * | h, |
| AppletStorage * | s | ||
| ) |
Pushes a storage for LibraryApplet input.
| h | AppletHolder object. | |
| [in] | s | Storage object. |
| Result appletHolderPushInteractiveInData | ( | AppletHolder * | h, |
| AppletStorage * | s | ||
| ) |
Pushes a storage for LibraryApplet Interactive input.
| h | AppletHolder object. | |
| [in] | s | Storage object. |
| Result appletHolderRequestExit | ( | AppletHolder * | h | ) |
Requests the LibraryApplet to exit.
The command is only used if appletHolderCheckFinished returns false.
| h | AppletHolder object. |
| 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.
| h | AppletHolder object. | |
| [in] | timeout | Timeout in nanoseconds. UINT64_MAX for no timeout. |
| Result appletHolderSetOutOfFocusApplicationSuspendingEnabled | ( | AppletHolder * | h, |
| bool | flag | ||
| ) |
Sets OutOfFocusApplicationSuspendingEnabled.
| h | AppletHolder object. | |
| [in] | flag | Flag |
| Result appletHolderStart | ( | AppletHolder * | h | ) |
Starts the LibraryApplet.
| h | AppletHolder object. |
| Result appletHolderTerminate | ( | AppletHolder * | h | ) |
Terminate the LibraryApplet.
| h | AppletHolder object. |
| bool appletHolderWaitInteractiveOut | ( | AppletHolder * | h | ) |
Waits for the PopInteractiveOutDataEvent and StateChangedEvent.
| h | AppletHolder object. |
| void appletHook | ( | AppletHookCookie * | cookie, |
| AppletHookFn | callback, | ||
| void * | param | ||
| ) |
Sets up an applet status hook.
| cookie | Hook cookie to use. |
| callback | Function to call when applet's status changes. |
| param | User-defined parameter to pass to the callback. |
| Result appletInitializeApplicationCopyrightFrameBuffer | ( | void | ) |
Initializes the ApplicationCopyrightFrameBuffer, with dimensions 1280x720 + the tmem for it.
This is used as an overlay for screenshots.
| 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.
| Result appletIsAutoPowerDownRequested | ( | bool * | out | ) |
IsAutoPowerDownRequested.
Uses an idle:sys cmd internally.
| [out] | out | Output flag. |
| Result appletIsAutoSleepDisabled | ( | bool * | out | ) |
Gets AutoSleepDisabled.
| [out] | out | Output flag |
| Result appletIsForceTerminateApplicationDisabledForDebug | ( | bool * | out | ) |
IsForceTerminateApplicationDisabledForDebug.
| [out] | out | Output flag. 0 when DebugMode is not enabled, otherwise this is loaded from a system-setting. |
| Result appletIsGamePlayRecordingSupported | ( | bool * | flag | ) |
Gets whether video recording is supported.
See also appletInitializeGamePlayRecording.
| Result appletIsHealthWarningRequired | ( | bool * | out | ) |
IsHealthWarningRequired.
| [out] | out | Output flag. |
| Result appletIsHomeButtonShortPressedBlocked | ( | bool * | out | ) |
IsHomeButtonShortPressedBlocked.
| [out] | out | Output flag. |
| Result appletIsIlluminanceAvailable | ( | bool * | out | ) |
Gets whether Illuminance is available.
| out | Output flag |
| Result appletIsInControllerFirmwareUpdateSection | ( | bool * | out | ) |
Gets the ControllerFirmwareUpdateSection flag.
| [out] | out | Output flag. |
| Result appletIsSleepEnabled | ( | bool * | out | ) |
IsSleepEnabled.
| [out] | out | Output flag. |
| Result appletIsSystemBufferSharingEnabled | ( | void | ) |
Checks whether SystemBufferSharing is enabled, throwing an error otherwise.
| Result appletIsVrModeCurtainRequired | ( | bool * | out | ) |
IsVrModeCurtainRequired.
| [out] | out | Output flag. |
| Result appletIsVrModeEnabled | ( | bool * | out | ) |
Gets whether VrMode is enabled.
| out | Output flag |
| Result appletJumpToSubApplicationProgramForDevelopment | ( | u64 | application_id, |
| const void * | buffer, | ||
| size_t | size | ||
| ) |
Launches the specified ApplicationId.
| [in] | application_id | ApplicationId. |
| [in] | buffer | Optional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL. |
| [in] | size | Size of the above buffer, 0 to not use the storage. Must be <=0x1000. |
| Result appletLaunchDevMenu | ( | void | ) |
Launches DevMenu and the dev Overlay-applet.
This will enter an infinite-sleep-loop on success.
| Result appletLoadAndApplyIdlePolicySettings | ( | void | ) |
LoadAndApplyIdlePolicySettings.
Uses an idle:sys cmd internally.
| void appletLockAccessorClose | ( | AppletLockAccessor * | a | ) |
Closes a LockAccessor.
| a | LockAccessor object. |
| Result appletLockAccessorLock | ( | AppletLockAccessor * | a | ) |
Lock a LockAccessor.
| a | LockAccessor object. |
| Result appletLockAccessorTryLock | ( | AppletLockAccessor * | a, |
| bool * | flag | ||
| ) |
TryLock a LockAccessor.
| a | LockAccessor object. | |
| [out] | flag | Whether locking was successful, when false this indicates that this func should be called again. |
| Result appletLockAccessorUnlock | ( | AppletLockAccessor * | a | ) |
Unlock a LockAccessor.
| a | LockAccessor object. |
| Result appletLockExit | ( | void | ) |
Delay exiting until appletUnlockExit is called, with a 15 second timeout once exit is requested.
| Result appletLockForeground | ( | void | ) |
LockForeground.
| bool appletMainLoop | ( | void | ) |
Processes the current applet status.
Generally used within a main loop.
| Result appletNotifyCecSettingsChanged | ( | void | ) |
NotifyCecSettingsChanged.
Uses an omm cmd internally.
| void appletNotifyRunning | ( | bool * | out | ) |
Notify that the app is now running, for the Application logo screen.
This throws a fatal-error on failure.
| Result appletOpenMainApplication | ( | AppletApplication * | a | ) |
Open an AppletApplication for the currently running Application.
| [out] | a | AppletApplication |
| Result appletOpenMyGpuErrorHandler | ( | AppletGpuErrorHandler * | g | ) |
Opens an AppletGpuErrorHandler.
| [out] | g | AppletGpuErrorHandler |
OverrideAutoSleepTimeAndDimmingTime.
| [in] | inval0 | Unknown input value. |
| [in] | inval1 | Unknown input value. |
| [in] | inval2 | Unknown input value. |
| [in] | inval3 | Unknown input value. |
| Result appletPerformSystemButtonPressing | ( | AppletSystemButtonType | type | ) |
Perform SystemButtonPressing with the specified AppletSystemButtonType.
| [in] | type | AppletSystemButtonType |
| 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.
| [in] | type | AppletSystemButtonType |
| Result appletPopContext | ( | AppletStorage * | s | ) |
Pops a storage from the ContextStack.
Normally this should only be used when AppletInfo::caller_flag is true.
| [out] | s | Storage object. |
| Result appletPopExtraStorage | ( | AppletStorage * | s | ) |
Pops a storage from current-LibraryApplet Extra input.
| [out] | s | Storage object. |
| Result appletPopFloatingApplicationForDevelopment | ( | AppletApplication * | a | ) |
PopFloatingApplicationForDevelopment.
| [out] | a | AppletApplication |
| Result appletPopFromGeneralChannel | ( | AppletStorage * | s | ) |
Pops a storage from the general channel.
| [out] | s | Storage object. |
| Result appletPopInData | ( | AppletStorage * | s | ) |
Pops a storage from current-LibraryApplet input.
| [out] | s | Storage object. |
| Result appletPopInteractiveInData | ( | AppletStorage * | s | ) |
Pops a storage from current-LibraryApplet Interactive input.
| [out] | s | Storage object. |
| Result appletPopLaunchParameter | ( | AppletStorage * | s, |
| AppletLaunchParameterKind | kind | ||
| ) |
Pops a LaunchParameter AppletStorage, the storage will be removed from sysmodule state during this.
| [out] | s | Output storage. |
| kind | See AppletLaunchParameterKind. |
| Result appletPopLaunchRequestedApplication | ( | AppletApplication * | a | ) |
Pops a AppletApplication for a requested Application launch.
| [out] | a | AppletApplication |
| Result appletPopRequestLaunchApplicationForDebug | ( | AccountUid * | uids, |
| s32 | count, | ||
| u64 * | application_id, | ||
| s32 * | total_out | ||
| ) |
PopRequestLaunchApplicationForDebug.
| [out] | uids | Output array of AccountUid. |
| [in] | count | Size of the uids array in entries, must be at least the size stored in state. |
| [out] | application_id | Output ApplicationId. |
| [out] | total_out | Total output userID entries. |
| Result appletPrepareForJit | ( | void | ) |
Launches the jit-sysmodule when it was not previously launched by this cmd.
Returns 0 when it was previously launched.
| bool appletProcessMessage | ( | u32 | msg | ) |
Processes the current applet status using the specified msg.
| msg | Notification message, normally from appletGetMessage. |
| Result appletPushContext | ( | AppletStorage * | s | ) |
Pushes a storage to the ContextStack.
Normally this should only be used when AppletInfo::caller_flag is true.
| [in] | s | Storage object. |
| Result appletPushInteractiveOutData | ( | AppletStorage * | s | ) |
Pushes a storage for current-LibraryApplet Interactive output.
| [in] | s | Storage object. |
| Result appletPushOutData | ( | AppletStorage * | s | ) |
Pushes a storage for current-LibraryApplet output.
| [in] | s | Storage object. |
| 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.
| [in] | s | Storage object. |
| 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.
| [in] | s | Storage object. |
| [in] | channel | Channel. |
| Result appletPushToGeneralChannel | ( | AppletStorage * | s | ) |
Pushes a storage to the general channel.
Used for sending requests to SystemApplet.
| [in] | s | Storage object. |
| Result appletQueryApplicationPlayStatistics | ( | PdmApplicationPlayStatistics * | stats, |
| const u64 * | application_ids, | ||
| s32 | count, | ||
| s32 * | total_out | ||
| ) |
Gets ApplicationPlayStatistics.
| stats | Output PdmApplicationPlayStatistics array. |
| application_ids | Input ApplicationIds array. |
| count | Total entries in the input/output arrays. |
| total_out | Total output entries. |
| 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.
| [in] | uid | AccountUid |
| [out] | stats | Output PdmApplicationPlayStatistics array. |
| [in] | application_ids | Input ApplicationIds array. |
| [in] | count | Total entries in the input/output arrays. |
| [out] | total_out | Total output entries. |
Reads the ThemeStorage for the current applet.
| [out] | buffer | Output buffer data. |
| [in] | size | Size to read. |
| [in] | offset | Offset within the ThemeStorage. |
| [out] | transfer_size | Actual read size. |
| Result appletReleaseCallerAppletCaptureSharedBuffer | ( | void | ) |
Release the CallerApplet CaptureSharedBuffer.
| Result appletReleaseLastApplicationCaptureSharedBuffer | ( | void | ) |
Release the LastApplication CaptureSharedBuffer.
| Result appletReleaseLastForegroundCaptureSharedBuffer | ( | void | ) |
Release the LastForeground CaptureSharedBuffer.
| Result appletReleaseSleepLockTransiently | ( | void | ) |
Release the SleepLock transiently.
| 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.
| Result appletRequestExitToSelf | ( | void | ) |
Exits the current applet.
Same as appletHolderRequestExit except this is for the current applet.
| Result appletRequestFlushGamePlayingMovieForDebug | ( | void | ) |
Requests to save the video recording, as if the Capture-button was held.
| Result appletRequestLaunchApplication | ( | u64 | application_id, |
| AppletStorage * | s | ||
| ) |
Requests to launch the specified application.
| [in] | application_id | ApplicationId. Value 0 can be used to relaunch the current application. |
| [in] | s | Optional 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. |
| Result appletRequestLaunchApplicationForQuest | ( | u64 | application_id, |
| AppletStorage * | s, | ||
| const AppletApplicationAttributeForQuest * | attr | ||
| ) |
Requests to launch the specified application, for kiosk systems.
| [in] | application_id | ApplicationId |
| [in] | s | Optional 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] | attr | Kiosk application attributes. |
| 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.
| [in] | application_id | ApplicationId. |
| [in] | uids | Input array of AccountUid. |
| [in] | total_uids | Total input uids, must be <=ACC_USER_LIST_SIZE. |
| [in] | flag | Whether to use the specified buffer to create a storage which will be pushed for AppletLaunchParameterKind_UserChannel. |
| [in] | buffer | Buffer containing the above storage data. |
| [in] | size | Size of the storage buffer. |
| Result appletRequestToAcquireSleepLock | ( | void | ) |
Request to AcquireSleepLock.
| Result appletRequestToGetForeground | ( | void | ) |
RequestToGetForeground.
| Result appletRequestToReboot | ( | void | ) |
Requests a system reboot.
This will enter an infinite-sleep-loop on success.
| Result appletRequestToShutdown | ( | void | ) |
Requests a system shutdown.
This will enter an infinite-sleep-loop on success.
| Result appletRequestToSleep | ( | void | ) |
RequestToSleep.
| Result appletReserveResourceForMovieOperation | ( | void | ) |
ReserveResourceForMovieOperation.
Must be used at some point prior to appletCreateGameMovieTrimmer.
| Result appletRestartProgram | ( | const void * | buffer, |
| size_t | size | ||
| ) |
Relaunches the current Application.
| [in] | buffer | Optional buffer containing the storage data which will be used for AppletLaunchParameterKind_UserChannel with the launched Application, can be NULL. |
| [in] | size | Size of the above buffer, 0 to not use the storage. Must be <=0x1000. |
| Result appletSaveCurrentScreenshot | ( | AlbumReportOption | option | ) |
| Result appletSetAlbumImageOrientation | ( | AlbumImageOrientation | orientation | ) |
Sets the Album screenshot ImageOrientation.
| [in] | orientation | AlbumImageOrientation |
| Result appletSetAlbumImageTakenNotificationEnabled | ( | bool | flag | ) |
Sets whether AppletMessage_AlbumScreenShotTaken is enabled.
| [in] | flag | Whether to enable the notification. |
Sets the AppletGpuTimeSlice.
| [in] | val | Input value, must not be negative. |
| Result appletSetAppletWindowVisibility | ( | bool | flag | ) |
Sets the current applet WindowVisibility.
| [in] | flag | Flag |
| Result appletSetApplicationAlbumUserData | ( | const void * | buffer, |
| size_t | size | ||
| ) |
Sets the Application AlbumUserData.
| [in] | buffer | Buffer containing arbitrary UserData. |
| [in] | size | Buffer size, must be <=0x400. |
| 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.
| [in] | buffer | Input image buffer. |
| [in] | size | Input image buffer size. |
| [in] | x | X coordinate. Must not be negative. |
| [in] | y | Y coordinate. Must not be negative. |
| [in] | width | Image width. Must be >=1. |
| [in] | height | Image height. Must be >=1. |
| [in] | mode | AppletWindowOriginMode |
| Result appletSetApplicationCopyrightVisibility | ( | bool | visible | ) |
Sets the visibility for the image set by appletSetApplicationCopyrightImage, in screenshots.
| [in] | visible | Whether the image is visible. The default is true. |
SetApplicationMemoryReservation.
| [in] | val | Input value. |
| Result appletSetAutoSleepDisabled | ( | bool | flag | ) |
Sets AutoSleepDisabled.
| [in] | flag | Flag |
| Result appletSetAutoSleepTimeAndDimmingTimeEnabled | ( | bool | flag | ) |
Sets AutoSleepTimeAndDimmingTimeEnabled.
| [in] | flag | Flag |
| Result appletSetControllerFirmwareUpdateSection | ( | bool | flag | ) |
Sets ControllerFirmwareUpdateSection.
| [in] | flag | Flag |
| Result appletSetCpuBoostMode | ( | ApmCpuBoostMode | mode | ) |
SetCpuBoostRequestPriority.
| [in] | priority | Priority |
Sets the DefaultHomeButtonLongPressTime.
| [in] | val | Input value. |
SetDelayTimeToAbortOnGpuError.
| [in] | val | Input nanoseconds value. |
| Result appletSetDesirableKeyboardLayout | ( | SetKeyboardLayout | layout | ) |
Sets the DesirableKeyboardLayout.
| [in] | layout | Input SetKeyboardLayout. |
| Result appletSetDisplayMagnification | ( | float | x, |
| float | y, | ||
| float | width, | ||
| float | height | ||
| ) |
Sets the DisplayMagnification.
This is essentially layer image crop, for everything non-Overlay.
| [in] | x | X position. |
| [in] | y | Y position. |
| [in] | width | Width. |
| [in] | height | Height. |
| Result appletSetExpectedMasterVolume | ( | float | mainAppletVolume, |
| float | libraryAppletVolume | ||
| ) |
Sets the ExpectedMasterVolume for MainApplet and LibraryApplet.
| [in] | mainAppletVolume | MainApplet ExpectedMasterVolume. |
| [in] | libraryAppletVolume | LibraryApplet ExpectedMasterVolume. |
| Result appletSetFocusHandlingMode | ( | AppletFocusHandlingMode | mode | ) |
Sets the current AppletFocusHandlingMode.
| Result appletSetGamePlayRecordingState | ( | bool | state | ) |
Disable/enable video recording.
Only available after appletInitializeGamePlayRecording was used. See also appletInitializeGamePlayRecording.
Sets the GpuTimeSliceBoost.
| [in] | val | Input value. |
| Result appletSetHandlesRequestToDisplay | ( | bool | flag | ) |
Sets whether AppletMessage_RequestToDisplay is enabled.
| [in] | flag | Flag |
| Result appletSetHandlingHomeButtonShortPressedEnabled | ( | bool | flag | ) |
Sets HandlingHomeButtonShortPressedEnabled.
| [in] | flag | Flag |
| Result appletSetHdcpAuthenticationActivated | ( | bool | flag | ) |
SetHdcpAuthenticationActivated.
| [in] | flag | Whether HdcpAuthentication is activated. |
| Result appletSetHealthWarningShowingState | ( | bool | flag | ) |
SetHealthWarningShowingState.
| [in] | flag | Flag |
| Result appletSetHomeButtonDoubleClickEnabled | ( | bool | flag | ) |
Sets whether HomeButtonDoubleClick is enabled.
| [in] | flag | Flag |
| Result appletSetIdleTimeDetectionExtension | ( | AppletIdleTimeDetectionExtension | ext | ) |
Sets the IdleTimeDetectionExtension.
| [in] | ext | AppletIdleTimeDetectionExtension Must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe. |
| Result appletSetInputDetectionPolicy | ( | AppletInputDetectionPolicy | policy | ) |
Sets the AppletInputDetectionPolicy.
| [in] | policy | AppletInputDetectionPolicy |
Sets the InputDetectionSourceSet.
| [in] | val | Input value. |
SetLastApplicationExitReason.
| [in] | reason | Reason |
| Result appletSetLcdBacklightOffEnabled | ( | bool | flag | ) |
Sets whether the LCD screen backlight is turned off.
| [in] | flag | Flag |
SetManagedDisplayLayerSeparationMode.
| [in] | mode | Mode. Must be 0-1. |
| 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.
| Result appletSetPerformanceConfigurationChangedNotification | ( | bool | flag | ) |
Sets whether PerformanceConfigurationChangedNotification is enabled.
| [in] | flag | Whether to enable the notification. |
| Result appletSetRequestExitToLibraryAppletAtExecuteNextProgramEnabled | ( | void | ) |
SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled.
| Result appletSetRequiresCaptureButtonShortPressedMessage | ( | bool | flag | ) |
Sets whether AppletMessage_CaptureButtonShortPressed is enabled.
| [in] | flag | Whether to enable the notification. |
| Result appletSetRestartMessageEnabled | ( | bool | flag | ) |
Sets whether AppletMessage_Resume is enabled.
| [in] | flag | Whether to enable the notification. |
| Result appletSetScreenShotAppletIdentityInfo | ( | AppletIdentityInfo * | info | ) |
Sets the AppletIdentityInfo for screenshots.
| [in] | info | AppletIdentityInfo |
| Result appletSetScreenShotPermission | ( | AppletScreenShotPermission | permission | ) |
Controls whether screenshot-capture is allowed.
| permission | AppletScreenShotPermission |
| Result appletSetScreenShotPermissionGlobally | ( | bool | flag | ) |
Sets ScreenShotPermissionGlobally.
| [in] | flag | Flag |
SetTerminateResult.
| [in] | res | Result |
| Result appletSetTransparentVolumeRate | ( | float | val | ) |
Sets the TransparentVolumeRate.
| [in] | val | Input value. |
| Result appletSetTvPowerStateMatchingMode | ( | AppletTvPowerStateMatchingMode | mode | ) |
Sets the AppletTvPowerStateMatchingMode.
| [in] | mode | AppletTvPowerStateMatchingMode |
| Result appletSetVrModeEnabled | ( | bool | flag | ) |
Sets whether VrMode is enabled.
| flag | Flag |
SetVrPositionForDebug.
| [in] | x | X, must not be negative. x+width must be <=1280. |
| [in] | y | Y, must not be negative. y+height must be <=720. |
| [in] | width | Width, must be 1-1280. |
| [in] | height | Height, must be 1-720. |
| Result appletSetWirelessPriorityMode | ( | AppletWirelessPriorityMode | mode | ) |
Sets the WirelessPriorityMode.
| [in] | mode | AppletWirelessPriorityMode |
| Result appletShouldSetGpuTimeSliceManually | ( | bool * | out | ) |
ShouldSetGpuTimeSliceManually.
| [out] | out | Output flag. |
| Result appletShouldSleepOnBoot | ( | bool * | out | ) |
ShouldSleepOnBoot.
Uses an omm cmd internally.
| [out] | out | Output flag. |
| Result appletStartRebootSequence | ( | void | ) |
Start the system-reboot sequence.
| Result appletStartRebootSequenceForOverlay | ( | void | ) |
Start the system-reboot sequence.
This will enter an infinite-sleep-loop on success.
| Result appletStartShutdownSequence | ( | void | ) |
Start the system-shutdown sequence.
| Result appletStartShutdownSequenceForOverlay | ( | void | ) |
Start the system-shutdown sequence.
This will enter an infinite-sleep-loop on success.
| Result appletStartSleepSequence | ( | bool | flag | ) |
Start the sequence for entering sleep-mode.
| [in] | flag | Flag, official sw uses hard-coded value = true. |
| 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.
| Result appletStorageGetHandle | ( | AppletStorage * | s, |
| s64 * | out, | ||
| Handle * | handle | ||
| ) |
Gets data for a HandleStorage originally from appletCreateHandleStorage input.
| s | Storage object. |
| out | Output value. |
| handle | Output handle. |
| Result appletStorageMap | ( | AppletStorage * | s, |
| void ** | addr, | ||
| size_t * | size | ||
| ) |
Maps TransferMemory for a HandleStorage.
Wrapper for appletCreateHandleStorage.
| s | Storage object. |
| addr | Output mapped address (optional). |
| size | Output size (optional). |
| Result appletStorageRead | ( | AppletStorage * | s, |
| s64 | offset, | ||
| void * | buffer, | ||
| size_t | size | ||
| ) |
Reads from a storage.
offset(+size) must be within the actual storage size.
| s | Storage object. |
| offset | Offset in storage. |
| buffer | Input data. |
| size | Data size. |
| 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.
| s | Storage object. |
| offset | Offset in storage. |
| buffer | Input data. |
| size | Data size. |
SuppressDisablingSleepTemporarily.
| [in] | val | Nanoseconds value. |
| Result appletTakeScreenShotOfOwnLayer | ( | bool | flag, |
| AppletCaptureSharedBuffer | captureBuf | ||
| ) |
Takes a screenshot of the current applet Layer into the specified CaptureSharedBuffer.
| [in] | flag | Flag. |
| [in] | captureBuf | AppletCaptureSharedBuffer |
| 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.
| [in] | flag0 | Flag0. |
| [in] | immediately | Whether the screenshot should be taken immediately. |
| [in] | captureBuf | AppletCaptureSharedBuffer |
| Result appletTerminateAllLibraryApplets | ( | void | ) |
TerminateAllLibraryApplets which were created by the current applet.
TerminateApplicationAndSetReason.
| [in] | reason | Result reason. |
| 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.
| [out] | s | Storage object. |
| 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.
| [out] | s | Storage object. |
| [in] | channel | Channel. |
| Result appletTryPopFromFriendInvitationStorageChannel | ( | AppletStorage * | s | ) |
Pops a storage from the FriendInvitation StorageChannel.
| [out] | s | Storage object. |
| Result appletTryPopFromNotificationStorageChannel | ( | AppletStorage * | s | ) |
Pops a storage from the Notification StorageChannel.
| [out] | s | Storage object. |
| void appletUnhook | ( | AppletHookCookie * | cookie | ) |
Removes an applet status hook.
| cookie | Hook cookie to remove. |
| Result appletUnlockForeground | ( | void | ) |
UnlockForeground.
| Result appletUnpopExtraStorage | ( | AppletStorage * | s | ) |
Unpop a storage for current-LibraryApplet Extra input.
| [in] | s | Storage object. |
| Result appletUnpopInData | ( | AppletStorage * | s | ) |
Unpop a storage for current-LibraryApplet input.
| [in] | s | Storage object. |
| Result appletUnreserveResourceForMovieOperation | ( | void | ) |
UnreserveResourceForMovieOperation.
Must be used at some point after all finished with GameMovieTrimmer usage (appletCreateGameMovieTrimmer).
| Result appletUpdateDefaultDisplayResolution | ( | void | ) |
UpdateDefaultDisplayResolution.
Uses an omm cmd internally.
Writes the ThemeStorage for the current applet.
| [in] | buffer | Input buffer data. |
| [in] | size | Size to write. |
| [in] | offset | Offset within the ThemeStorage. |
1.9.1