libnx

https://github.com/switchbrew/libnx
Admin
libnx is a Nintendo Switch AArch64-only userland library, based on libctru, providing essential...
Tokens:243,307
Snippets:1,288
Trust Score:8.4
License:ISC
Update:1 week ago
Show doc for...
Tokens:
Raw
### Launch software keyboard library applet example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Example of creating and starting the software keyboard library applet using libappletArgsCreate, appletCreateLibraryApplet, and libappletStart. Checks for normal exit reason and closes the holder. See also libapplets.md.

```c
// Launch the software keyboard library applet (see also libapplets.md):
LibAppletArgs args;
libappletArgsCreate(&args, 0);
AppletHolder holder;
Result rc = appletCreateLibraryApplet(&holder, AppletId_LibraryAppletSwkbd, LibAppletMode_AllForeground);
if (R_SUCCEEDED(rc)) rc = libappletStart(&holder);
if (R_SUCCEEDED(rc) && appletHolderGetExitReason(&holder) == LibAppletExitReason_Normal) {
    // user finished
}
appletHolderClose(&holder);
```

--------------------------------

### Example: Launching the Software Keyboard Library Applet

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Demonstrates how to create, start, and close a library applet for the software keyboard, and check its exit reason.

```APIDOC
## Example: Launching the Software Keyboard Library Applet

### Description
Demonstrates how to create, start, and close a library applet for the software keyboard, and check its exit reason.

### Code Example
```c
// Launch the software keyboard library applet (see also libapplets.md):
LibAppletArgs args;
libappletArgsCreate(&args, 0);
AppletHolder holder;
Result rc = appletCreateLibraryApplet(&holder, AppletId_LibraryAppletSwkbd, LibAppletMode_AllForeground);
if (R_SUCCEEDED(rc)) rc = libappletStart(&holder);
if (R_SUCCEEDED(rc) && appletHolderGetExitReason(&holder) == LibAppletExitReason_Normal) {
    // user finished
}
appletHolderClose(&holder);
```

```

--------------------------------

### JIT usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Example of creating a JIT buffer, writing code, transitioning to executable, and calling it. jitCreate returns LibnxError_JitUnavailable on unsupported environments.

```c
Jit j;
Result rc = jitCreate(&j, 0x1000);
if (R_FAILED(rc)) { /* LibnxError_JitUnavailable on unsupported env */ }
jitTransitionToWritable(&j);
memcpy(jitGetRwAddr(&j), code, code_size);
jitTransitionToExecutable(&j);
void (*fn)(void) = jitGetRxAddr(&j);
fn();
jitClose(&j);
```

--------------------------------

### Console usage example (main.c)

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/devices.md

Initializes the default console with consoleInit(NULL), prints a message, and updates the console each frame while the applet main loop runs. Use this as a minimal starting point for a Switch homebrew application.

```c
#include <switch.h>

int main(int argc, char* argv[]) {
    consoleInit(NULL);
    printf("Hello, Switch!\n");
    while (appletMainLoop()) {
        consoleUpdate(NULL);
    }
    return 0;
}
```

--------------------------------

### Web applet usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Example of creating and showing a web page applet. It creates a config, sets the URL and whitelist, then shows the applet and closes the config.

```c
WebCommonConfig conf;
webConfigCreate();
webPageCreate(&conf, "https://switchbrew.org");
webConfigSetWhitelist(&conf, "switchbrew.org");
WebCommonReturnValue out;
Result rc = webConfigShow(&conf, &out);
webConfigClose(&conf);
```

--------------------------------

### Pad usage example (pad.h)

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/runtime.md

Example of initializing the default pad (No1 + Handheld), updating it in the main loop, and reading button presses and analog stick positions.

```c
#include <switch.h>

padConfigureInput(1, HidNpadStyleSet_NpadStandard);
PadState pad;
padInitializeDefault(&pad);

while (appletMainLoop()) {
    padUpdate(&pad);
    u64 kDown = padGetButtonsDown(&pad);
    if (kDown & HidNpadButton_A) {
        // jump
    }
    HidAnalogStickState l = padGetStickPos(&pad, 0);
    handle_analog(l.x, l.y);
}
```

--------------------------------

### svcGetInfo example for TotalMemorySize

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Example call to svcGetInfo with InfoType_TotalMemorySize to retrieve total memory size.

```c
u64 total_mem;
Result rc = svcGetInfo(&total_mem, InfoType_TotalMemorySize, INVALID_HANDLE, 0);
```

--------------------------------

### Example — map a buffer for the GPU

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/nvidia.md

Shows how to create an NvMap, initialize the GPU, create an address space, and map the buffer to obtain a GPU-addressable range. Requires including switch.h. The example cleans up with nvAddressSpaceClose, nvGpuExit, nvMapClose, and nvMapExit.

```c
#include <switch.h>

nvMapInit();
NvMap map;
Result rc = nvMapCreate(&map, buffer, size, 0x1000, NvKind_Pitch, true);
if (R_FAILED(rc)) { nvMapExit(); return rc; }

nvGpuInit();
NvAddressSpace as;
rc = nvAddressSpaceCreate(&as, 0x1000);
if (R_SUCCEEDED(rc)) {
    iova_t iova;
    rc = nvAddressSpaceMap(&as, nvMapGetHandle(&map), true, NvKind_Pitch, &iova);
    if (R_SUCCEEDED(rc)) {
        /* GPU-addressable range [iova, iova+size) */
    }
    nvAddressSpaceClose(&as);
}
nvGpuExit();
nvMapClose(&map);
nvMapExit();
```

--------------------------------

### Application creation via IApplicationCreator

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Declarations for creating, starting, exiting, terminating, and joining applications, including getting the exit reason and terminating all library applets.

```c
Result appletCreateApplication(AppletApplication *a, u64 application_id);
Result appletCreateSystemApplication(AppletApplication *a, u64 system_application_id);
void appletApplicationClose(AppletApplication *a);
Result appletApplicationStart(AppletApplication *a);
Result appletApplicationRequestExit(AppletApplication *a);
Result appletApplicationTerminate(AppletApplication *a);
void appletApplicationJoin(AppletApplication *a);      // sets exitreason
AppletApplicationExitReason appletApplicationGetExitReason(AppletApplication *a);
Result appletApplicationTerminateAllLibraryApplets(AppletApplication *a);
Result appletApplicationRequestExitLibraryAppletOrTerminate(AppletApplication *a, u64 timeout);
```

--------------------------------

### System counter usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/arm.md

Example of measuring elapsed time using armGetSystemTick and armTicksToNs. Prints the elapsed time in nanoseconds after sleeping for one second.

```c
u64 start = armGetSystemTick();
sleep(1);
printf("elapsed: %llu ns\n", armTicksToNs(armGetSystemTick() - start));
```

--------------------------------

### libappletStart

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Starts the applet and joins it, returning LibAppletError on bad exit.

```APIDOC
## libappletStart

### Description
Starts the applet and joins it, returning LibAppletError on bad exit.

### Signature
Result libappletStart(AppletHolder *h);

### Parameters
- **h** (AppletHolder*) - Required - Pointer to the applet holder.

### Returns
- Result - 0 on success, otherwise an error code (LibAppletError on bad exit).

### Notes
- Performs Start + Join.
```

--------------------------------

### setsysGetTvSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets TV settings.

```APIDOC
## setsysGetTvSettings

### Description
Gets TV settings.

### Method
C Function

### Signature
Result setsysGetTvSettings(SetSysTvSettings *out);

### Parameters
- **out** (SetSysTvSettings*) - Required - Output pointer to receive the settings.

### Return Value
Result - The result of the operation.

```

--------------------------------

### Example — play a sine wave through one voice

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/audio.md

Complete example showing how to create an AudioDriver, add a mempool, initialize a voice, add a wave buffer, and run the update loop. Uses audrvCreate, audrvMemPoolAdd, audrvVoiceInit, audrvVoiceSetDestinationMix, audrvVoiceAddWaveBuf, audrvVoiceStart, audrvUpdate, audrenWaitFrame, and audrvClose.

```c
#include <switch.h>

AudioRendererConfig config = { .output_rate = AudioRendererOutputRate_48kHz,
                               .num_voices = 4, .num_effects = 0, .num_sinks = 1,
                               .num_mix_objs = 2, .num_mix_buffers = 2 };
AudioDriver d;
Result rc = audrvCreate(&d, &config, 2);
if (R_FAILED(rc)) diagAbortWithResult(rc);

// allocate sample buffer and a mempool
int pool = audrvMemPoolAdd(&d, sample_buf, sample_size);
audrvMemPoolAttach(&d, pool);

if (audrvVoiceInit(&d, 0, 2, PcmFormat_Int16, 48000)) {
    audrvVoiceSetDestinationMix(&d, 0, AUDREN_FINAL_MIX_ID);
    AudioDriverWaveBuf wb = {0};
    wb.data_pcm16 = samples;
    wb.size = sample_bytes;
    wb.end_sample_offset = num_samples;
    wb.is_looping = true;
    audrvVoiceAddWaveBuf(&d, 0, &wb);
    audrvVoiceStart(&d, 0);
}

while (appletMainLoop()) {
    audrvUpdate(&d);
    audrenWaitFrame();
}
audrvClose(&d);
```

--------------------------------

### svcStartProcess

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Starts a created process. This is a privileged call.

```APIDOC
## svcStartProcess

### Description
Starts a created process. This is a privileged call.

### Method
svcStartProcess

### Signature
Result svcStartProcess(Handle proc, s32 main_prio, s32 default_cpu, u32 stack_size);

### Parameters
- **proc** (Handle) - Handle of the process to start.
- **main_prio** (s32) - Main thread priority.
- **default_cpu** (s32) - Default CPU core.
- **stack_size** (u32) - Stack size.

### Return Value
Result code indicating success or failure.

```

--------------------------------

### utimerStart

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Starts the user timer.

```APIDOC
## utimerStart

### Description
Starts the user timer.

### Function Signature
void utimerStart(UTimer* t);

### Parameters
- **t** (UTimer*) - Required - Pointer to the UTimer.

### Return Value
None.
```

--------------------------------

### swkbdConfigSetGuideText

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Sets the guide text displayed at the bottom of the keyboard.

```APIDOC
## swkbdConfigSetGuideText

### Description
Sets the guide text displayed at the bottom of the keyboard.

### Function Signature
`void swkbdConfigSetGuideText(SwkbdConfig* c, const char* str);`

### Parameters
- **c** (SwkbdConfig*) - Required - Pointer to the configuration object.
- **str** (const char*) - Required - The guide text.

### Return Value
None.

### Example
```c
swkbdConfigSetGuideText(&kbd, "Use the keyboard to enter text.");
```
```

--------------------------------

### Modal keyboard usage example (swkbdCreate, preset, show)

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Complete example of showing a modal software keyboard. Creates a SwkbdConfig, applies the default preset, sets the type to SwkbdType_Normal, sets a header text and maximum string length, then calls swkbdShow. On success, prints the entered name. Always call swkbdClose to clean up.

```c
SwkbdConfig kbd;
char out[128];
swkbdCreate(&kbd, 0);
swkbdConfigMakePresetDefault(&kbd);
swkbdConfigSetType(&kbd, SwkbdType_Normal);
swkbdConfigSetHeaderText(&kbd, "Enter your name:");
swkbdConfigSetStringLenMax(&kbd, 16);
Result rc = swkbdShow(&kbd, out, sizeof(out));
if (R_SUCCEEDED(rc)) printf("name: %s\n", out);
swkbdClose(&kbd);
```

--------------------------------

### svcStartThread

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Starts a previously created thread.

```APIDOC
## svcStartThread

### Description
Starts a previously created thread.

### Method
svcStartThread

### Signature
Result svcStartThread(Handle handle);

### Parameters
- **handle** (Handle) - Handle of the thread to start.

### Return Value
Result code indicating success or failure.

```

--------------------------------

### One-shot launch with args using libappletLaunch

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Shows how to create LibAppletArgs, launch the software keyboard applet (AppletId_LibraryAppletSwkbd) with the string "hello" as input, and check the result. R_FAILED includes LibnxError_LibAppletBadExit on abnormal applet exit.

```c
#include <switch.h>

LibAppletArgs args;
libappletArgsCreate(&args, 0);

// Send the string "hello" as input:
Result rc = libappletLaunch(AppletId_LibraryAppletSwkbd, &args,
                            "hello", 5, reply_buf, sizeof(reply_buf), &reply_size);
if (R_FAILED(rc)) {
    // R_FAILED includes LibnxError_LibAppletBadExit on abnormal applet exit
    printf("launch failed: 0x%X\n", rc);
}
```

--------------------------------

### TLS slot usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Allocates a TLS slot, sets a value, retrieves it, and frees the slot. The destructor is NULL in this example.

```c
// TLS slots
s32 slot = threadTlsAlloc(NULL);
threadTlsSet(slot, some_ptr);
void* p = threadTlsGet(slot);
threadTlsFree(slot);
```

--------------------------------

### General channel requests API functions

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Declarations for applet service functions: set terminate result, get launch storage info, get GPU error event, set home button handling, and get applet info. Note that appletGetAppletInfo is LibraryApplet only and returns NULL when unavailable.

```c
Result appletSetTerminateResult(Result res);
Result appletGetLaunchStorageInfoForDebug(NcmStorageId *app_storageId, NcmStorageId *update_storageId);
Result appletGetGpuErrorDetectedSystemEvent(Event *out_event);
Result appletSetHandlingHomeButtonShortPressedEnabled(bool flag);
AppletInfo *appletGetAppletInfo(void);   // LibraryApplet only; NULL when unavailable
```

--------------------------------

### UTF-8 to UTF-16 conversion example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/runtime.md

Example of converting a UTF-8 string to UTF-16 using utf8_to_utf16. The return value n is negative if the input is invalid UTF-8.

```c
uint16_t wbuf[256];
ssize_t n = utf8_to_utf16(wbuf, (const uint8_t*)"hello", 256);
if (n < 0) { /* invalid UTF-8 */ }
```

--------------------------------

### swkbdInlineLaunch

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Launches the inline keyboard applet for the current application.

```APIDOC
## swkbdInlineLaunch

### Description
Launches the inline keyboard applet for the current application.

### Method
Function

### Signature
```c
Result swkbdInlineLaunch(SwkbdInline* s);
```

### Parameters
- **s** (SwkbdInline*) - Required - Pointer to the inline keyboard session object.

### Return Value
- **Result** - 0 on success, otherwise an error code.
```

--------------------------------

### Cache flush example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/arm.md

Example of flushing and invalidating cache after writing generated code. Includes the switch.h header and calls armDCacheFlush and armICacheInvalidate on the code buffer.

```c
#include <switch.h>

// After writing generated code:
armDCacheFlush(code, code_size);
armICacheInvalidate(code, code_size);
```

--------------------------------

### Socket driver usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/devices.md

Shows initializing the socket driver with defaults, creating a socket, and exiting. The comment indicates standard BSD usage between socket creation and exit.

```c
socketInitializeDefault();
int fd = socket(AF_INET, SOCK_STREAM, 0);
// ... standard BSD usage ...
socketExit();
```

--------------------------------

### envSetup

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/runtime.md

Initializes the runtime environment by parsing the loader config block. Called by startup code before main().

```APIDOC
## envSetup

### Description
Initializes the runtime environment by parsing the loader config block. Called by startup code before main().

### Function Signature
```c
void envSetup(void* ctx, Handle main_thread, LoaderReturnFn saved_lr);
```

### Parameters
- **ctx** (void*) - Required - Context pointer, typically NULL for NSO case.
- **main_thread** (Handle) - Required - Handle to the main thread.
- **saved_lr** (LoaderReturnFn) - Required - Function pointer for loader return.

### Notes
When called with NULL ctx (NSO case), sets the loader return to `svcExitProcess` and hints all syscalls as available.
```

--------------------------------

### Framebuffer usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/display.md

Shows how to create a framebuffer, render a red frame, and present it. Must pair framebufferBegin and framebufferEnd.

```c
#include <switch.h>

NWindow* win = nwindowGetDefault();
Framebuffer fb;
Result rc = framebufferCreate(&fb, win, 1280, 720, PIXEL_FORMAT_RGBA_8888, 2);
if (R_FAILED(rc)) diagAbortWithResult(rc);

while (appletMainLoop()) {
    u32 stride;
    u32* buf = framebufferBegin(&fb, &stride);
    // clear to red:
    for (u32 y = 0; y < 720; y++)
        for (u32 x = 0; x < 1280; x++)
            buf[y * (stride / 4) + x] = RGBA8(255, 0, 0, 255);
    framebufferEnd(&fb);
}
framebufferClose(&fb);
```

--------------------------------

### Thread context dump example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/arm.md

Example of dumping a paused thread's context using threadDumpContext and checking if it is AArch64. Prints PC, LR, and SP registers.

```c
ThreadContext ctx;
Result rc = threadDumpContext(&ctx, &my_thread);
if (R_SUCCEEDED(rc) && threadContextIsAArch64(&ctx)) {
    printf("PC = %p, LR = %p, SP = %p\n", (void*)ctx.pc.x, (void*)ctx.lr, (void*)ctx.sp);
}
```

--------------------------------

### libappletLaunch

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Launches a LibraryApplet with the given arguments and retrieves the reply.

```APIDOC
## libappletLaunch

### Description
Launches a LibraryApplet with the given arguments and retrieves the reply.

### Signature
Result libappletLaunch(AppletId id, LibAppletArgs *commonargs, const void* arg, size_t arg_size, void* reply, size_t reply_size, size_t *out_reply_size);

### Parameters
- **id** (AppletId) - Required - The LibraryApplet ID to launch.
- **commonargs** (LibAppletArgs*) - Required - Pointer to the common arguments.
- **arg** (const void*) - Required - Input data to send to the applet.
- **arg_size** (size_t) - Required - Size of the input data.
- **reply** (void*) - Required - Buffer to receive the reply.
- **reply_size** (size_t) - Required - Size of the reply buffer.
- **out_reply_size** (size_t*) - Required - Output for the actual reply size.

### Returns
- Result - 0 on success, otherwise an error code.
```

--------------------------------

### Vsync-synced loop with error handling

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/display.md

Shows how to initialize the display, get the vsync event, and wait for it in a loop. Requires viInitialize and viOpenDefaultDisplay.

```c
// Vsync-synced loop with error handling:
Result rc = viInitialize(ViServiceType_Default);
ViDisplay disp;
if (R_SUCCEEDED(rc)) rc = viOpenDefaultDisplay(&disp);
Event vsync;
if (R_SUCCEEDED(rc)) rc = viGetDisplayVsyncEvent(&disp, &vsync);
if (R_FAILED(rc)) diagAbortWithResult(rc);
while (appletMainLoop()) {
    eventWait(&vsync, UINT64_MAX);
    /* render ... */
}
```

--------------------------------

### Wait on an event and a thread example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Example of waiting on an event and a thread using waitObjects. The array ws contains waiters for the event and thread; the index of the signaled object is stored in which.

```c
// Wait on an event + a thread:
Waiter ws[] = { waiterForEvent(&ev), waiterForThread(&t) };
s32 which;
Result rc = waitObjects(&which, ws, 2, UINT64_MAX);
if (R_SUCCEEDED(rc)) printf("signaled: %d\n", which);
```

--------------------------------

### tipcCreate

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/sf.md

Initializes a TipcService with a given handle.

```APIDOC
## tipcCreate

### Description
Initializes a TipcService with a given handle.

### Function Signature
```c
NX_CONSTEXPR void tipcCreate(TipcService* s, Handle h);
```

### Parameters
- **s** (TipcService*) - Required - Pointer to the TipcService structure.
- **h** (Handle) - Required - The handle to associate with the service.
```

--------------------------------

### setsysGetEdid

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the EDID.

```APIDOC
## setsysGetEdid

### Description
Gets the EDID.

### Method
C Function

### Signature
Result setsysGetEdid(SetSysEdid *out);

### Parameters
- **out** (SetSysEdid*) - Required - Output pointer to receive the EDID.

### Return Value
Result - The result of the operation.

```

--------------------------------

### Wait on one handle with timeout example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Example of calling svcWaitSynchronization to wait on a single handle with a 1-second timeout. The timeout value is 1000000000 nanoseconds. Check for KernelError_TimedOut to handle the timeout case.

```c
// Wait on one handle with a 1s timeout:
s32 idx;
Result rc = svcWaitSynchronization(&idx, &handle, 1, 1000000000ULL);
if (R_VALUE(rc) == KernelError_TimedOut) { /* handle timeout */ }
```

--------------------------------

### libappletRequestToLaunchApplication

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Requests the system to launch a specific application. Available since firmware 11.0.0+.

```APIDOC
## libappletRequestToLaunchApplication

### Description
Requests the system to launch a specific application. Available since firmware 11.0.0+.

### Signature
Result libappletRequestToLaunchApplication(u64 application_id, AccountUid uid, const void* buffer, size_t size, u32 sender);

### Parameters
- **application_id** (u64) - Required - The application ID to launch.
- **uid** (AccountUid) - Required - The user account UID.
- **buffer** (const void*) - Required - Additional data buffer.
- **size** (size_t) - Required - Size of the buffer.
- **sender** (u32) - Required - Sender identifier.

### Returns
- Result - 0 on success, otherwise an error code.
```

--------------------------------

### setsysGetQuestFlag

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the quest flag.

```APIDOC
## setsysGetQuestFlag

### Description
Gets the quest flag.

### Method
C Function

### Signature
Result setsysGetQuestFlag(bool *out);

### Parameters
- **out** (bool*) - Required - Output pointer to receive the flag.

### Return Value
Result - The result of the operation.

```

--------------------------------

### swkbdInlineLaunchForLibraryApplet

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Launches the inline keyboard applet for a library applet with specified mode and unknown parameter.

```APIDOC
## swkbdInlineLaunchForLibraryApplet

### Description
Launches the inline keyboard applet for a library applet with specified mode and unknown parameter.

### Method
Function

### Signature
```c
Result swkbdInlineLaunchForLibraryApplet(SwkbdInline* s, u8 mode, u8 unk_x5);
```

### Parameters
- **s** (SwkbdInline*) - Required - Pointer to the inline keyboard session object.
- **mode** (u8) - Required - Mode for the library applet launch.
- **unk_x5** (u8) - Required - Unknown parameter.

### Return Value
- **Result** - 0 on success, otherwise an error code.
```

--------------------------------

### fsOpenHostFileSystemWithOption

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/fs.md

Opens a host filesystem with options. Available since 9.0.0.

```APIDOC
## fsOpenHostFileSystemWithOption

### Description
Opens a host filesystem with options. Available since 9.0.0.

### Function Signature
```c
Result fsOpenHostFileSystemWithOption(FsFileSystem* out, const char *path, u32 flags);
```

### Parameters
- `out` (FsFileSystem*) - Required - Pointer to the output filesystem handle.
- `path` (const char*) - Required - The path to the host filesystem.
- `flags` (u32) - Required - Flags for the filesystem.

### Return Value
- `Result` - The result of the operation.

```

--------------------------------

### setsysGetNotificationSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets notification settings.

```APIDOC
## setsysGetNotificationSettings

### Description
Gets notification settings.

### Method
C Function

### Signature
Result setsysGetNotificationSettings(SetSysNotificationSettings *out);

### Parameters
- **out** (SetSysNotificationSettings*) - Required - Output pointer to receive the settings.

### Return Value
Result - The result of the operation.

```

--------------------------------

### Standard homebrew RomFS usage pattern

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/devices.md

Shows the typical pattern of initializing RomFS with romfsInit, checking the result, opening a file from the mounted 'romfs:/' path, and cleaning up with romfsExit. The example opens 'romfs:/data/strings.txt' for reading.

```c
// Standard homebrew pattern:
Result rc = romfsInit();   // mount app romfs at "romfs:/"
if (R_SUCCEEDED(rc))
    FILE* f = fopen("romfs:/data/strings.txt", "r");
...
romfsExit();
```

--------------------------------

### setsysGetEulaVersions

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets EULA versions.

```APIDOC
## setsysGetEulaVersions

### Description
Gets EULA versions.

### Method
C Function

### Signature
Result setsysGetEulaVersions(s32 *total_out, SetSysEulaVersion *versions, s32 count);

### Parameters
- **total_out** (s32*) - Required - Output pointer to receive the total number of versions.
- **versions** (SetSysEulaVersion*) - Required - Output buffer to receive the versions.
- **count** (s32) - Required - Maximum number of versions to write.

### Return Value
Result - The result of the operation.

```

--------------------------------

### consoleInit

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/devices.md

Initializes a console. If NULL is passed, the default console is used.

```APIDOC
## consoleInit

### Description
Initializes a console. If NULL is passed, the default console is used.

### Function Signature
PrintConsole* consoleInit(PrintConsole* console);

### Parameters
- **console** (PrintConsole*) - Optional - Pointer to the console to initialize, or NULL for default.

### Return Value
- **PrintConsole*** - Pointer to the initialized console.
```

--------------------------------

### setsysGetAccountSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets account settings.

```APIDOC
## setsysGetAccountSettings

### Description
Gets account settings.

### Method
C Function

### Signature
Result setsysGetAccountSettings(SetSysAccountSettings *out);

### Parameters
- **out** (SetSysAccountSettings*) - Required - Output pointer to receive the settings.

### Return Value
Result - The result of the operation.

```

--------------------------------

### setsysGetBacklightSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets backlight settings.

```APIDOC
## setsysGetBacklightSettings

### Description
Gets backlight settings.

### Method
C Function

### Signature
Result setsysGetBacklightSettings(SetSysBacklightSettings *out);

### Parameters
- **out** (SetSysBacklightSettings*) - Required - Output pointer to receive the settings.

### Return Value
Result - The result of the operation.

```

--------------------------------

### swkbdCreate

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Creates a software keyboard configuration object. Must be called before configuring and showing the keyboard.

```APIDOC
## swkbdCreate

### Description
Creates a software keyboard configuration object. Must be called before configuring and showing the keyboard.

### Function Signature
`Result swkbdCreate(SwkbdConfig* c, s32 max_dictwords);`

### Parameters
- **c** (SwkbdConfig*) - Required - Pointer to the configuration object to initialize.
- **max_dictwords** (s32) - Required - Maximum number of dictionary words to use.

### Return Value
- **Result** - Returns 0 on success, or an error code on failure.

### Example
```c
SwkbdConfig kbd;
Result rc = swkbdCreate(&kbd, 0);
```
```

--------------------------------

### setsysGetFirmwareVersion

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the firmware version.

```APIDOC
## setsysGetFirmwareVersion

### Description
Gets the firmware version.

### Method
C Function

### Signature
Result setsysGetFirmwareVersion(SetSysFirmwareVersion *out);

### Parameters
- **out** (SetSysFirmwareVersion*) - Required - Output pointer to receive the firmware version.

### Return Value
Result - The result of the operation.

```

--------------------------------

### audrenInitialize

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/audio.md

Initializes the audio renderer service with the specified configuration.

```APIDOC
## audrenInitialize

### Description
Initializes the audio renderer service with the specified configuration.

### Function Signature
```c
Result audrenInitialize(const AudioRendererConfig* config);
```

### Parameters
- **config** (const AudioRendererConfig*) - Required - Pointer to the audio renderer configuration.

### Return Value
- **Result** - 0 on success, otherwise an error code.

```

--------------------------------

### setsysGetNetworkSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets network settings.

```APIDOC
## setsysGetNetworkSettings

### Description
Gets network settings.

### Method
C Function

### Signature
Result setsysGetNetworkSettings(s32 *total_out, SetSysNetworkSettings *settings, s32 count);

### Parameters
- **total_out** (s32*) - Required - Output pointer to receive the total number of settings.
- **settings** (SetSysNetworkSettings*) - Required - Output buffer to receive the settings.
- **count** (s32) - Required - Maximum number of settings to write.

### Return Value
Result - The result of the operation.

```

--------------------------------

### Example: grow the heap with svcSetHeapSize

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Shows how to grow the heap using `svcSetHeapSize`. The size must be a multiple of 0x200000. On failure, `diagAbortWithResult` is called with the result code.

```c
// Example: grow the heap
void* heap;
Result rc = svcSetHeapSize(&heap, 0x4000000);
if (R_FAILED(rc)) diagAbortWithResult(rc);
```

--------------------------------

### setGetDeviceNickname

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the device nickname.

```APIDOC
## setGetDeviceNickname

### Description
Gets the device nickname.

### Method
C Function

### Signature
Result setGetDeviceNickname(SetSysDeviceNickName *nickname);

### Parameters
- **nickname** (SetSysDeviceNickName*) - Required - Output pointer to receive the nickname.

### Return Value
Result - The result of the operation.

```

--------------------------------

### setGetQuestFlag

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the quest flag.

```APIDOC
## setGetQuestFlag

### Description
Gets the quest flag.

### Method
C Function

### Signature
Result setGetQuestFlag(bool *out);

### Parameters
- **out** (bool*) - Required - Output pointer to receive the quest flag.

### Return Value
Result - The result of the operation.

```

--------------------------------

### nvMapInit

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/nvidia.md

Initializes the NvMap subsystem by opening /dev/nvmap.

```APIDOC
## nvMapInit

### Description
Initializes the NvMap subsystem by opening /dev/nvmap.

### Method
Function

### Signature
```c
Result nvMapInit(void);
```

### Parameters
None

### Return Value
- **Result** - The result of the initialization.

```

--------------------------------

### setGetRegionCode

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the region code.

```APIDOC
## setGetRegionCode

### Description
Gets the region code.

### Method
C Function

### Signature
Result setGetRegionCode(SetRegion *out);

### Parameters
- **out** (SetRegion*) - Required - Output pointer to receive the region code.

### Return Value
Result - The result of the operation.

```

--------------------------------

### fsInitialize

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/fs.md

Initializes the filesystem service. Called automatically during app startup.

```APIDOC
## fsInitialize

### Description
Initializes the filesystem service. Called automatically during app startup.

### Function Signature
```c
Result fsInitialize(void);
```

### Parameters
None.

### Return Value
- `Result` - The result of the operation.

```

--------------------------------

### svcGetThreadContext3

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Gets the context of a thread.

```APIDOC
## svcGetThreadContext3

### Description
Gets the context of a thread.

### Method
svcGetThreadContext3

### Signature
Result svcGetThreadContext3(ThreadContext* ctx, Handle thread);

### Parameters
- **ctx** (ThreadContext*) - Output pointer to receive the thread context.
- **thread** (Handle) - Handle of the thread.

### Return Value
Result code indicating success or failure.

```

--------------------------------

### nvGpuInit

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/nvidia.md

Initializes the GPU context by opening the /dev/nvhost-gpu device. Must be called before using other GPU functions.

```APIDOC
## nvGpuInit

### Description
Initializes the GPU context by opening the /dev/nvhost-gpu device. Must be called before using other GPU functions.

### Method
Function

### Signature
```c
Result nvGpuInit(void);
```

### Parameters
None

### Return Value
- **Result** - 0 on success, or an error code on failure.
```

--------------------------------

### List a directory with fsFsOpenDirectory and fsDirRead

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/fs.md

Opens the root directory of the filesystem, reads up to 16 entries, prints each entry type (D for directory, F for file) and name, then closes the directory.

```c
// List a directory
FsDir dir;
if (R_SUCCEEDED(fsFsOpenDirectory(&fs, "/", FsDirOpenMode_ReadDirs | FsDirOpenMode_ReadFiles, &dir))) {
    FsDirectoryEntry entries[16];
    s64 n;
    rc = fsDirRead(&dir, &n, 16, entries);
    for (s64 i = 0; i < n; i++)
        printf("%c %s\n", entries[i].type == FsDirEntryType_Dir ? 'D' : 'F', entries[i].name);
    fsDirClose(&dir);
}
```

--------------------------------

### svcGetThreadPriority

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-svc.md

Gets the priority of a thread.

```APIDOC
## svcGetThreadPriority

### Description
Gets the priority of a thread.

### Method
svcGetThreadPriority

### Signature
Result svcGetThreadPriority(s32* priority, Handle handle);

### Parameters
- **priority** (s32*) - Output pointer to receive the thread priority.
- **handle** (Handle) - Handle of the thread.

### Return Value
Result code indicating success or failure.

```

--------------------------------

### swkbdInlineCreate

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/libapplets.md

Creates an inline keyboard session and sets UTF-8 mode. Available since firmware 2.0.0.

```APIDOC
## swkbdInlineCreate

### Description
Creates an inline keyboard session and sets UTF-8 mode. Available since firmware 2.0.0.

### Method
Function

### Signature
```c
Result swkbdInlineCreate(SwkbdInline* s);
```

### Parameters
- **s** (SwkbdInline*) - Required - Pointer to the inline keyboard session object.

### Return Value
- **Result** - 0 on success, otherwise an error code.
```

--------------------------------

### audrenStartAudioRenderer

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/audio.md

Starts the audio renderer.

```APIDOC
## audrenStartAudioRenderer

### Description
Starts the audio renderer.

### Function Signature
```c
Result audrenStartAudioRenderer(void);
```

### Parameters
None.

### Return Value
- **Result** - 0 on success, otherwise an error code.

```

--------------------------------

### Applet hook usage example with main loop

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Example of registering an applet hook and running the main loop. The hook callback checks for AppletHookType_OnExitRequest, and appletMainLoop() will return false when exit is requested. The hook is unregistered after the loop.

```c
#include <switch.h>

static AppletHookCookie cookie;
static void hook(AppletHookType type, void* param) {
    if (type == AppletHookType_OnExitRequest) {
        /* running appletMainLoop() will return false */
    }
}

int main(int argc, char* argv[]) {
    appletHook(&cookie, hook, NULL);
    while (appletMainLoop()) {
        // game loop
    }
    appletUnhook(&cookie);
    return 0;
}
```

--------------------------------

### FS devoptab usage example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/devices.md

Mounts the SD card as 'sdmc:' and writes a file using standard stdio functions. Requires including switch.h and checking the result of fsdevMountSdmc.

```c
#include <switch.h>

Result rc = fsdevMountSdmc();
if (R_SUCCEEDED(rc)) {
    FILE* f = fopen("sdmc:/hello.txt", "w");
    if (f) { fputs("hi", f); fclose(f); }
}
// "sdmc:/" paths now work with all stdio functions
```

--------------------------------

### Create and start four worker threads

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Creates four threads with a worker function that prints a message, starts them, waits for exit, and closes them. Uses a stack size of 0x8000, priority 0x30, and default core (-2).

```c
#include <switch.h>

static void worker(void* arg) {
    long id = (long)arg;
    printf("hello from thread %ld\n", id);
}

Thread t[4];
for (long i = 0; i < 4; i++) {
    threadCreate(&t[i], worker, (void*)i, NULL, 0x8000, 0x30, -2);
    threadStart(&t[i]);
}
for (int i = 0; i < 4; i++) {
    threadWaitForExit(&t[i]);
    threadClose(&t[i]);
}
```

--------------------------------

### smInitialize

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/sm.md

Initializes the service manager. This is called automatically before main() in libnx startup, but can be called manually if needed.

```APIDOC
## smInitialize

### Description
Initializes the service manager. This is called automatically before main() in libnx startup, but can be called manually if needed.

### Method
Function

### Signature
```c
Result smInitialize(void);
```

### Parameters
None.

### Return Value
- `Result` - The result of the initialization. `0` on success, otherwise an error code.

### Remarks
This function is refcounted; multiple calls will increment the reference count. `smExit()` decrements it.
```

--------------------------------

### USB comms synchronous example

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/usb.md

Shows initialization, writing a string to the host, reading a response, and exiting. The error handling is default (false), so read/write return transferred size on failure.

```c
#include <switch.h>

Result rc = usbCommsInitialize();
if (R_FAILED(rc)) { /* failed to claim the USB device */ }

usbCommsWrite("hello host", 10);

char buf[64];
size_t got = usbCommsRead(buf, sizeof(buf));
printf("received %zd bytes\n", got);

usbCommsExit();
```

--------------------------------

### setsysGetDataDeletionSettings

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets data deletion settings.

```APIDOC
## setsysGetDataDeletionSettings

### Description
Gets data deletion settings.

### Method
C Function

### Signature
Result setsysGetDataDeletionSettings(SetSysDataDeletionSettings *out);

### Parameters
- **out** (SetSysDataDeletionSettings*) - Required - Output pointer to receive the settings.

### Return Value
Result - The result of the operation.

```

--------------------------------

### setsysGetSpeakerAutoMuteFlag

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the speaker auto-mute flag.

```APIDOC
## setsysGetSpeakerAutoMuteFlag

### Description
Gets the speaker auto-mute flag.

### Method
C Function

### Signature
Result setsysGetSpeakerAutoMuteFlag(bool *out);

### Parameters
- **out** (bool*) - Required - Output pointer to receive the flag.

### Return Value
Result - The result of the operation.

```

--------------------------------

### jitCreate

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/kernel-sync.md

Creates a JIT context with the given size. Returns an error code, with LibnxError_JitUnavailable on unsupported environments.

```APIDOC
## jitCreate

### Description
Creates a JIT context with the given size. Returns an error code, with LibnxError_JitUnavailable on unsupported environments.

### Function Signature
`Result jitCreate(Jit* j, size_t size)`

### Parameters
- **j** (Jit*) - Required - Pointer to the JIT context to initialize.
- **size** (size_t) - Required - Size of the JIT memory region.

### Return Value
- `Result` - Result code indicating success or failure.

### Usage Example
```c
Jit j;
Result rc = jitCreate(&j, 0x1000);
if (R_FAILED(rc)) { /* LibnxError_JitUnavailable on unsupported env */ }
```
```

--------------------------------

### setsysGetAudioOutputMode

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the audio output mode.

```APIDOC
## setsysGetAudioOutputMode

### Description
Gets the audio output mode.

### Method
C Function

### Signature
Result setsysGetAudioOutputMode(SetSysAudioOutputModeTarget target, SetSysAudioOutputMode *out);

### Parameters
- **target** (SetSysAudioOutputModeTarget) - Required - The target device.
- **out** (SetSysAudioOutputMode*) - Required - Output pointer to receive the mode.

### Return Value
Result - The result of the operation.

```

--------------------------------

### setsysGetSettingsItemValue

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the value of a settings item.

```APIDOC
## setsysGetSettingsItemValue

### Description
Gets the value of a settings item.

### Method
C Function

### Signature
Result setsysGetSettingsItemValue(const char *name, const char *item_key, void *value_out, size_t value_out_size, u64 *size_out);

### Parameters
- **name** (const char*) - Required - The settings item name.
- **item_key** (const char*) - Required - The item key.
- **value_out** (void*) - Required - Output buffer to receive the value.
- **value_out_size** (size_t) - Required - Size of the output buffer.
- **size_out** (u64*) - Required - Output pointer to receive the actual size.

### Return Value
Result - The result of the operation.

```

--------------------------------

### fsOpenHostFileSystem

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/fs.md

Opens a host filesystem.

```APIDOC
## fsOpenHostFileSystem

### Description
Opens a host filesystem.

### Function Signature
```c
Result fsOpenHostFileSystem(FsFileSystem* out, const char *path);
```

### Parameters
- `out` (FsFileSystem*) - Required - Pointer to the output filesystem handle.
- `path` (const char*) - Required - The path to the host filesystem.

### Return Value
- `Result` - The result of the operation.

```

--------------------------------

### Send data to a library applet using IStorage

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/applet.md

Example showing how to create a storage, write 4 bytes to it, and push it to a library applet via appletHolderPushInData, which closes the storage.

```c
// Send 4 bytes to a library applet:
AppletStorage st;
Result rc = appletCreateStorage(&st, 4);
if (R_SUCCEEDED(rc)) rc = appletStorageWrite(&st, 0, &val, 4);
if (R_SUCCEEDED(rc)) rc = appletHolderPushInData(&h, &st); // closes storage
```

--------------------------------

### setsysGetVibrationMasterVolume

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/settings.md

Gets the vibration master volume.

```APIDOC
## setsysGetVibrationMasterVolume

### Description
Gets the vibration master volume.

### Method
C Function

### Signature
Result setsysGetVibrationMasterVolume(float *out);

### Parameters
- **out** (float*) - Required - Output pointer to receive the volume.

### Return Value
Result - The result of the operation.

```

--------------------------------

### Lifecycle functions

Source: https://github.com/switchbrew/libnx/blob/master/_autodocs/api-reference/sm.md

Declares smInitialize() and smExit(). smInitialize() runs automatically before main() in libnx startup, and smExit() runs at exit.

```c
Result smInitialize(void);   // already called before main()
void   smExit(void);         // already called after main()
```
Tokens:
Raw