mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-22 13:02:38 +02:00
78 lines
2.9 KiB
C
78 lines
2.9 KiB
C
/**
|
|
* @file libapplet.h
|
|
* @brief LibraryApplet wrapper.
|
|
* @author yellows8
|
|
* @copyright libnx Authors
|
|
*/
|
|
#pragma once
|
|
#include "../types.h"
|
|
#include "../services/applet.h"
|
|
|
|
/// CommonArguments
|
|
typedef struct {
|
|
u32 CommonArgs_version;
|
|
u32 CommonArgs_size;
|
|
|
|
u32 LaVersion; ///< LibraryApplet API version
|
|
s32 ExpectedThemeColor; ///< Set to the output from \ref appletGetThemeColorType by \ref libappletArgsCreate.
|
|
u8 PlayStartupSound; ///< bool flag, default is false.
|
|
u8 pad[7];
|
|
u64 tick;
|
|
} LibAppletArgs;
|
|
|
|
/**
|
|
* @brief Creates a LibAppletArgs struct.
|
|
* @param a LibAppletArgs struct.
|
|
* @param version LaVersion for \ref LibAppletArgs.
|
|
*/
|
|
void libappletArgsCreate(LibAppletArgs* a, u32 version);
|
|
|
|
/**
|
|
* @brief Sets the PlayStartupSound field in \ref LibAppletArgs.
|
|
* @param a LibAppletArgs struct.
|
|
* @param flag Value for \ref LibAppletArgs PlayStartupSound.
|
|
*/
|
|
void libappletArgsSetPlayStartupSound(LibAppletArgs* a, bool flag);
|
|
|
|
/**
|
|
* @brief Reads data from offset 0 from the specified storage into the buffer. If the storage-size is smaller than the size param, the storage-size is used instead.
|
|
* @param s Storage object.
|
|
* @param buffer Output buffer.
|
|
* @param size Size to read.
|
|
* @param transfer_size Optional output size field for the actual size used for the read.
|
|
*/
|
|
Result libappletReadStorage(AppletStorage* s, void* buffer, size_t size, size_t *transfer_size);
|
|
|
|
/**
|
|
* @brief Sets the tick field in LibAppletArgs, then creates a storage with it which is pushed to the AppletHolder via \ref appletHolderPushInData.
|
|
* @param a LibAppletArgs struct.
|
|
* @param h AppletHolder object.
|
|
*/
|
|
Result libappletArgsPush(LibAppletArgs* a, AppletHolder *h);
|
|
|
|
/**
|
|
* @brief Creates a storage using the input buffer which is pushed to the AppletHolder via \ref appletHolderPushInData.
|
|
* @param h AppletHolder object.
|
|
* @param buffer Input data buffer.
|
|
* @param size Input data size.
|
|
*/
|
|
Result libappletPushInData(AppletHolder *h, const void* buffer, size_t size);
|
|
|
|
/**
|
|
* @brief Pops a storage via \ref appletHolderPopOutData, uses \ref libappletReadStorage, then closes the storage.
|
|
* @param h AppletHolder object.
|
|
* @param buffer Output buffer.
|
|
* @param size Size to read.
|
|
* @param transfer_size Optional output size field for the actual size used for the read.
|
|
*/
|
|
Result libappletPopOutData(AppletHolder *h, void* buffer, size_t size, size_t *transfer_size);
|
|
|
|
/// Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.
|
|
/// Returns to the main Home Menu, equivalent to pressing the HOME button.
|
|
Result libappletRequestHomeMenu(void);
|
|
|
|
/// Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.
|
|
/// Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.
|
|
Result libappletRequestJumpToSystemUpdate(void);
|
|
|