DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation update

Browse Source
This commit is contained in:
Lázaro Vieira 2018-08-07 06:07:37 -03:00
parent b1cd75ef2d
commit 341f57307c
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
libctru/include/3ds/services/frd.h
View File

@ -7,7 +7,7 @@
#define FRIEND_SCREEN_NAME_SIZE 0x16 // 11 (0x16 because UTF-16) #define FRIEND_SCREEN_NAME_SIZE 0x16 // 11 (0x16 because UTF-16)
#define FRIEND_COMMENT_SIZE 0x22 // 16 (0x21 because UTF-16 + null character) #define FRIEND_COMMENT_SIZE 0x22 // 16 (0x21 because UTF-16 + null character)
#define FRIEND_LIST_SIZE 0x64 // 100 (Number of Friends) #define FRIEND_LIST_SIZE 0x64 // 100 (Max. number of friends)
#pragma pack(push, 1) #pragma pack(push, 1)
@ -177,40 +177,43 @@ Result FRD_GetMyComment(char *comment, u32 max_size);
* @param friendKeyList Pointer to write the friend key list to. * @param friendKeyList Pointer to write the friend key list to.
* @param num Stores the number of friend keys obtained. * @param num Stores the number of friend keys obtained.
* @param offset The index of the friend key to start with. * @param offset The index of the friend key to start with.
* @param size Size of the friend key list (max is FRIEND_LIST_SIZE). * @param count Number of entries to read (max is FRIEND_LIST_SIZE).
*/ */
Result FRD_GetFriendKeyList(FriendKey *friendKeyList, u32 *num, u32 offset, u32 count); Result FRD_GetFriendKeyList(FriendKey *friendKeyList, u32 *num, u32 offset, u32 count);
/** /**
* @brief Gets current user's friend Mii data * @brief Gets current user's friends' Mii data
* @param miis Pointer to output the Miis to. * @param miis Pointer to output the Miis to.
* @param keys Pointer to the friend key list. * @param keys Pointer to the friend key list.
* @param offset Start offset. * @param offset Starting offset.
* @param count Mii count. * @param count Mii count.
*/ */
Result FRD_GetFriendMii(MiiData *miis, const FriendKey *keys, u32 offset, u32 count); Result FRD_GetFriendMii(MiiData *miis, const FriendKey *keys, u32 offset, u32 count);
/** /**
* @brief Get a friend's profile data. * @brief Get current user's friends' profile data.
* @param profile Pointer to write profile data to. * @param profile Pointer to write profile data to.
* @param keys Pointer to FriendKeys. * @param keys Pointer to the friend key list.
* @param numberOfKeys Number of FriendKeys. * @param offset Starting offset.
* @param count Profile count.
*/ */
Result FRD_GetFriendProfile(FriendProfile *profile, const FriendKey *keys, u32 offset, u32 count); Result FRD_GetFriendProfile(FriendProfile *profile, const FriendKey *keys, u32 offset, u32 count);
/** /**
* @brief Get a friend's playing Game. * @brief Get current user's friends' playing game.
* @param desc Pointer to write Game Description data to. * @param desc Pointer to write Game Description data to.
* @param keys Pointer to FriendKeys, * @param keys Pointer to the friend key list.
* @param numberOfKeys Number Of FriendKeys. * @param offset Starting offset.
* @param count Entry count.
*/ */
Result FRD_GetFriendPlayingGame(GameDescription *desc, const FriendKey *keys, u32 offset, u32 count); Result FRD_GetFriendPlayingGame(GameDescription *desc, const FriendKey *keys, u32 offset, u32 count);
/** /**
* @brief Get a friend's favourite Game. * @brief Get current user's friends' favourite game.
* @param desc Pointer to write Game Description data to. * @param desc Pointer to write Game Description data to.
* @param keys Pointer to FriendKeys, * @param keys Pointer to the friend key list.
* @param numberOfKeys Number Of FriendKeys. * @param offset Starting offset.
* @param count Entry count.
*/ */
Result FRD_GetFriendFavouriteGame(GameDescription *desc, const FriendKey *keys, u32 offset, u32 count); Result FRD_GetFriendFavouriteGame(GameDescription *desc, const FriendKey *keys, u32 offset, u32 count);