nn::applet::CTR Namespace

Description

The CTR APPLET namespace.
(This can also be written without the ::CTR portion.)

Enumerated Types

HomeButtonState An enumerated type indicating the state of the HOME Button.
SleepNotificationState An enumerated type indicating the sleep notification state.
WakeupState Enumerated type representing start requests.
QueryReply Enumerated type indicating a response to a sleep query.
ResultDescription Module-dependent Description values for nn::Result.

typedef Definitions

AppletId An applet ID.
AppletAttr APPLET attributes.
AppletHomeButtonCallback A function type that represents a callback invoked when a HOME Button press is detected.
AppletMessageCallback A function type that represents a callback for receiving messages.
AppletSleepQueryCallback A function type that represents a sleep query callback.
AppletSleepCallback A function type that represents a sleep callback. (This type is expected to be removed.)
AppletAwakeCallback A function type that represents a callback invoked upon recovering from Sleep Mode.
AppletShutdownCallback A function type that represents a shutdown notification callback.
AppletCloseAppletCallback A function type that represents a callback invoked when an application exits.
AppletPowerButtonCallback A function type that represents a callback invoked when a POWER Button press is detected.

Constants

WAIT_INFINITE Used by APPLET library functions that specify a time. This means that a function will continue running until a result is obtained.
NO_WAIT Used by APPLET library functions that specify a time. This means that a function will only run once without repeating, even if no results are obtained.

Functions

Initialization
Initialize Initializes the APPLET library.
Getting Information
ReceiveDeliverArg Gets DeliverArg and HMAC information.
IsRegistered Determines whether the applet with the specified ID has been registered.
IsActive Determines whether an application is currently running.
Controlling Operations
WaitForRegister Waits only the specified amount of time for the applet with the specified ID to be registered.
WaitForStarting Waits for this object's start event.
Rendering Rights
AssignGpuRight Declares that an application will start rendering.
ReleaseGpuRight Declares that rendering will switch from the application to another program.
Preloading and Exiting Library Applets
PreloadLibraryApplet Preloads a library applet to be run.
CancelLibraryApplet Exits a preloaded library applet.
Starting Library Applets
PrepareToStartLibraryApplet Prepares to start a library applet.
StartLibraryApplet Starts a library applet.
Exiting Applications
PrepareToCloseApplication Prepares to exit an application.
CloseApplication Exits the application.
HOME Menu
PrepareToJumpToHomeMenu Prepares to jump to the HOME Menu.
JumpToHomeMenu Jumps to the HOME Menu.
ProcessHomeButtonIfPrepared Processes the HOME Button.
HOME Button
GetHomeButtonState Gets the state of the HOME Button.
ClearHomeButtonState Clears the HOME Button state.
Sleep
GetSleepNotificationState Gets the sleep notification state.
ClearSleepNotificationState Clears the sleep notification state.
ReplySleepQuery Replies to a sleep query.
Callback Settings
SetHomeButtonCallback Sets the callback invoked when a HOME Button press is detected.
SetReceiveMessageCallback Sets the callback invoked when a message is received.
SetPowerButtonCallback Sets the callback invoked when a POWER Button press is detected.
SetSleepQueryCallback Sets the sleep query callback.
SetSleepCallback Sets the sleep callback.
SetAwakeCallback Sets a sleep recovery callback.
SetShutdownCallback Sets the shutdown notification callback.
SetCloseAppletCallback Sets the callback invoked when an applet exits.

CONFIDENTIAL