From 4ede25d91e903de393425d259277fffa4ff7e8f0 Mon Sep 17 00:00:00 2001 From: TravisCI-DocBuilder Date: Sun, 15 Nov 2015 22:19:43 +0000 Subject: [PATCH] Doc generated from commit 6e3b2a4cd7a8d65f1bd0fdea441992e8e8016e0c --- 3ds_8h.html | 1 + 3ds_8h_source.html | 224 ++--- app_launch_2source_2main_8c-example.html | 2 +- apt_8h.html | 12 - apt_8h_source.html | 872 +++++++++--------- audio_2mic_2source_2main_8c-example.html | 8 +- cam_8h.html | 98 +- cam_8h_source.html | 48 +- channel_8h.html | 66 +- channel_8h_source.html | 52 +- csnd_8h.html | 116 +-- csnd_8h_source.html | 84 +- dir_d475325f6a9fe3bfc3a495c72a9e475e.html | 3 + env_8h.html | 358 +++++++ env_8h_source.html | 185 ++++ files.html | 45 +- ...tem_language_2source_2main_8c-example.html | 2 +- globals_c.html | 26 +- globals_defs_r.html | 6 - globals_e.html | 21 + globals_eval_c.html | 26 +- globals_eval_g.html | 6 +- globals_eval_k.html | 54 +- globals_eval_n.html | 34 +- globals_eval_p.html | 8 +- globals_eval_r.html | 6 + globals_eval_s.html | 32 +- globals_func_e.html | 21 + globals_func_s.html | 2 +- globals_g.html | 6 +- globals_k.html | 54 +- globals_n.html | 34 +- globals_p.html | 8 +- globals_r.html | 4 +- globals_s.html | 34 +- ...224bit-color_2source_2main_8c-example.html | 2 +- ...u_2geoshader_2source_2main_8c-example.html | 2 +- ..._2simple_tri_2source_2main_8c-example.html | 2 +- ...extured_cube_2source_2main_8c-example.html | 2 +- ...-screen-text_2source_2main_8c-example.html | 2 +- ...colored-text_2source_2main_8c-example.html | 2 +- ...2hello-world_2source_2main_8c-example.html | 2 +- ...windows-text_2source_2main_8c-example.html | 2 +- gsplcd_8h.html | 20 +- gsplcd_8h_source.html | 12 +- hid_8h.html | 116 +-- hid_8h_source.html | 108 +-- http_2source_2main_8c-example.html | 2 +- ...ead-controls_2source_2main_8c-example.html | 2 +- ...touch-screen_2source_2main_8c-example.html | 2 +- ...pplet_launch_2source_2main_8c-example.html | 4 +- mvd_2source_2main_8c-example.html | 2 +- ndsp_8h.html | 24 +- ndsp_8h_source.html | 16 +- qtm_2source_2main_8c-example.html | 2 +- result_8h.html | 18 +- sdmc_2source_2main_8c-example.html | 2 +- srv_8h.html | 12 +- srv_8h_source.html | 8 +- structDebugEventInfo.html | 60 +- structtag__ndspWaveBuf.html | 30 +- threads_2event_2source_2main_8c-example.html | 4 +- time_2rtc_2source_2main_8c-example.html | 2 +- unionCSND__CapInfo.html | 30 +- unionCSND__ChnInfo.html | 48 +- 65 files changed, 1836 insertions(+), 1262 deletions(-) create mode 100644 env_8h.html create mode 100644 env_8h_source.html diff --git a/3ds_8h.html b/3ds_8h.html index ee007e9..461415d 100644 --- a/3ds_8h.html +++ b/3ds_8h.html @@ -102,6 +102,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); #include <3ds/synchronization.h>
#include <3ds/gfx.h>
#include <3ds/console.h>
+#include <3ds/env.h>
#include <3ds/util/utf.h>
#include <3ds/allocator/linear.h>
#include <3ds/allocator/mappable.h>
diff --git a/3ds_8h_source.html b/3ds_8h_source.html index d921af4..33476e3 100644 --- a/3ds_8h_source.html +++ b/3ds_8h_source.html @@ -110,117 +110,118 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
18 #include <3ds/synchronization.h>
19 #include <3ds/gfx.h>
20 #include <3ds/console.h>
-
21 #include <3ds/util/utf.h>
-
22 
-
23 #include <3ds/allocator/linear.h>
-
24 #include <3ds/allocator/mappable.h>
-
25 #include <3ds/allocator/vram.h>
-
26 
-
27 #include <3ds/services/ac.h>
-
28 #include <3ds/services/am.h>
-
29 #include <3ds/services/apt.h>
-
30 #include <3ds/services/cam.h>
-
31 #include <3ds/services/cfgnor.h>
-
32 #include <3ds/services/cfgu.h>
-
33 #include <3ds/services/csnd.h>
-
34 #include <3ds/services/dsp.h>
-
35 #include <3ds/services/fs.h>
-
36 #include <3ds/services/gspgpu.h>
-
37 #include <3ds/services/gsplcd.h>
-
38 #include <3ds/services/hid.h>
-
39 #include <3ds/services/irrst.h>
-
40 #include <3ds/services/httpc.h>
-
41 #include <3ds/services/ir.h>
-
42 #include <3ds/services/ns.h>
-
43 #include <3ds/services/pm.h>
-
44 #include <3ds/services/ps.h>
-
45 #include <3ds/services/ptmu.h>
-
46 #include <3ds/services/ptmsysm.h>
-
47 #include <3ds/services/soc.h>
-
48 #include <3ds/services/mic.h>
-
49 #include <3ds/services/mvd.h>
-
50 #include <3ds/services/news.h>
-
51 #include <3ds/services/qtm.h>
-
52 #include <3ds/services/srvpm.h>
-
53 #include <3ds/services/y2r.h>
-
54 #include <3ds/services/hb.h>
-
55 
-
56 #include <3ds/gpu/gx.h>
-
57 #include <3ds/gpu/gpu.h>
-
58 #include <3ds/gpu/gpu-old.h>
-
59 #include <3ds/gpu/shbin.h>
-
60 #include <3ds/gpu/shaderProgram.h>
-
61 
-
62 #include <3ds/ndsp/ndsp.h>
-
63 #include <3ds/ndsp/channel.h>
-
64 
-
65 #include <3ds/sdmc.h>
-
66 #include <3ds/romfs.h>
-
67 
-
68 #ifdef __cplusplus
-
69 }
-
70 #endif
-
71 /**
-
72  * @example app_launch/source/main.c
-
73  * @example audio/mic/source/main.c
-
74  * @example get_system_language/source/main.c
-
75  * @example graphics/bitmap/24bit-color/source/main.c
-
76  * @example graphics/printing/hello-world/source/main.c
-
77  * @example graphics/printing/both-screen-text/source/main.c
-
78  * @example graphics/printing/colored-text/source/main.c
-
79  * @example graphics/printing/multiple-windows-text/source/main.c
-
80 
-
81  * @example graphics/gpu/geoshader/source/main.c
-
82  graphics/gpu/geoshader/source/gpu.h
-
83  @include graphics/gpu/geoshader/source/gpu.h
-
84  graphics/gpu/geoshader/source/gpu.c
-
85  @include graphics/gpu/geoshader/source/gpu.c
-
86  graphics/gpu/geoshader/source/3dmath.h
-
87  @include graphics/gpu/geoshader/source/3dmath.h
-
88  graphics/gpu/geoshader/source/3dmath.c
-
89  @include graphics/gpu/geoshader/source/3dmath.c
-
90  graphics/gpu/geoshader/source/vshader.pica
-
91  @include graphics/gpu/geoshader/source/vshader.pica
-
92  graphics/gpu/geoshader/source/gshader.pica
-
93  @include graphics/gpu/geoshader/source/gshader.pica
-
94 
-
95 
-
96  * @example graphics/gpu/simple_tri/source/main.c
-
97  graphics/gpu/simple_tri/source/gpu.h
-
98  @include graphics/gpu/simple_tri/source/gpu.h
-
99  graphics/gpu/simple_tri/source/gpu.c
-
100  @include graphics/gpu/simple_tri/source/gpu.c
-
101  graphics/gpu/simple_tri/source/3dmath.h
-
102  @include graphics/gpu/simple_tri/source/3dmath.h
-
103  graphics/gpu/simple_tri/source/3dmath.c
-
104  @include graphics/gpu/simple_tri/source/3dmath.c
-
105  graphics/gpu/simple_tri/source/vshader.pica
-
106  @include graphics/gpu/simple_tri/source/vshader.pica
-
107 
-
108 
-
109  * @example graphics/gpu/textured_cube/source/main.c
-
110  graphics/gpu/textured_cube/source/gpu.h
-
111  @include graphics/gpu/textured_cube/source/gpu.h
-
112  graphics/gpu/textured_cube/source/gpu.c
-
113  @include graphics/gpu/textured_cube/source/gpu.c
-
114  graphics/gpu/textured_cube/source/3dmath.h
-
115  @include graphics/gpu/textured_cube/source/3dmath.h
-
116  graphics/gpu/textured_cube/source/3dmath.c
-
117  @include graphics/gpu/textured_cube/source/3dmath.c
-
118  graphics/gpu/textured_cube/source/vshader.pica
-
119  @include graphics/gpu/textured_cube/source/vshader.pica
-
120 
-
121  * @example http/source/main.c
-
122  * @example input/read-controls/source/main.c
-
123  * @example input/touch-screen/source/main.c
-
124  * @example libapplet_launch/source/main.c
-
125  * @example mvd/source/main.c
-
126  * @example qtm/source/main.c
-
127  * @example sdmc/source/main.c
-
128  * @example threads/event/source/main.c
-
129  * @example time/rtc/source/main.c
-
130  */
-
131 
+
21 #include <3ds/env.h>
+
22 #include <3ds/util/utf.h>
+
23 
+
24 #include <3ds/allocator/linear.h>
+
25 #include <3ds/allocator/mappable.h>
+
26 #include <3ds/allocator/vram.h>
+
27 
+
28 #include <3ds/services/ac.h>
+
29 #include <3ds/services/am.h>
+
30 #include <3ds/services/apt.h>
+
31 #include <3ds/services/cam.h>
+
32 #include <3ds/services/cfgnor.h>
+
33 #include <3ds/services/cfgu.h>
+
34 #include <3ds/services/csnd.h>
+
35 #include <3ds/services/dsp.h>
+
36 #include <3ds/services/fs.h>
+
37 #include <3ds/services/gspgpu.h>
+
38 #include <3ds/services/gsplcd.h>
+
39 #include <3ds/services/hid.h>
+
40 #include <3ds/services/irrst.h>
+
41 #include <3ds/services/httpc.h>
+
42 #include <3ds/services/ir.h>
+
43 #include <3ds/services/ns.h>
+
44 #include <3ds/services/pm.h>
+
45 #include <3ds/services/ps.h>
+
46 #include <3ds/services/ptmu.h>
+
47 #include <3ds/services/ptmsysm.h>
+
48 #include <3ds/services/soc.h>
+
49 #include <3ds/services/mic.h>
+
50 #include <3ds/services/mvd.h>
+
51 #include <3ds/services/news.h>
+
52 #include <3ds/services/qtm.h>
+
53 #include <3ds/services/srvpm.h>
+
54 #include <3ds/services/y2r.h>
+
55 #include <3ds/services/hb.h>
+
56 
+
57 #include <3ds/gpu/gx.h>
+
58 #include <3ds/gpu/gpu.h>
+
59 #include <3ds/gpu/gpu-old.h>
+
60 #include <3ds/gpu/shbin.h>
+
61 #include <3ds/gpu/shaderProgram.h>
+
62 
+
63 #include <3ds/ndsp/ndsp.h>
+
64 #include <3ds/ndsp/channel.h>
+
65 
+
66 #include <3ds/sdmc.h>
+
67 #include <3ds/romfs.h>
+
68 
+
69 #ifdef __cplusplus
+
70 }
+
71 #endif
+
72 /**
+
73  * @example app_launch/source/main.c
+
74  * @example audio/mic/source/main.c
+
75  * @example get_system_language/source/main.c
+
76  * @example graphics/bitmap/24bit-color/source/main.c
+
77  * @example graphics/printing/hello-world/source/main.c
+
78  * @example graphics/printing/both-screen-text/source/main.c
+
79  * @example graphics/printing/colored-text/source/main.c
+
80  * @example graphics/printing/multiple-windows-text/source/main.c
+
81 
+
82  * @example graphics/gpu/geoshader/source/main.c
+
83  graphics/gpu/geoshader/source/gpu.h
+
84  @include graphics/gpu/geoshader/source/gpu.h
+
85  graphics/gpu/geoshader/source/gpu.c
+
86  @include graphics/gpu/geoshader/source/gpu.c
+
87  graphics/gpu/geoshader/source/3dmath.h
+
88  @include graphics/gpu/geoshader/source/3dmath.h
+
89  graphics/gpu/geoshader/source/3dmath.c
+
90  @include graphics/gpu/geoshader/source/3dmath.c
+
91  graphics/gpu/geoshader/source/vshader.pica
+
92  @include graphics/gpu/geoshader/source/vshader.pica
+
93  graphics/gpu/geoshader/source/gshader.pica
+
94  @include graphics/gpu/geoshader/source/gshader.pica
+
95 
+
96 
+
97  * @example graphics/gpu/simple_tri/source/main.c
+
98  graphics/gpu/simple_tri/source/gpu.h
+
99  @include graphics/gpu/simple_tri/source/gpu.h
+
100  graphics/gpu/simple_tri/source/gpu.c
+
101  @include graphics/gpu/simple_tri/source/gpu.c
+
102  graphics/gpu/simple_tri/source/3dmath.h
+
103  @include graphics/gpu/simple_tri/source/3dmath.h
+
104  graphics/gpu/simple_tri/source/3dmath.c
+
105  @include graphics/gpu/simple_tri/source/3dmath.c
+
106  graphics/gpu/simple_tri/source/vshader.pica
+
107  @include graphics/gpu/simple_tri/source/vshader.pica
+
108 
+
109 
+
110  * @example graphics/gpu/textured_cube/source/main.c
+
111  graphics/gpu/textured_cube/source/gpu.h
+
112  @include graphics/gpu/textured_cube/source/gpu.h
+
113  graphics/gpu/textured_cube/source/gpu.c
+
114  @include graphics/gpu/textured_cube/source/gpu.c
+
115  graphics/gpu/textured_cube/source/3dmath.h
+
116  @include graphics/gpu/textured_cube/source/3dmath.h
+
117  graphics/gpu/textured_cube/source/3dmath.c
+
118  @include graphics/gpu/textured_cube/source/3dmath.c
+
119  graphics/gpu/textured_cube/source/vshader.pica
+
120  @include graphics/gpu/textured_cube/source/vshader.pica
+
121 
+
122  * @example http/source/main.c
+
123  * @example input/read-controls/source/main.c
+
124  * @example input/touch-screen/source/main.c
+
125  * @example libapplet_launch/source/main.c
+
126  * @example mvd/source/main.c
+
127  * @example qtm/source/main.c
+
128  * @example sdmc/source/main.c
+
129  * @example threads/event/source/main.c
+
130  * @example time/rtc/source/main.c
+
131  */
+
132 
GSPLCD service.
srv:pm service.
Functions for working with shaders.
@@ -237,6 +238,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
NEWS (Notification) service.
IRRST service.
PM (Process Manager) service.
+
Homebrew environment information.
QTM service.
Deprecated GPU functions which should not be used in new code.
Linear memory allocator.
diff --git a/app_launch_2source_2main_8c-example.html b/app_launch_2source_2main_8c-example.html index a6ce437..381105e 100644 --- a/app_launch_2source_2main_8c-example.html +++ b/app_launch_2source_2main_8c-example.html @@ -102,7 +102,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
// Scan hid shared memory for input events
hidScanInput();
-
if(hidKeysDown() & KEY_A) // If the A button got pressed, start the app launch
+
if(hidKeysDown() & KEY_A) // If the A button got pressed, start the app launch
{
// Clear both buffers
memset(buf0, 0, 0x300);
diff --git a/apt_8h.html b/apt_8h.html index 352dd51..f654d5c 100644 --- a/apt_8h.html +++ b/apt_8h.html @@ -88,7 +88,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Data Structures | -Macros | Typedefs | Enumerations | Functions | @@ -109,17 +108,6 @@ Data Structures  APT hook cookie. More...
  - - - - - - - -

-Macros

-#define RUNFLAG_APTWORKAROUND   (BIT(0))
 APT workaround flag.
 
-#define RUNFLAG_APTREINIT   (BIT(1))
 APT reinititalize flag.
 

Typedefs

diff --git a/apt_8h_source.html b/apt_8h_source.html index fb791d8..051536b 100644 --- a/apt_8h_source.html +++ b/apt_8h_source.html @@ -95,565 +95,559 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
3  * @brief APT (Applet) service.
4  */
5 #pragma once
-
6 
-
7 // TODO: find a better place to put this
-
8 /// APT workaround flag.
-
9 #define RUNFLAG_APTWORKAROUND (BIT(0))
-
10 /// APT reinititalize flag.
-
11 #define RUNFLAG_APTREINIT (BIT(1))
-
12 
-
13 /**
-
14  * @brief NS Application IDs.
-
15  *
-
16  * Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs
-
17  */
-
18 typedef enum {
-
19  APPID_HOMEMENU = 0x101, ///< Home Menu
-
20  APPID_CAMERA = 0x110, ///< Camera applet
-
21  APPID_FRIENDS_LIST = 0x112, ///< Friends List applet
-
22  APPID_GAME_NOTES = 0x113, ///< Game Notes applet
-
23  APPID_WEB = 0x114, ///< Internet Browser
-
24  APPID_INSTRUCTION_MANUAL = 0x115, ///< Instruction Manual applet
-
25  APPID_NOTIFICATIONS = 0x116, ///< Notifications applet
-
26  APPID_MIIVERSE = 0x117, ///< Miiverse applet (olv)
-
27  APPID_MIIVERSE_POSTING = 0x118, ///< Miiverse posting applet (solv3)
-
28  APPID_AMIIBO_SETTINGS = 0x119, ///< Amiibo settings applet (cabinet)
-
29  APPID_APPLICATION = 0x300, ///< Application
-
30  APPID_ESHOP = 0x301, ///< eShop (tiger)
-
31  APPID_SOFTWARE_KEYBOARD = 0x401, ///< Software Keyboard
-
32  APPID_APPLETED = 0x402, ///< appletEd
-
33  APPID_PNOTE_AP = 0x404, ///< PNOTE_AP
-
34  APPID_SNOTE_AP = 0x405, ///< SNOTE_AP
-
35  APPID_ERROR = 0x406, ///< error
-
36  APPID_MINT = 0x407, ///< mint
-
37  APPID_EXTRAPAD = 0x408, ///< extrapad
-
38  APPID_MEMOLIB = 0x409, ///< memolib
-
39 } NS_APPID;
-
40 
-
41 /// App status values.
-
42 typedef enum {
-
43  APP_NOTINITIALIZED, ///< App not initialized.
-
44  APP_RUNNING, ///< App running.
-
45  APP_SUSPENDED, ///< App suspended.
-
46  APP_EXITING, ///< App exiting.
-
47  APP_SUSPENDING, ///< App suspending.
-
48  APP_SLEEPMODE, ///< App in sleep mode.
-
49  APP_PREPARE_SLEEPMODE, ///< App preparing to enter sleep mode.
-
50  APP_APPLETSTARTED, ///< Applet started.
-
51  APP_APPLETCLOSED ///< Applet closed.
- -
53 
-
54 /// APT signals.
-
55 typedef enum {
-
56  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
-
57  // 2: sleep-mode related?
-
58  APTSIGNAL_PREPARESLEEP = 3, ///< Prepare to enter sleep mode.
-
59  // 4: triggered when ptm:s GetShellStatus() returns 5.
-
60  APTSIGNAL_ENTERSLEEP = 5, ///< Enter sleep mode.
-
61  APTSIGNAL_WAKEUP = 6, ///< Wake from sleep mode.
-
62  APTSIGNAL_ENABLE = 7, ///< Enable.
-
63  APTSIGNAL_POWERBUTTON = 8, ///< Power button pressed.
-
64  APTSIGNAL_UTILITY = 9, ///< Utility called.
-
65  APTSIGNAL_SLEEPSYSTEM = 10, ///< System sleeping.
-
66  APTSIGNAL_ERROR = 11 ///< Error occurred.
-
67 } APT_Signal;
-
68 
-
69 /// APT hook types.
-
70 typedef enum {
-
71  APTHOOK_ONSUSPEND = 0, ///< App suspended.
-
72  APTHOOK_ONRESTORE, ///< App restored.
-
73  APTHOOK_ONSLEEP, ///< App sleeping.
-
74  APTHOOK_ONWAKEUP, ///< App waking up.
-
75  APTHOOK_ONEXIT, ///< App exiting.
+
6 
+
7 /**
+
8  * @brief NS Application IDs.
+
9  *
+
10  * Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs
+
11  */
+
12 typedef enum {
+
13  APPID_HOMEMENU = 0x101, ///< Home Menu
+
14  APPID_CAMERA = 0x110, ///< Camera applet
+
15  APPID_FRIENDS_LIST = 0x112, ///< Friends List applet
+
16  APPID_GAME_NOTES = 0x113, ///< Game Notes applet
+
17  APPID_WEB = 0x114, ///< Internet Browser
+
18  APPID_INSTRUCTION_MANUAL = 0x115, ///< Instruction Manual applet
+
19  APPID_NOTIFICATIONS = 0x116, ///< Notifications applet
+
20  APPID_MIIVERSE = 0x117, ///< Miiverse applet (olv)
+
21  APPID_MIIVERSE_POSTING = 0x118, ///< Miiverse posting applet (solv3)
+
22  APPID_AMIIBO_SETTINGS = 0x119, ///< Amiibo settings applet (cabinet)
+
23  APPID_APPLICATION = 0x300, ///< Application
+
24  APPID_ESHOP = 0x301, ///< eShop (tiger)
+
25  APPID_SOFTWARE_KEYBOARD = 0x401, ///< Software Keyboard
+
26  APPID_APPLETED = 0x402, ///< appletEd
+
27  APPID_PNOTE_AP = 0x404, ///< PNOTE_AP
+
28  APPID_SNOTE_AP = 0x405, ///< SNOTE_AP
+
29  APPID_ERROR = 0x406, ///< error
+
30  APPID_MINT = 0x407, ///< mint
+
31  APPID_EXTRAPAD = 0x408, ///< extrapad
+
32  APPID_MEMOLIB = 0x409, ///< memolib
+
33 } NS_APPID;
+
34 
+
35 /// App status values.
+
36 typedef enum {
+
37  APP_NOTINITIALIZED, ///< App not initialized.
+
38  APP_RUNNING, ///< App running.
+
39  APP_SUSPENDED, ///< App suspended.
+
40  APP_EXITING, ///< App exiting.
+
41  APP_SUSPENDING, ///< App suspending.
+
42  APP_SLEEPMODE, ///< App in sleep mode.
+
43  APP_PREPARE_SLEEPMODE, ///< App preparing to enter sleep mode.
+
44  APP_APPLETSTARTED, ///< Applet started.
+
45  APP_APPLETCLOSED ///< Applet closed.
+ +
47 
+
48 /// APT signals.
+
49 typedef enum {
+
50  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
+
51  // 2: sleep-mode related?
+
52  APTSIGNAL_PREPARESLEEP = 3, ///< Prepare to enter sleep mode.
+
53  // 4: triggered when ptm:s GetShellStatus() returns 5.
+
54  APTSIGNAL_ENTERSLEEP = 5, ///< Enter sleep mode.
+
55  APTSIGNAL_WAKEUP = 6, ///< Wake from sleep mode.
+
56  APTSIGNAL_ENABLE = 7, ///< Enable.
+
57  APTSIGNAL_POWERBUTTON = 8, ///< Power button pressed.
+
58  APTSIGNAL_UTILITY = 9, ///< Utility called.
+
59  APTSIGNAL_SLEEPSYSTEM = 10, ///< System sleeping.
+
60  APTSIGNAL_ERROR = 11 ///< Error occurred.
+
61 } APT_Signal;
+
62 
+
63 /// APT hook types.
+
64 typedef enum {
+
65  APTHOOK_ONSUSPEND = 0, ///< App suspended.
+
66  APTHOOK_ONRESTORE, ///< App restored.
+
67  APTHOOK_ONSLEEP, ///< App sleeping.
+
68  APTHOOK_ONWAKEUP, ///< App waking up.
+
69  APTHOOK_ONEXIT, ///< App exiting.
+
70 
+
71  APTHOOK_COUNT, ///< Number of APT hook types.
+
72 } APT_HookType;
+
73 
+
74 /// APT hook function.
+
75 typedef void (*aptHookFn)(APT_HookType hook, void* param);
76 
-
77  APTHOOK_COUNT, ///< Number of APT hook types.
-
78 } APT_HookType;
-
79 
-
80 /// APT hook function.
-
81 typedef void (*aptHookFn)(APT_HookType hook, void* param);
-
82 
-
83 /// APT hook cookie.
-
84 typedef struct tag_aptHookCookie
-
85 {
-
86  struct tag_aptHookCookie* next; ///< Next cookie.
-
87  aptHookFn callback; ///< Hook callback.
-
88  void* param; ///< Callback parameter.
- +
77 /// APT hook cookie.
+
78 typedef struct tag_aptHookCookie
+
79 {
+
80  struct tag_aptHookCookie* next; ///< Next cookie.
+
81  aptHookFn callback; ///< Hook callback.
+
82  void* param; ///< Callback parameter.
+ +
84 
+
85 /// APT events.
+
86 extern Handle aptEvents[3];
+
87 
+
88 /// Initializes APT.
+
89 Result aptInit(void);
90 
-
91 /// APT events.
-
92 extern Handle aptEvents[3];
+
91 /// Exits APT.
+
92 void aptExit(void);
93 
-
94 /// Initializes APT.
-
95 Result aptInit(void);
+
94 /// Opens an APT session.
+
95 void aptOpenSession(void);
96 
-
97 /// Exits APT.
-
98 void aptExit(void);
+
97 /// Closes an APT session.
+
98 void aptCloseSession(void);
99 
-
100 /// Opens an APT session.
-
101 void aptOpenSession(void);
-
102 
-
103 /// Closes an APT session.
-
104 void aptCloseSession(void);
+
100 /**
+
101  * @brief Sets the app's status.
+
102  * @param status Status to set.
+
103  */
+
104 void aptSetStatus(APT_AppStatus status);
105 
106 /**
-
107  * @brief Sets the app's status.
-
108  * @param status Status to set.
+
107  * @brief Gets the app's status.
+
108  * @return The app's status.
109  */
-
110 void aptSetStatus(APT_AppStatus status);
+
111 
112 /**
-
113  * @brief Gets the app's status.
-
114  * @return The app's status.
-
115  */
- -
117 
-
118 /**
-
119  * @brief Gets the app's power status.
-
120  * When the status is APT_SUSPEND, this can be used to check what triggered a return-to-menu.
-
121  * @return The app's power status. (0 = normal, 1 = power button pressed)
+
113  * @brief Gets the app's power status.
+
114  * When the status is APT_SUSPEND, this can be used to check what triggered a return-to-menu.
+
115  * @return The app's power status. (0 = normal, 1 = power button pressed)
+
116  */
+
117 u32 aptGetStatusPower(void);
+
118 
+
119 /**
+
120  * @brief Sets the app's power status.
+
121  * @param status Power status to set.
122  */
-
123 u32 aptGetStatusPower(void);
+
123 void aptSetStatusPower(u32 status);
124 
125 /**
-
126  * @brief Sets the app's power status.
-
127  * @param status Power status to set.
-
128  */
-
129 void aptSetStatusPower(u32 status);
-
130 
-
131 /**
-
132  * @brief Triggers a return to the home menu.
-
133  *
-
134  * This should be called by the user application when aptGetStatus() returns APP_SUSPENDING, not calling this will result in return-to-menu being disabled with the status left at APP_SUSPENDING. This function will not return until the system returns to the application, or when the status was changed to APP_EXITING.
-
135  */
-
136 void aptReturnToMenu(void);
+
126  * @brief Triggers a return to the home menu.
+
127  *
+
128  * This should be called by the user application when aptGetStatus() returns APP_SUSPENDING, not calling this will result in return-to-menu being disabled with the status left at APP_SUSPENDING. This function will not return until the system returns to the application, or when the status was changed to APP_EXITING.
+
129  */
+
130 void aptReturnToMenu(void);
+
131 
+
132 /// Waits for an APT status event.
+
133 void aptWaitStatusEvent(void);
+
134 
+
135 /// Signals that the app is ready to sleep.
+
136 void aptSignalReadyForSleep(void);
137 
-
138 /// Waits for an APT status event.
-
139 void aptWaitStatusEvent(void);
-
140 
-
141 /// Signals that the app is ready to sleep.
-
142 void aptSignalReadyForSleep(void);
+
138 /**
+
139  * @brief Gets the menu's app ID.
+
140  * @return The menu's app ID.
+
141  */
+
143 
144 /**
-
145  * @brief Gets the menu's app ID.
-
146  * @return The menu's app ID.
+
145  * @brief Processes the current APT status. Generally used within a main loop.
+
146  * @return Whether the application is closing.
147  */
- +
148 bool aptMainLoop(void);
149 
150 /**
-
151  * @brief Processes the current APT status. Generally used within a main loop.
-
152  * @return Whether the application is closing.
-
153  */
-
154 bool aptMainLoop(void);
-
155 
-
156 /**
-
157  * @brief Sets up an APT status hook.
-
158  * @param cookie Hook cookie to use.
-
159  * @param callback Function to call when APT's status changes.
-
160  * @param param User-defined parameter to pass to the callback.
+
151  * @brief Sets up an APT status hook.
+
152  * @param cookie Hook cookie to use.
+
153  * @param callback Function to call when APT's status changes.
+
154  * @param param User-defined parameter to pass to the callback.
+
155  */
+
156 void aptHook(aptHookCookie* cookie, aptHookFn callback, void* param);
+
157 
+
158 /**
+
159  * @brief Removes an APT status hook.
+
160  * @param cookie Hook cookie to remove.
161  */
-
162 void aptHook(aptHookCookie* cookie, aptHookFn callback, void* param);
+
162 void aptUnhook(aptHookCookie* cookie);
163 
164 /**
-
165  * @brief Removes an APT status hook.
-
166  * @param cookie Hook cookie to remove.
-
167  */
-
168 void aptUnhook(aptHookCookie* cookie);
-
169 
-
170 /**
-
171  * @brief Gets an APT lock handle.
-
172  * @param flags Flags to use.
-
173  * @param lockHandle Pointer to output the lock handle to.
-
174  */
-
175 Result APT_GetLockHandle(u16 flags, Handle* lockHandle);
-
176 
-
177 /**
-
178  * @brief Initializes an application's registration with APT.
-
179  * @param appId ID of the application.
-
180  * @param eventHandle1 Pointer to output the signal event handle to.
-
181  * @param eventHandle2 Pointer to output the launch and exit event handle to.
+
165  * @brief Gets an APT lock handle.
+
166  * @param flags Flags to use.
+
167  * @param lockHandle Pointer to output the lock handle to.
+
168  */
+
169 Result APT_GetLockHandle(u16 flags, Handle* lockHandle);
+
170 
+
171 /**
+
172  * @brief Initializes an application's registration with APT.
+
173  * @param appId ID of the application.
+
174  * @param eventHandle1 Pointer to output the signal event handle to.
+
175  * @param eventHandle2 Pointer to output the launch and exit event handle to.
+
176  */
+
177 Result APT_Initialize(NS_APPID appId, Handle* eventHandle1, Handle* eventHandle2);
+
178 
+
179 /**
+
180  * @brief Terminates an application's registration with APT.
+
181  * @param appID ID of the application.
182  */
-
183 Result APT_Initialize(NS_APPID appId, Handle* eventHandle1, Handle* eventHandle2);
+
184 
-
185 /**
-
186  * @brief Terminates an application's registration with APT.
-
187  * @param appID ID of the application.
-
188  */
- -
190 
-
191 /// Asynchronously resets the hardware.
- +
185 /// Asynchronously resets the hardware.
+ +
187 
+
188 /**
+
189  * @brief Enables APT.
+
190  * @param a Parameter to enable with.
+
191  */
+
193 
194 /**
-
195  * @brief Enables APT.
-
196  * @param a Parameter to enable with.
-
197  */
- -
199 
-
200 /**
-
201  * @brief Gets applet management info.
-
202  * @param inval Requested applet type.
-
203  * @param outval8 Pointer to output the current applet type to.
-
204  * @param outval32 Pointer to output the requested app ID to.
-
205  * @param menu_appid Pointer to output the home menu app ID to.
-
206  * @param active_appid Pointer to output the currently active app ID to.
-
207  * @param pAttributes Pointer to output the atrributes to.
-
208  */
-
209 Result APT_GetAppletManInfo(u8 inval, u8 *outval8, u32 *outval32, NS_APPID *menu_appid, NS_APPID *active_appid);
-
210 
-
211 /**
-
212  * @brief Gets an applet's information.
-
213  * @param appID ID of the applet.
-
214  * @param pProgramID Pointer to output the program ID to.
-
215  * @param pMediaType Pointer to output the media type to.
-
216  * @param pRegistered Pointer to output the registration status to.
-
217  * @param pLoadState Pointer to output the load state to.
-
218  * @param pAttributes Pointer to output the atrributes to.
-
219  */
-
220 Result APT_GetAppletInfo(NS_APPID appID, u64* pProgramID, u8* pMediaType, u8* pRegistered, u8* pLoadState, u32* pAttributes);
-
221 
-
222 /**
-
223  * @brief Gets an applet's program information.
-
224  * @param id ID of the applet.
-
225  * @param flags Flags to use when retreiving the information.
-
226  * @param titleversion Pointer to output the applet's title version to.
-
227  *
-
228  * Flags:
-
229  * - 0x01: Use AM_ListTitles with NAND media type.
-
230  * - 0x02: Use AM_ListTitles with SDMC media type.
-
231  * - 0x04: Use AM_ListTitles with GAMECARD media type.
-
232  * - 0x10: Input ID is an app ID. Must be set if 0x20 is not.
-
233  * - 0x20: Input ID is a program ID. Must be set if 0x10 is not.
-
234  * - 0x100: Sets program ID high to 0x00040000, else it is 0x00040010. Only used when 0x20 is set.
+
195  * @brief Gets applet management info.
+
196  * @param inval Requested applet type.
+
197  * @param outval8 Pointer to output the current applet type to.
+
198  * @param outval32 Pointer to output the requested app ID to.
+
199  * @param menu_appid Pointer to output the home menu app ID to.
+
200  * @param active_appid Pointer to output the currently active app ID to.
+
201  * @param pAttributes Pointer to output the atrributes to.
+
202  */
+
203 Result APT_GetAppletManInfo(u8 inval, u8 *outval8, u32 *outval32, NS_APPID *menu_appid, NS_APPID *active_appid);
+
204 
+
205 /**
+
206  * @brief Gets an applet's information.
+
207  * @param appID ID of the applet.
+
208  * @param pProgramID Pointer to output the program ID to.
+
209  * @param pMediaType Pointer to output the media type to.
+
210  * @param pRegistered Pointer to output the registration status to.
+
211  * @param pLoadState Pointer to output the load state to.
+
212  * @param pAttributes Pointer to output the atrributes to.
+
213  */
+
214 Result APT_GetAppletInfo(NS_APPID appID, u64* pProgramID, u8* pMediaType, u8* pRegistered, u8* pLoadState, u32* pAttributes);
+
215 
+
216 /**
+
217  * @brief Gets an applet's program information.
+
218  * @param id ID of the applet.
+
219  * @param flags Flags to use when retreiving the information.
+
220  * @param titleversion Pointer to output the applet's title version to.
+
221  *
+
222  * Flags:
+
223  * - 0x01: Use AM_ListTitles with NAND media type.
+
224  * - 0x02: Use AM_ListTitles with SDMC media type.
+
225  * - 0x04: Use AM_ListTitles with GAMECARD media type.
+
226  * - 0x10: Input ID is an app ID. Must be set if 0x20 is not.
+
227  * - 0x20: Input ID is a program ID. Must be set if 0x10 is not.
+
228  * - 0x100: Sets program ID high to 0x00040000, else it is 0x00040010. Only used when 0x20 is set.
+
229  */
+
230 Result APT_GetAppletProgramInfo(u32 id, u32 flags, u16 *titleversion);
+
231 
+
232 /**
+
233  * @brief Gets the current application's program ID.
+
234  * @param pProgramID Pointer to output the program ID to.
235  */
-
236 Result APT_GetAppletProgramInfo(u32 id, u32 flags, u16 *titleversion);
+
236 Result APT_GetProgramID(u64* pProgramID);
237 
-
238 /**
-
239  * @brief Gets the current application's program ID.
-
240  * @param pProgramID Pointer to output the program ID to.
-
241  */
-
242 Result APT_GetProgramID(u64* pProgramID);
-
243 
-
244 /// Prepares to jump to the home menu.
- -
246 
-
247 /**
-
248  * @brief Jumps to the home menu.
-
249  * @param param Parameters to jump with.
-
250  * @param Size of the parameter buffer.
-
251  * @param handle Handle to pass.
+
238 /// Prepares to jump to the home menu.
+ +
240 
+
241 /**
+
242  * @brief Jumps to the home menu.
+
243  * @param param Parameters to jump with.
+
244  * @param Size of the parameter buffer.
+
245  * @param handle Handle to pass.
+
246  */
+
247 Result APT_JumpToHomeMenu(const u8 *param, size_t paramSize, Handle handle);
+
248 
+
249 /**
+
250  * @brief Prepares to jump to an application.
+
251  * @param a Application to jump to.
252  */
-
253 Result APT_JumpToHomeMenu(const u8 *param, size_t paramSize, Handle handle);
+
254 
255 /**
-
256  * @brief Prepares to jump to an application.
-
257  * @param a Application to jump to.
-
258  */
- -
260 
-
261 /**
-
262  * @brief Jumps to an application.
-
263  * @param param Parameters to jump with.
-
264  * @param Size of the parameter buffer.
-
265  * @param handle Handle to pass.
-
266  */
-
267 Result APT_JumpToApplication(const u8 *param, size_t paramSize, Handle handle);
-
268 
-
269 /**
-
270  * @brief Gets whether an application is registered.
-
271  * @param appID ID of the application.
-
272  * @param out Pointer to output the registration state to.
-
273  */
-
274 Result APT_IsRegistered(NS_APPID appID, u8* out);
-
275 
-
276 /**
-
277  * @brief Inquires as to whether a signal has been received.
-
278  * @param appID ID of the application.
-
279  * @param signalType Pointer to output the signal type to.
+
256  * @brief Jumps to an application.
+
257  * @param param Parameters to jump with.
+
258  * @param Size of the parameter buffer.
+
259  * @param handle Handle to pass.
+
260  */
+
261 Result APT_JumpToApplication(const u8 *param, size_t paramSize, Handle handle);
+
262 
+
263 /**
+
264  * @brief Gets whether an application is registered.
+
265  * @param appID ID of the application.
+
266  * @param out Pointer to output the registration state to.
+
267  */
+
268 Result APT_IsRegistered(NS_APPID appID, u8* out);
+
269 
+
270 /**
+
271  * @brief Inquires as to whether a signal has been received.
+
272  * @param appID ID of the application.
+
273  * @param signalType Pointer to output the signal type to.
+
274  */
+
275 Result APT_InquireNotification(u32 appID, APT_Signal* signalType);
+
276 
+
277 /**
+
278  * @brief Notifies an application to wait.
+
279  * @param appID ID of the application.
280  */
-
281 Result APT_InquireNotification(u32 appID, APT_Signal* signalType);
+
282 
283 /**
-
284  * @brief Notifies an application to wait.
-
285  * @param appID ID of the application.
-
286  */
- -
288 
-
289 /**
-
290  * @brief Calls an applet utility function.
-
291  * @param out Pointer to write output data to.
-
292  * @param a Utility function to call.
-
293  * @param size1 Size of the first buffer.
-
294  * @param buf1 First buffer.
-
295  * @param size2 Size of the second buffer.
-
296  * @param buf2 Second buffer.
-
297  */
-
298 Result APT_AppletUtility(u32* out, u32 a, u32 size1, u8* buf1, u32 size2, u8* buf2);
-
299 
-
300 /**
-
301  * @brief Glances at a receieved parameter without removing it from the queue.
-
302  * @param appID ID of the application.
-
303  * @param bufferSize Size of the buffer.
-
304  * @param buffer Buffer to receive to.
-
305  * @param actualSize Pointer to output the actual received data size to.
-
306  * @param signalType Pointer to output the signal type to.
-
307  */
-
308 Result APT_GlanceParameter(NS_APPID appID, u32 bufferSize, u32* buffer, u32* actualSize, u8* signalType);
-
309 
-
310 /**
-
311  * @brief Receives a parameter.
-
312  * @param appID ID of the application.
-
313  * @param bufferSize Size of the buffer.
-
314  * @param buffer Buffer to receive to.
-
315  * @param actualSize Pointer to output the actual received data size to.
-
316  * @param signalType Pointer to output the signal type to.
-
317  */
-
318 Result APT_ReceiveParameter(NS_APPID appID, u32 bufferSize, u32* buffer, u32* actualSize, u8* signalType);
-
319 
-
320 /**
-
321  * @brief Sends a parameter.
-
322  * @param src_appID ID of the source application.
-
323  * @param dst_appID ID of the destination application.
-
324  * @param bufferSize Size of the buffer.
-
325  * @param buffer Buffer to send.
-
326  * @param paramhandle Handle to pass.
-
327  * @param signalType Signal type to send.
-
328  */
-
329 Result APT_SendParameter(NS_APPID src_appID, NS_APPID dst_appID, u32 bufferSize, u32* buffer, Handle paramhandle, u8 signalType);
-
330 
-
331 /**
-
332  * @brief Sends capture buffer information.
-
333  * @param bufferSize Size of the buffer to send.
-
334  * @param buffer Buffer to send.
-
335  */
-
336 Result APT_SendCaptureBufferInfo(u32 bufferSize, u32* buffer);
-
337 
-
338 /**
-
339  * @brief Replies to a sleep query.
-
340  * @param appID ID of the application.
-
341  * @param a Parameter to reply with.
+
284  * @brief Calls an applet utility function.
+
285  * @param out Pointer to write output data to.
+
286  * @param a Utility function to call.
+
287  * @param size1 Size of the first buffer.
+
288  * @param buf1 First buffer.
+
289  * @param size2 Size of the second buffer.
+
290  * @param buf2 Second buffer.
+
291  */
+
292 Result APT_AppletUtility(u32* out, u32 a, u32 size1, u8* buf1, u32 size2, u8* buf2);
+
293 
+
294 /**
+
295  * @brief Glances at a receieved parameter without removing it from the queue.
+
296  * @param appID ID of the application.
+
297  * @param bufferSize Size of the buffer.
+
298  * @param buffer Buffer to receive to.
+
299  * @param actualSize Pointer to output the actual received data size to.
+
300  * @param signalType Pointer to output the signal type to.
+
301  */
+
302 Result APT_GlanceParameter(NS_APPID appID, u32 bufferSize, u32* buffer, u32* actualSize, u8* signalType);
+
303 
+
304 /**
+
305  * @brief Receives a parameter.
+
306  * @param appID ID of the application.
+
307  * @param bufferSize Size of the buffer.
+
308  * @param buffer Buffer to receive to.
+
309  * @param actualSize Pointer to output the actual received data size to.
+
310  * @param signalType Pointer to output the signal type to.
+
311  */
+
312 Result APT_ReceiveParameter(NS_APPID appID, u32 bufferSize, u32* buffer, u32* actualSize, u8* signalType);
+
313 
+
314 /**
+
315  * @brief Sends a parameter.
+
316  * @param src_appID ID of the source application.
+
317  * @param dst_appID ID of the destination application.
+
318  * @param bufferSize Size of the buffer.
+
319  * @param buffer Buffer to send.
+
320  * @param paramhandle Handle to pass.
+
321  * @param signalType Signal type to send.
+
322  */
+
323 Result APT_SendParameter(NS_APPID src_appID, NS_APPID dst_appID, u32 bufferSize, u32* buffer, Handle paramhandle, u8 signalType);
+
324 
+
325 /**
+
326  * @brief Sends capture buffer information.
+
327  * @param bufferSize Size of the buffer to send.
+
328  * @param buffer Buffer to send.
+
329  */
+
330 Result APT_SendCaptureBufferInfo(u32 bufferSize, u32* buffer);
+
331 
+
332 /**
+
333  * @brief Replies to a sleep query.
+
334  * @param appID ID of the application.
+
335  * @param a Parameter to reply with.
+
336  */
+ +
338 
+
339 /**
+
340  * @brief Replies that a sleep notification has been completed.
+
341  * @param appID ID of the application.
342  */
- +
344 
345 /**
-
346  * @brief Replies that a sleep notification has been completed.
-
347  * @param appID ID of the application.
+
346  * @brief Prepares to close the application.
+
347  * @param a Whether the jump is to the home menu.
348  */
- +
350 
351 /**
-
352  * @brief Prepares to close the application.
-
353  * @param a Whether the jump is to the home menu.
-
354  */
- -
356 
-
357 /**
-
358  * @brief Closes the application.
-
359  * @param param Parameters to close with.
-
360  * @param paramSize Size of param.
-
361  * @param handle Handle to pass.
+
352  * @brief Closes the application.
+
353  * @param param Parameters to close with.
+
354  * @param paramSize Size of param.
+
355  * @param handle Handle to pass.
+
356  */
+
357 Result APT_CloseApplication(const u8 *param, size_t paramSize, Handle handle);
+
358 
+
359 /**
+
360  * @brief Sets the application's CPU time limit.
+
361  * @param percent CPU time limit percentage to set.
362  */
-
363 Result APT_CloseApplication(const u8 *param, size_t paramSize, Handle handle);
+
364 
365 /**
-
366  * @brief Sets the application's CPU time limit.
-
367  * @param percent CPU time limit percentage to set.
+
366  * @brief Gets the application's CPU time limit.
+
367  * @param percent Pointer to output the CPU time limit percentage to.
368  */
- +
370 
371 /**
-
372  * @brief Gets the application's CPU time limit.
-
373  * @param percent Pointer to output the CPU time limit percentage to.
-
374  */
- -
376 
-
377 /**
-
378  * @brief Checks whether the system is a New 3DS.
-
379  * Note: this function is unreliable, see: http://3dbrew.org/wiki/APT:PrepareToStartApplication
+
372  * @brief Checks whether the system is a New 3DS.
+
373  * Note: this function is unreliable, see: http://3dbrew.org/wiki/APT:PrepareToStartApplication
+
374  * @param out Pointer to write the New 3DS flag to.
+
375  */
+ +
377 
+
378 /**
+
379  * @brief Checks whether the system is a New 3DS.
380  * @param out Pointer to write the New 3DS flag to.
381  */
- +
383 
384 /**
385  * @brief Checks whether the system is a New 3DS.
386  * @param out Pointer to write the New 3DS flag to.
387  */
- +
389 
390 /**
-
391  * @brief Checks whether the system is a New 3DS.
-
392  * @param out Pointer to write the New 3DS flag to.
-
393  */
- -
395 
-
396 /**
-
397  * @brief Prepares for an applicaton jump.
-
398  * @param flags Flags to use.
-
399  * @param programID ID of the program to jump to.
-
400  * @param mediatype Media type of the program to jump to.
-
401  */
-
402 Result APT_PrepareToDoAppJump(u8 flags, u64 programID, u8 mediatype);
-
403 
-
404 /**
-
405  * @brief Performs an application jump.
-
406  * @param NSbuf0Size Size of NSbuf0Ptr.
-
407  * @param NSbuf1Size Size of NSbuf1Ptr.
-
408  * @param NSbuf0Ptr Launch buffer 0.
-
409  * @param NSbuf1Ptr Launch buffer 1.
+
391  * @brief Prepares for an applicaton jump.
+
392  * @param flags Flags to use.
+
393  * @param programID ID of the program to jump to.
+
394  * @param mediatype Media type of the program to jump to.
+
395  */
+
396 Result APT_PrepareToDoAppJump(u8 flags, u64 programID, u8 mediatype);
+
397 
+
398 /**
+
399  * @brief Performs an application jump.
+
400  * @param NSbuf0Size Size of NSbuf0Ptr.
+
401  * @param NSbuf1Size Size of NSbuf1Ptr.
+
402  * @param NSbuf0Ptr Launch buffer 0.
+
403  * @param NSbuf1Ptr Launch buffer 1.
+
404  */
+
405 Result APT_DoAppJump(u32 NSbuf0Size, u32 NSbuf1Size, u8 *NSbuf0Ptr, u8 *NSbuf1Ptr);
+
406 
+
407 /**
+
408  * @brief Prepares to start a library applet.
+
409  * @param appID ID of the applet to start.
410  */
-
411 Result APT_DoAppJump(u32 NSbuf0Size, u32 NSbuf1Size, u8 *NSbuf0Ptr, u8 *NSbuf1Ptr);
+
412 
413 /**
-
414  * @brief Prepares to start a library applet.
-
415  * @param appID ID of the applet to start.
-
416  */
- -
418 
-
419 /**
-
420  * @brief Starts a library applet.
-
421  * @param appID ID of the applet to launch.
-
422  * @param inhandle Handle to pass to the applet.
-
423  * @param parambuf Buffer containing applet parameters.
-
424  * @param parambufsize Size of parambuf.
-
425  */
-
426 Result APT_StartLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize);
-
427 
-
428 /**
-
429  * @brief Launches a library applet.
-
430  * Note: This is not usable from the homebrew launcher. This is broken: when the applet does get launched at all, the applet process doesn't actually get terminated when the applet gets closed.
-
431  * @param appID ID of the applet to launch.
-
432  * @param inhandle Handle to pass to the applet.
-
433  * @param parambuf Buffer containing applet parameters.
-
434  * @param parambufsize Size of parambuf.
+
414  * @brief Starts a library applet.
+
415  * @param appID ID of the applet to launch.
+
416  * @param inhandle Handle to pass to the applet.
+
417  * @param parambuf Buffer containing applet parameters.
+
418  * @param parambufsize Size of parambuf.
+
419  */
+
420 Result APT_StartLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize);
+
421 
+
422 /**
+
423  * @brief Launches a library applet.
+
424  * Note: This is not usable from the homebrew launcher. This is broken: when the applet does get launched at all, the applet process doesn't actually get terminated when the applet gets closed.
+
425  * @param appID ID of the applet to launch.
+
426  * @param inhandle Handle to pass to the applet.
+
427  * @param parambuf Buffer containing applet parameters.
+
428  * @param parambufsize Size of parambuf.
+
429  */
+
430 Result APT_LaunchLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize);
+
431 
+
432 /**
+
433  * @brief Prepares to start a system applet.
+
434  * @param appID ID of the applet to start.
435  */
-
436 Result APT_LaunchLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize);
+
437 
438 /**
-
439  * @brief Prepares to start a system applet.
-
440  * @param appID ID of the applet to start.
-
441  */
- -
443 
-
444 /**
-
445  * @brief Starts a system applet.
-
446  * @param appID ID of the applet to launch.
-
447  * @param bufSize Size of the parameter buffer.
-
448  * @param applHandle Handle to pass to the applet.
-
449  * @param buf Buffer containing applet parameters.
-
450  */
-
451 Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf);
-
452 
-
Application.
Definition: apt.h:29
-
Amiibo settings applet (cabinet)
Definition: apt.h:28
-
aptHookFn callback
Hook callback.
Definition: apt.h:87
-
Enable.
Definition: apt.h:62
-
APT_AppStatus
App status values.
Definition: apt.h:42
+
439  * @brief Starts a system applet.
+
440  * @param appID ID of the applet to launch.
+
441  * @param bufSize Size of the parameter buffer.
+
442  * @param applHandle Handle to pass to the applet.
+
443  * @param buf Buffer containing applet parameters.
+
444  */
+
445 Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf);
+
446 
+
Application.
Definition: apt.h:23
+
Amiibo settings applet (cabinet)
Definition: apt.h:22
+
aptHookFn callback
Hook callback.
Definition: apt.h:81
+
Enable.
Definition: apt.h:56
+
APT_AppStatus
App status values.
Definition: apt.h:36
Result APT_IsRegistered(NS_APPID appID, u8 *out)
Gets whether an application is registered.
Result APT_ReplySleepQuery(NS_APPID appID, u32 a)
Replies to a sleep query.
s32 Result
Function result.
Definition: types.h:35
Result APT_DoAppJump(u32 NSbuf0Size, u32 NSbuf1Size, u8 *NSbuf0Ptr, u8 *NSbuf1Ptr)
Performs an application jump.
void aptOpenSession(void)
Opens an APT session.
-
Enter sleep mode.
Definition: apt.h:60
-
APT hook cookie.
Definition: apt.h:84
-
System sleeping.
Definition: apt.h:65
+
Enter sleep mode.
Definition: apt.h:54
+
APT hook cookie.
Definition: apt.h:78
+
System sleeping.
Definition: apt.h:59
void aptSignalReadyForSleep(void)
Signals that the app is ready to sleep.
Result APT_Enable(u32 a)
Enables APT.
bool aptMainLoop(void)
Processes the current APT status.
-
SNOTE_AP.
Definition: apt.h:34
+
SNOTE_AP.
Definition: apt.h:28
uint16_t u16
16-bit unsigned integer
Definition: types.h:15
-
App restored.
Definition: apt.h:72
-
void(* aptHookFn)(APT_HookType hook, void *param)
APT hook function.
Definition: apt.h:81
-
extrapad
Definition: apt.h:37
-
App exiting.
Definition: apt.h:75
+
App restored.
Definition: apt.h:66
+
void(* aptHookFn)(APT_HookType hook, void *param)
APT hook function.
Definition: apt.h:75
+
extrapad
Definition: apt.h:31
+
App exiting.
Definition: apt.h:69
Result aptInit(void)
Initializes APT.
void aptHook(aptHookCookie *cookie, aptHookFn callback, void *param)
Sets up an APT status hook.
-
Friends List applet.
Definition: apt.h:21
+
Friends List applet.
Definition: apt.h:15
Result APT_CloseApplication(const u8 *param, size_t paramSize, Handle handle)
Closes the application.
Result APT_ReplySleepNotificationComplete(NS_APPID appID)
Replies that a sleep notification has been completed.
-
struct tag_aptHookCookie * next
Next cookie.
Definition: apt.h:86
-
Instruction Manual applet.
Definition: apt.h:24
+
struct tag_aptHookCookie * next
Next cookie.
Definition: apt.h:80
+
Instruction Manual applet.
Definition: apt.h:18
APT_AppStatus aptGetStatus(void)
Gets the app's status.
u32 Handle
Resource handle.
Definition: types.h:34
Result APT_PrepareToCloseApplication(u8 a)
Prepares to close the application.
u32 aptGetStatusPower(void)
Gets the app's power status.
-
Prepare to enter sleep mode.
Definition: apt.h:58
+
Prepare to enter sleep mode.
Definition: apt.h:52
NS_APPID aptGetMenuAppID(void)
Gets the menu's app ID.
-
App waking up.
Definition: apt.h:74
-
App running.
Definition: apt.h:44
-
Notifications applet.
Definition: apt.h:25
+
App waking up.
Definition: apt.h:68
+
App running.
Definition: apt.h:38
+
Notifications applet.
Definition: apt.h:19
Result APT_JumpToHomeMenu(const u8 *param, size_t paramSize, Handle handle)
Jumps to the home menu.
uint8_t u8
8-bit unsigned integer
Definition: types.h:14
-
Power button pressed.
Definition: apt.h:63
-
Miiverse posting applet (solv3)
Definition: apt.h:27
+
Power button pressed.
Definition: apt.h:57
+
Miiverse posting applet (solv3)
Definition: apt.h:21
Result APT_ReceiveParameter(NS_APPID appID, u32 bufferSize, u32 *buffer, u32 *actualSize, u8 *signalType)
Receives a parameter.
-
Home button pressed.
Definition: apt.h:56
+
Home button pressed.
Definition: apt.h:50
uint64_t u64
64-bit unsigned integer
Definition: types.h:17
Result APT_CheckNew3DS_System(u8 *out)
Checks whether the system is a New 3DS.
Result APT_SetAppCpuTimeLimit(u32 percent)
Sets the application's CPU time limit.
-
mint
Definition: apt.h:36
-
App not initialized.
Definition: apt.h:43
+
mint
Definition: apt.h:30
+
App not initialized.
Definition: apt.h:37
Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf)
Starts a system applet.
-
Miiverse applet (olv)
Definition: apt.h:26
+
Miiverse applet (olv)
Definition: apt.h:20
uint32_t u32
32-bit unsigned integer
Definition: types.h:16
Handle aptEvents[3]
APT events.
Result APT_PrepareToStartLibraryApplet(NS_APPID appID)
Prepares to start a library applet.
void aptSetStatusPower(u32 status)
Sets the app's power status.
Result APT_GetLockHandle(u16 flags, Handle *lockHandle)
Gets an APT lock handle.
-
Camera applet.
Definition: apt.h:20
+
Camera applet.
Definition: apt.h:14
void aptSetStatus(APT_AppStatus status)
Sets the app's status.
void aptCloseSession(void)
Closes an APT session.
-
App exiting.
Definition: apt.h:46
+
App exiting.
Definition: apt.h:40
Result APT_GetAppletManInfo(u8 inval, u8 *outval8, u32 *outval32, NS_APPID *menu_appid, NS_APPID *active_appid)
Gets applet management info.
Result APT_PrepareToStartSystemApplet(NS_APPID appID)
Prepares to start a system applet.
void aptExit(void)
Exits APT.
Result APT_PrepareToDoAppJump(u8 flags, u64 programID, u8 mediatype)
Prepares for an applicaton jump.
-
Home Menu.
Definition: apt.h:19
-
App suspended.
Definition: apt.h:71
+
Home Menu.
Definition: apt.h:13
+
App suspended.
Definition: apt.h:65
Result APT_SendCaptureBufferInfo(u32 bufferSize, u32 *buffer)
Sends capture buffer information.
Result APT_CheckNew3DS_Application(u8 *out)
Checks whether the system is a New 3DS.
-
App preparing to enter sleep mode.
Definition: apt.h:49
+
App preparing to enter sleep mode.
Definition: apt.h:43
Result APT_PrepareToJumpToApplication(u32 a)
Prepares to jump to an application.
-
Error occurred.
Definition: apt.h:66
+
Error occurred.
Definition: apt.h:60
void aptWaitStatusEvent(void)
Waits for an APT status event.
Result APT_SendParameter(NS_APPID src_appID, NS_APPID dst_appID, u32 bufferSize, u32 *buffer, Handle paramhandle, u8 signalType)
Sends a parameter.
Result APT_InquireNotification(u32 appID, APT_Signal *signalType)
Inquires as to whether a signal has been received.
-
error
Definition: apt.h:35
-
Applet started.
Definition: apt.h:50
+
error
Definition: apt.h:29
+
Applet started.
Definition: apt.h:44
Result APT_GetAppCpuTimeLimit(u32 *percent)
Gets the application's CPU time limit.
-
void * param
Callback parameter.
Definition: apt.h:88
-
Game Notes applet.
Definition: apt.h:22
+
void * param
Callback parameter.
Definition: apt.h:82
+
Game Notes applet.
Definition: apt.h:16
void aptUnhook(aptHookCookie *cookie)
Removes an APT status hook.
Result APT_JumpToApplication(const u8 *param, size_t paramSize, Handle handle)
Jumps to an application.
-
Number of APT hook types.
Definition: apt.h:77
-
NS_APPID
NS Application IDs.
Definition: apt.h:18
+
Number of APT hook types.
Definition: apt.h:71
+
NS_APPID
NS Application IDs.
Definition: apt.h:12
Result APT_AppletUtility(u32 *out, u32 a, u32 size1, u8 *buf1, u32 size2, u8 *buf2)
Calls an applet utility function.
-
Utility called.
Definition: apt.h:64
-
Wake from sleep mode.
Definition: apt.h:61
-
memolib
Definition: apt.h:38
+
Utility called.
Definition: apt.h:58
+
Wake from sleep mode.
Definition: apt.h:55
+
memolib
Definition: apt.h:32
Result APT_HardwareResetAsync(void)
Asynchronously resets the hardware.
-
Applet closed.
Definition: apt.h:51
-
Internet Browser.
Definition: apt.h:23
+
Applet closed.
Definition: apt.h:45
+
Internet Browser.
Definition: apt.h:17
Result APT_Initialize(NS_APPID appId, Handle *eventHandle1, Handle *eventHandle2)
Initializes an application's registration with APT.
-
APT_Signal
APT signals.
Definition: apt.h:55
-
Software Keyboard.
Definition: apt.h:31
-
APT_HookType
APT hook types.
Definition: apt.h:70
+
APT_Signal
APT signals.
Definition: apt.h:49
+
Software Keyboard.
Definition: apt.h:25
+
APT_HookType
APT hook types.
Definition: apt.h:64
Result APT_Finalize(NS_APPID appId)
Terminates an application's registration with APT.
-
appletEd
Definition: apt.h:32
+
appletEd
Definition: apt.h:26
Result APT_LaunchLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize)
Launches a library applet.
-
App suspended.
Definition: apt.h:45
-
PNOTE_AP.
Definition: apt.h:33
+
App suspended.
Definition: apt.h:39
+
PNOTE_AP.
Definition: apt.h:27
Result APT_GetAppletProgramInfo(u32 id, u32 flags, u16 *titleversion)
Gets an applet's program information.
Result APT_CheckNew3DS(u8 *out)
Checks whether the system is a New 3DS.
-
App in sleep mode.
Definition: apt.h:48
+
App in sleep mode.
Definition: apt.h:42
Result APT_NotifyToWait(NS_APPID appID)
Notifies an application to wait.
Result APT_GetProgramID(u64 *pProgramID)
Gets the current application's program ID.
-
eShop (tiger)
Definition: apt.h:30
+
eShop (tiger)
Definition: apt.h:24
Result APT_StartLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize)
Starts a library applet.
Result APT_GlanceParameter(NS_APPID appID, u32 bufferSize, u32 *buffer, u32 *actualSize, u8 *signalType)
Glances at a receieved parameter without removing it from the queue.
Result APT_PrepareToJumpToHomeMenu(void)
Prepares to jump to the home menu.
Result APT_GetAppletInfo(NS_APPID appID, u64 *pProgramID, u8 *pMediaType, u8 *pRegistered, u8 *pLoadState, u32 *pAttributes)
Gets an applet's information.
-
App sleeping.
Definition: apt.h:73
+
App sleeping.
Definition: apt.h:67
void aptReturnToMenu(void)
Triggers a return to the home menu.
-
App suspending.
Definition: apt.h:47
+
App suspending.
Definition: apt.h:41
- - + } + - - + } +

Detailed Description

CAM service for using the 3DS's front and back cameras.

Enumeration Type Documentation

- +

Enumerations

enum  {
-  PORT_NONE = 0x0, +
enum  {
+  PORT_NONE = 0x0,
-  PORT_CAM1 = BIT(0), +  PORT_CAM1 = BIT(0),
-  PORT_CAM2 = BIT(1), +  PORT_CAM2 = BIT(1),
-  PORT_BOTH = PORT_CAM1 | PORT_CAM2 +  PORT_BOTH = PORT_CAM1 | PORT_CAM2
- }
 Camera connection target ports. More...
 
 Camera connection target ports. More...
 
enum  {
-  SELECT_NONE = 0x0, +
enum  {
+  SELECT_NONE = 0x0,
-  SELECT_OUT1 = BIT(0), +  SELECT_OUT1 = BIT(0),
-  SELECT_IN1 = BIT(1), +  SELECT_IN1 = BIT(1),
-  SELECT_OUT2 = BIT(2), +  SELECT_OUT2 = BIT(2),
-  SELECT_IN1_OUT1 = SELECT_OUT1 | SELECT_IN1, +  SELECT_IN1_OUT1 = SELECT_OUT1 | SELECT_IN1,
-  SELECT_OUT1_OUT2 = SELECT_OUT1 | SELECT_OUT2, +  SELECT_OUT1_OUT2 = SELECT_OUT1 | SELECT_OUT2,
-  SELECT_IN1_OUT2 = SELECT_IN1 | SELECT_OUT2, +  SELECT_IN1_OUT2 = SELECT_IN1 | SELECT_OUT2,
-  SELECT_ALL = SELECT_OUT1 | SELECT_IN1 | SELECT_OUT2 +  SELECT_ALL = SELECT_OUT1 | SELECT_IN1 | SELECT_OUT2
- }
 Camera combinations. More...
 
 Camera combinations. More...
 
enum  CAMU_Context {
  CONTEXT_NONE = 0x0, @@ -554,7 +554,7 @@ Functions
@@ -564,19 +564,31 @@ Functions
-

Camera connection target ports.

+

Camera combinations.

- - - - + + + +
Enumerator
PORT_NONE  -

No port.

+
Enumerator
SELECT_NONE  +

No camera.

PORT_CAM1  -

CAM1 port.

+
SELECT_OUT1  +

Outer camera 1.

PORT_CAM2  -

CAM2 port.

+
SELECT_IN1  +

Inner camera 1.

PORT_BOTH  -

Both ports.

+
SELECT_OUT2  +

Outer camera 2.

+
SELECT_IN1_OUT1  +

Outer camera 1 and inner camera 1.

+
SELECT_OUT1_OUT2  +

Both outer cameras.

+
SELECT_IN1_OUT2  +

Inner camera 1 and outer camera 2.

+
SELECT_ALL  +

All cameras.

@@ -592,31 +604,19 @@ Functions
-

Camera combinations.

+

Camera connection target ports.

- - - - - - - -
Enumerator
SELECT_NONE  -

No camera.

-
SELECT_OUT1  -

Outer camera 1.

-
SELECT_IN1  -

Inner camera 1.

-
SELECT_OUT2  -

Outer camera 2.

-
SELECT_IN1_OUT1  -

Outer camera 1 and inner camera 1.

+
Enumerator
PORT_NONE  +

No port.

SELECT_OUT1_OUT2  -

Both outer cameras.

+
PORT_CAM1  +

CAM1 port.

SELECT_IN1_OUT2  -

Inner camera 1 and outer camera 2.

+
PORT_CAM2  +

CAM2 port.

SELECT_ALL  -

All cameras.

+
PORT_BOTH  +

Both ports.

diff --git a/cam_8h_source.html b/cam_8h_source.html index 8708bb0..d7a79d1 100644 --- a/cam_8h_source.html +++ b/cam_8h_source.html @@ -101,26 +101,26 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
9 
10 /// Camera connection target ports.
11 enum {
-
12  PORT_NONE = 0x0, ///< No port.
-
13  PORT_CAM1 = BIT(0), ///< CAM1 port.
-
14  PORT_CAM2 = BIT(1), ///< CAM2 port.
+
12  PORT_NONE = 0x0, ///< No port.
+
13  PORT_CAM1 = BIT(0), ///< CAM1 port.
+
14  PORT_CAM2 = BIT(1), ///< CAM2 port.
15 
16  // Port combinations.
-
17  PORT_BOTH = PORT_CAM1 | PORT_CAM2, ///< Both ports.
+
17  PORT_BOTH = PORT_CAM1 | PORT_CAM2, ///< Both ports.
18 };
19 
20 /// Camera combinations.
21 enum {
-
22  SELECT_NONE = 0x0, ///< No camera.
-
23  SELECT_OUT1 = BIT(0), ///< Outer camera 1.
-
24  SELECT_IN1 = BIT(1), ///< Inner camera 1.
-
25  SELECT_OUT2 = BIT(2), ///< Outer camera 2.
+
22  SELECT_NONE = 0x0, ///< No camera.
+
23  SELECT_OUT1 = BIT(0), ///< Outer camera 1.
+
24  SELECT_IN1 = BIT(1), ///< Inner camera 1.
+
25  SELECT_OUT2 = BIT(2), ///< Outer camera 2.
26 
27  // Camera combinations.
-
28  SELECT_IN1_OUT1 = SELECT_OUT1 | SELECT_IN1, ///< Outer camera 1 and inner camera 1.
-
29  SELECT_OUT1_OUT2 = SELECT_OUT1 | SELECT_OUT2, ///< Both outer cameras.
-
30  SELECT_IN1_OUT2 = SELECT_IN1 | SELECT_OUT2, ///< Inner camera 1 and outer camera 2.
-
31  SELECT_ALL = SELECT_OUT1 | SELECT_IN1 | SELECT_OUT2, ///< All cameras.
+
28  SELECT_IN1_OUT1 = SELECT_OUT1 | SELECT_IN1, ///< Outer camera 1 and inner camera 1.
+
29  SELECT_OUT1_OUT2 = SELECT_OUT1 | SELECT_OUT2, ///< Both outer cameras.
+
30  SELECT_IN1_OUT2 = SELECT_IN1 | SELECT_OUT2, ///< Inner camera 1 and outer camera 2.
+
31  SELECT_ALL = SELECT_OUT1 | SELECT_IN1 | SELECT_OUT2, ///< All cameras.
32 };
33 
34 /// Camera contexts.
@@ -802,10 +802,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result CAMU_SetAutoWhiteBalanceWindow(u32 select, s16 x, s16 y, s16 width, s16 height)
Sets the region to base auto white balance off of for the specified camera.
Result CAMU_ClearBuffer(u32 port)
Clears the buffer and error flags of the specified camera port.
Various system types.
+
Outer camera 1 and inner camera 1.
Definition: cam.h:28
Result CAMU_SetTrimmingParamsCenter(u32 port, s16 trimWidth, s16 trimHeight, s16 camWidth, s16 camHeight)
Sets the parameters used for trimming images, relative to the center of the image.
Portrait mode.
Definition: cam.h:106
u8 photoMode
CAMU_PhotoMode Camera photo mode.
Definition: cam.h:210
-
Inner camera 1 and outer camera 2.
Definition: cam.h:30
Image quality calibration data.
Definition: cam.h:168
Batch camera configuration for use with a context.
Definition: cam.h:226
s16 imageHeight
Image height.
Definition: cam.h:197
@@ -813,13 +813,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
s16 autoExposureWindowWidth
Width of the region to use for auto exposure.
Definition: cam.h:217
Dark lens correction. (OFF)
Definition: cam.h:149
Pattern 4.
Definition: cam.h:127
-
No port.
Definition: cam.h:12
Night mode.
Definition: cam.h:108
Result CAMU_ReadRegisterI2cExclusive(u16 *data, u32 select, u16 addr)
Reads the specified I2C register of the specified camera.
Result CAMU_IsFinishedReceiving(bool *finishedReceiving, u32 port)
Gets whether the specified camera port has finished receiving image data.
7000K white balance.
Definition: cam.h:91
u16 awbCcmL9Left
Left camera, left color correction matrix red/green gain.
Definition: cam.h:175
-
Both ports.
Definition: cam.h:17
VGA size. (640x480)
Definition: cam.h:54
CAMU_FrameRate
Camera capture frame rates.
Definition: cam.h:68
8.5 FPS.
Definition: cam.h:73
@@ -841,6 +839,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
3200K white balance.
Definition: cam.h:87
Result CAMU_SetPackageParameterWithContextDetail(CAMU_PackageParameterContextDetail param)
Configures a camera with pre-packaged configuration data without a context and extra resolution detai...
Result camInit(void)
Initializes the cam service.
+
Both outer cameras.
Definition: cam.h:29
s16 autoExposureWindowX
X of the region to use for auto exposure.
Definition: cam.h:215
Stereo camera calibration data.
Definition: cam.h:183
Context A.
Definition: cam.h:37
@@ -872,11 +871,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
CTR Bottom LCD size. (320x240)
Definition: cam.h:64
Result CAMU_SetTrimming(u32 port, bool trimming)
Sets whether image trimming is enabled.
Context B.
Definition: cam.h:38
-
Outer camera 2.
Definition: cam.h:25
Result CAMU_GetSleepCamera(u32 *select)
Gets the current sleep camera.
uint8_t u8
8-bit unsigned integer
Definition: types.h:14
Result CAMU_SetAutoWhiteBalance(u32 select, bool autoWhiteBalance)
Sets whether auto white balance is enabled on the specified camera.
-
No camera.
Definition: cam.h:22
No effects.
Definition: cam.h:114
Pattern 11.
Definition: cam.h:134
s16 aeBaseTarget
Auto exposure base target brightness.
Definition: cam.h:169
@@ -899,6 +896,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
YUV422.
Definition: cam.h:156
u8 frameRate
CAMU_FrameRate Camera frame rate.
Definition: cam.h:209
uint32_t u32
32-bit unsigned integer
Definition: types.h:16
+
No port.
Definition: cam.h:12
Result CAMU_IsAutoExposure(bool *autoExposure, u32 select)
Gets whether auto exposure is enabled on the specified camera.
Sepia effect.
Definition: cam.h:116
Result CAMU_IsAutoWhiteBalance(bool *autoWhiteBalance, u32 select)
Gets whether auto white balance is enabled on the specified camera.
@@ -907,15 +905,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
QVGA size. (320x240)
Definition: cam.h:55
Vertical flip.
Definition: cam.h:48
u8 whiteBalance
CAMU_WhiteBalance Camera white balance.
Definition: cam.h:205
-
CAM1 port.
Definition: cam.h:13
+
Inner camera 1 and outer camera 2.
Definition: cam.h:30
+
No camera.
Definition: cam.h:22
30-5 FPS.
Definition: cam.h:78
Result CAMU_SetSleepCamera(u32 select)
Sets the current sleep camera.
+
All cameras.
Definition: cam.h:31
Result CAMU_SetLensCorrection(u32 select, CAMU_LensCorrection lensCorrection)
Sets the lens correction mode of the given camera.
-
CAM2 port.
Definition: cam.h:14
CIF size. (352x288)
Definition: cam.h:57
s16 cropX1
Second crop point X.
Definition: cam.h:244
30 FPS.
Definition: cam.h:77
-
All cameras.
Definition: cam.h:31
float rotationY
Y axis rotation to match the left camera image with the right.
Definition: cam.h:191
Result CAMU_GetLatestVsyncTiming(s64 *timing, u32 port, u32 past)
Gets the vsync timing record of the specified camera for the specified number of signals.
Result CAMU_StartCapture(u32 port)
Begins capture on the specified camera port.
@@ -931,8 +929,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result CAMU_SetReceiving(Handle *event, void *dst, u32 port, u32 imageSize, s16 transferUnit)
Initiates the process of receiving a camera frame.
u16 awbCcmL10Right
Right camera, left color correction matrix blue/green gain.
Definition: cam.h:176
float translationY
Y axis translation to match the left camera image with the right.
Definition: cam.h:189
+
Inner camera 1.
Definition: cam.h:24
Reverse flip.
Definition: cam.h:49
-
Both outer cameras.
Definition: cam.h:29
Result CAMU_SetSharpness(u32 select, s8 sharpness)
Sets the sharpness of the specified camera.
Result CAMU_SetTransferLines(u32 port, s16 lines, s16 width, s16 height)
Sets the number of lines to transfer into an image buffer.
30-10 FPS.
Definition: cam.h:81
@@ -943,10 +941,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Shutter sound to end a movie.
Definition: cam.h:164
float distanceToChart
Distance between cameras and measurement chart.
Definition: cam.h:194
CAMU_Context
Camera contexts.
Definition: cam.h:35
+
Outer camera 2.
Definition: cam.h:25
15-2 FPS.
Definition: cam.h:71
Low contrast. (5)
Definition: cam.h:137
Mono effect.
Definition: cam.h:115
-
Outer camera 1 and inner camera 1.
Definition: cam.h:28
s16 kBL
Left color correction matrix blue normalization coefficient.
Definition: cam.h:172
Result CAMU_SetEffect(u32 select, CAMU_Effect effect, CAMU_Context context)
Sets the special effects of the given camera in the given context.
Result CAMU_SetTrimmingParams(u32 port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd)
Sets the parameters used for trimming images.
@@ -974,7 +972,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
s16 autoWhiteBalanceWindowY
Y of the region to use for auto white balance.
Definition: cam.h:220
Result CAMU_SetPhotoMode(u32 select, CAMU_PhotoMode photoMode)
Sets the photo mode of the given camera.
s16 cropY0
First crop point Y.
Definition: cam.h:243
-
Outer camera 1.
Definition: cam.h:23
+
CAM1 port.
Definition: cam.h:13
5200K white balance.
Definition: cam.h:89
QCIF size. (176x144)
Definition: cam.h:58
Bright lens correction. (90)
Definition: cam.h:151
@@ -993,6 +991,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
CAMU_LensCorrection
Camera lens correction modes.
Definition: cam.h:143
u8 autoWhiteBalanceOn
#bool Whether to automatically determine the white balance mode.
Definition: cam.h:208
Pattern 3.
Definition: cam.h:126
+
CAM2 port.
Definition: cam.h:14
Result CAMU_SetNoiseFilter(u32 select, bool noiseFilter)
Sets whether the specified camera's noise filter is enabled.
Pattern 5.
Definition: cam.h:128
u8 autoExposureOn
#bool Whether to automatically determine the proper exposure.
Definition: cam.h:207
@@ -1004,6 +1003,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
20 FPS.
Definition: cam.h:75
Result CAMU_GetImageQualityCalibrationData(CAMU_ImageQualityCalibrationData *data)
Gets the specified camera's image quality calibration data.
u8 context
CAMU_Context Selected context.
Definition: cam.h:228
+
Both ports.
Definition: cam.h:17
Result CAMU_GetStereoCameraCalibrationData(CAMU_StereoCameraCalibrationData *data)
Gets the specified camera's stereo camera calibration data.
Edge-to-center brightness ratio of 90.
Definition: cam.h:146
float rotationZ
Z axis rotation to match the left camera image with the right.
Definition: cam.h:187
@@ -1015,8 +1015,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result CAMU_SynchronizeVsyncTiming(u32 select1, u32 select2)
Synchronizes the specified cameras' vsync timing.
Result CAMU_SetDetailSize(u32 select, s16 width, s16 height, s16 cropX0, s16 cropY0, s16 cropX1, s16 cropY1, CAMU_Context context)
Sets the image resolution of the given camera in the given context, in detail.
Result CAMU_GetMaxLines(s16 *maxLines, s16 width, s16 height)
Gets the maximum number of lines that can be saved to an image buffer.
-
Inner camera 1.
Definition: cam.h:24
float angleOfViewRight
Right camera angle of view.
Definition: cam.h:192
+
Outer camera 1.
Definition: cam.h:23
Edge-to-center brightness ratio of 70.
Definition: cam.h:145
s8 sharpness
Camera sharpness.
Definition: cam.h:206
float rotationX
X axis rotation to match the left camera image with the right.
Definition: cam.h:190
diff --git a/channel_8h.html b/channel_8h.html index b92049f..0e72ea1 100644 --- a/channel_8h.html +++ b/channel_8h.html @@ -157,38 +157,38 @@ Data types #define NDSP_ENCODING(n)   (((u32)(n) & 3) << 2)  Specifies the encoding used in a sample.
  -enum  {
-  NDSP_ENCODING_PCM8 = 0, +enum  {
+  NDSP_ENCODING_PCM8 = 0,
-  NDSP_ENCODING_PCM16, +  NDSP_ENCODING_PCM16,
-  NDSP_ENCODING_ADPCM +  NDSP_ENCODING_ADPCM
- }  + }  -enum  {
-  NDSP_FORMAT_MONO_PCM8 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM8), +enum  {
+  NDSP_FORMAT_MONO_PCM8 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM8),
-  NDSP_FORMAT_MONO_PCM16 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM16), +  NDSP_FORMAT_MONO_PCM16 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM16),
-  NDSP_FORMAT_MONO_ADPCM = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_ADPCM), +  NDSP_FORMAT_MONO_ADPCM = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_ADPCM),
-  NDSP_FORMAT_STEREO_PCM8 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM8), +  NDSP_FORMAT_STEREO_PCM8 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM8),
-  NDSP_FORMAT_STEREO_PCM16 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM16), +  NDSP_FORMAT_STEREO_PCM16 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM16),
-  NDSP_FORMAT_PCM8 = NDSP_FORMAT_MONO_PCM8, +  NDSP_FORMAT_PCM8 = NDSP_FORMAT_MONO_PCM8,
-  NDSP_FORMAT_PCM16 = NDSP_FORMAT_MONO_PCM16, +  NDSP_FORMAT_PCM16 = NDSP_FORMAT_MONO_PCM16,
-  NDSP_FORMAT_ADPCM = NDSP_FORMAT_MONO_ADPCM, +  NDSP_FORMAT_ADPCM = NDSP_FORMAT_MONO_ADPCM,
-  NDSP_FRONT_BYPASS = BIT(4), +  NDSP_FRONT_BYPASS = BIT(4),
-  NDSP_3D_SURROUND_PREPROCESSED = BIT(6) +  NDSP_3D_SURROUND_PREPROCESSED = BIT(6)
- } Channel format flags for use with ndspChnSetFormat. More...
-  + } Channel format flags for use with ndspChnSetFormat. More...
+  enum  ndspInterpType {
  NDSP_INTERP_POLYPHASE = 0, @@ -204,7 +204,7 @@ Data types

Detailed Description

Functions for interacting with DSP audio channels.

Enumeration Type Documentation

- +
@@ -214,20 +214,20 @@ Data types
- - -
Enumerator
NDSP_ENCODING_PCM8  +
Enumerator
NDSP_ENCODING_PCM8 

PCM8.

NDSP_ENCODING_PCM16  +
NDSP_ENCODING_PCM16 

PCM16.

NDSP_ENCODING_ADPCM  +
NDSP_ENCODING_ADPCM 

DSPADPCM (GameCube format)

- +
@@ -239,34 +239,34 @@ Data types

Channel format flags for use with ndspChnSetFormat.

- - - - - - - - - -
Enumerator
NDSP_FORMAT_MONO_PCM8  +
Enumerator
NDSP_FORMAT_MONO_PCM8 

Buffer contains Mono PCM8.

NDSP_FORMAT_MONO_PCM16  +
NDSP_FORMAT_MONO_PCM16 

Buffer contains Mono PCM16.

NDSP_FORMAT_MONO_ADPCM  +
NDSP_FORMAT_MONO_ADPCM 

Buffer contains Mono ADPCM.

NDSP_FORMAT_STEREO_PCM8  +
NDSP_FORMAT_STEREO_PCM8 

Buffer contains Stereo PCM8.

NDSP_FORMAT_STEREO_PCM16  +
NDSP_FORMAT_STEREO_PCM16 

Buffer contains Stereo PCM16.

NDSP_FORMAT_PCM8  +
NDSP_FORMAT_PCM8 

(Alias) Buffer contains Mono PCM8.

NDSP_FORMAT_PCM16  +
NDSP_FORMAT_PCM16 

(Alias) Buffer contains Mono PCM16.

NDSP_FORMAT_ADPCM  +
NDSP_FORMAT_ADPCM 

(Alias) Buffer contains Mono ADPCM.

NDSP_FRONT_BYPASS  +
NDSP_FRONT_BYPASS 

Front bypass.

NDSP_3D_SURROUND_PREPROCESSED  +
NDSP_3D_SURROUND_PREPROCESSED 

(?) Unknown, under research

diff --git a/channel_8h_source.html b/channel_8h_source.html index 39a8324..3cf60a9 100644 --- a/channel_8h_source.html +++ b/channel_8h_source.html @@ -101,9 +101,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
9 /// Supported sample encodings.
10 enum
11 {
-
12  NDSP_ENCODING_PCM8 = 0, ///< PCM8
-
13  NDSP_ENCODING_PCM16, ///< PCM16
-
14  NDSP_ENCODING_ADPCM, ///< DSPADPCM (GameCube format)
+
12  NDSP_ENCODING_PCM8 = 0, ///< PCM8
+
13  NDSP_ENCODING_PCM16, ///< PCM16
+
14  NDSP_ENCODING_ADPCM, ///< DSPADPCM (GameCube format)
15 };
16 
17 /// Specifies the number of channels used in a sample.
@@ -114,19 +114,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
22 /// Channel format flags for use with ndspChnSetFormat.
23 enum
24 {
-
25  NDSP_FORMAT_MONO_PCM8 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM8), ///< Buffer contains Mono PCM8.
-
26  NDSP_FORMAT_MONO_PCM16 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM16), ///< Buffer contains Mono PCM16.
-
27  NDSP_FORMAT_MONO_ADPCM = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_ADPCM), ///< Buffer contains Mono ADPCM.
-
28  NDSP_FORMAT_STEREO_PCM8 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM8), ///< Buffer contains Stereo PCM8.
-
29  NDSP_FORMAT_STEREO_PCM16 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM16), ///< Buffer contains Stereo PCM16.
+
25  NDSP_FORMAT_MONO_PCM8 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM8), ///< Buffer contains Mono PCM8.
+
26  NDSP_FORMAT_MONO_PCM16 = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM16), ///< Buffer contains Mono PCM16.
+
27  NDSP_FORMAT_MONO_ADPCM = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_ADPCM), ///< Buffer contains Mono ADPCM.
+
28  NDSP_FORMAT_STEREO_PCM8 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM8), ///< Buffer contains Stereo PCM8.
+
29  NDSP_FORMAT_STEREO_PCM16 = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM16), ///< Buffer contains Stereo PCM16.
30 
-
31  NDSP_FORMAT_PCM8 = NDSP_FORMAT_MONO_PCM8, ///< (Alias) Buffer contains Mono PCM8.
-
32  NDSP_FORMAT_PCM16 = NDSP_FORMAT_MONO_PCM16, ///< (Alias) Buffer contains Mono PCM16.
-
33  NDSP_FORMAT_ADPCM = NDSP_FORMAT_MONO_ADPCM, ///< (Alias) Buffer contains Mono ADPCM.
+
31  NDSP_FORMAT_PCM8 = NDSP_FORMAT_MONO_PCM8, ///< (Alias) Buffer contains Mono PCM8.
+
32  NDSP_FORMAT_PCM16 = NDSP_FORMAT_MONO_PCM16, ///< (Alias) Buffer contains Mono PCM16.
+
33  NDSP_FORMAT_ADPCM = NDSP_FORMAT_MONO_ADPCM, ///< (Alias) Buffer contains Mono ADPCM.
34 
35  // Flags
-
36  NDSP_FRONT_BYPASS = BIT(4), ///< Front bypass.
-
37  NDSP_3D_SURROUND_PREPROCESSED = BIT(6), ///< (?) Unknown, under research
+
36  NDSP_FRONT_BYPASS = BIT(4), ///< Front bypass.
+
37  NDSP_3D_SURROUND_PREPROCESSED = BIT(6), ///< (?) Unknown, under research
38 };
39 
40 /// Interpolation types.
@@ -253,42 +253,42 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
161 void ndspChnIirBiquadSetEnable(int id, bool enable);
162 // ndspChnIirBiquadSetParams
163 ///@}
-
Front bypass.
Definition: channel.h:36
void ndspChnSetRate(int id, float rate)
Sets the sample rate of a channel.
u32 ndspChnGetSamplePos(int id)
Gets the current sample position of a channel.
uint16_t u16
16-bit unsigned integer
Definition: types.h:15
+
PCM16.
Definition: channel.h:13
+
(Alias) Buffer contains Mono PCM16.
Definition: channel.h:32
void ndspChnSetInterp(int id, ndspInterpType type)
Sets the interpolation type of a channel.
void ndspChnIirBiquadSetEnable(int id, bool enable)
Configures whether the IIR biquad filter of a channel is enabled.
Polyphase interpolation.
Definition: channel.h:43
ndspInterpType
Interpolation types.
Definition: channel.h:41
-
Buffer contains Mono PCM8.
Definition: channel.h:25
No interpolation.
Definition: channel.h:45
void ndspChnWaveBufAdd(int id, ndspWaveBuf *buf)
Adds a wave buffer to the wave buffer queue of a channel.
-
PCM8.
Definition: channel.h:12
-
PCM16.
Definition: channel.h:13
+
Buffer contains Mono ADPCM.
Definition: channel.h:27
void ndspChnIirMonoSetEnable(int id, bool enable)
Configures whether the IIR monopole filter of a channel is enabled.
-
DSPADPCM (GameCube format)
Definition: channel.h:14
+
DSPADPCM (GameCube format)
Definition: channel.h:14
void ndspChnReset(int id)
Resets a channel.
Linear interpolation.
Definition: channel.h:44
-
Buffer contains Stereo PCM16.
Definition: channel.h:29
+
Buffer contains Mono PCM8.
Definition: channel.h:25
uint32_t u32
32-bit unsigned integer
Definition: types.h:16
-
(Alias) Buffer contains Mono PCM8.
Definition: channel.h:31
u16 ndspChnGetWaveBufSeq(int id)
Gets the sequence ID of the wave buffer that is currently playing in a channel.
+
Buffer contains Mono PCM16.
Definition: channel.h:26
#define NDSP_CHANNELS(n)
Specifies the number of channels used in a sample.
Definition: channel.h:18
bool ndspChnIsPlaying(int id)
Checks whether a channel is currently playing.
-
(Alias) Buffer contains Mono PCM16.
Definition: channel.h:32
-
Buffer contains Mono PCM16.
Definition: channel.h:26
-
Buffer contains Stereo PCM8.
Definition: channel.h:28
void ndspChnSetAdpcmCoefs(int id, u16 coefs[16])
Sets the DSPADPCM coefficients of a channel.
#define NDSP_ENCODING(n)
Specifies the encoding used in a sample.
Definition: channel.h:20
#define BIT(n)
Creates a bitmask from a bit number.
Definition: types.h:39
-
(Alias) Buffer contains Mono ADPCM.
Definition: channel.h:33
+
Buffer contains Stereo PCM8.
Definition: channel.h:28
+
(Alias) Buffer contains Mono PCM8.
Definition: channel.h:31
+
(?) Unknown, under research
Definition: channel.h:37
void ndspChnWaveBufClear(int id)
Clears the wave buffer queue of a channel and stops playback.
void ndspChnInitParams(int id)
Initializes the parameters of a channel.
-
Buffer contains Mono ADPCM.
Definition: channel.h:27
void ndspChnSetMix(int id, float mix[12])
Sets the mix parameters (volumes) of a channel.
-
(?) Unknown, under research
Definition: channel.h:37
+
Front bypass.
Definition: channel.h:36
+
Buffer contains Stereo PCM16.
Definition: channel.h:29
void ndspChnSetFormat(int id, u16 format)
Sets the format of a channel.
+
PCM8.
Definition: channel.h:12
+
(Alias) Buffer contains Mono ADPCM.
Definition: channel.h:33
- +
@@ -406,23 +406,23 @@ Variables

CSND loop modes.

- - - -
Enumerator
CSND_LOOPMODE_MANUAL  +
Enumerator
CSND_LOOPMODE_MANUAL 

Manual loop.

CSND_LOOPMODE_NORMAL  +
CSND_LOOPMODE_NORMAL 

Normal loop.

CSND_LOOPMODE_ONESHOT  +
CSND_LOOPMODE_ONESHOT 

Do not loop.

CSND_LOOPMODE_NORELOAD  +
CSND_LOOPMODE_NORELOAD 

Don't reload.

- +
@@ -434,35 +434,35 @@ Variables

Sound flags.

- - - - - - - -
Enumerator
SOUND_LINEAR_INTERP  +
Enumerator
SOUND_LINEAR_INTERP 

Linear interpolation.

SOUND_REPEAT  +
SOUND_REPEAT 

Repeat the sound.

SOUND_ONE_SHOT  +
SOUND_ONE_SHOT 

Play the sound once.

SOUND_FORMAT_8BIT  +
SOUND_FORMAT_8BIT 

PCM8.

SOUND_FORMAT_16BIT  +
SOUND_FORMAT_16BIT 

PCM16.

SOUND_FORMAT_ADPCM  +
SOUND_FORMAT_ADPCM 

ADPCM.

SOUND_FORMAT_PSG  +
SOUND_FORMAT_PSG 

PSG.

SOUND_ENABLE  +
SOUND_ENABLE 

Enable sound.

- +
@@ -474,19 +474,19 @@ Variables

Capture modes.

- - - - -
Enumerator
CAPTURE_REPEAT  +
Enumerator
CAPTURE_REPEAT 

Repeat capture.

CAPTURE_ONE_SHOT  +
CAPTURE_ONE_SHOT 

Capture once.

CAPTURE_FORMAT_16BIT  +
CAPTURE_FORMAT_16BIT 

PCM16.

CAPTURE_FORMAT_8BIT  +
CAPTURE_FORMAT_8BIT 

PCM8.

CAPTURE_ENABLE  +
CAPTURE_ENABLE 

Enable capture.

diff --git a/csnd_8h_source.html b/csnd_8h_source.html index 03aba46..95bf520 100644 --- a/csnd_8h_source.html +++ b/csnd_8h_source.html @@ -127,19 +127,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
35 /// CSND encodings.
36 enum
37 {
-
38  CSND_ENCODING_PCM8 = 0, ///< PCM8
-
39  CSND_ENCODING_PCM16, ///< PCM16
-
40  CSND_ENCODING_ADPCM, ///< IMA-ADPCM
-
41  CSND_ENCODING_PSG, ///< PSG (Similar to DS?)
+
38  CSND_ENCODING_PCM8 = 0, ///< PCM8
+
39  CSND_ENCODING_PCM16, ///< PCM16
+
40  CSND_ENCODING_ADPCM, ///< IMA-ADPCM
+
41  CSND_ENCODING_PSG, ///< PSG (Similar to DS?)
42 };
43 
44 /// CSND loop modes.
45 enum
46 {
-
47  CSND_LOOPMODE_MANUAL = 0, ///< Manual loop.
-
48  CSND_LOOPMODE_NORMAL, ///< Normal loop.
-
49  CSND_LOOPMODE_ONESHOT, ///< Do not loop.
-
50  CSND_LOOPMODE_NORELOAD, ///< Don't reload.
+
47  CSND_LOOPMODE_MANUAL = 0, ///< Manual loop.
+
48  CSND_LOOPMODE_NORMAL, ///< Normal loop.
+
49  CSND_LOOPMODE_ONESHOT, ///< Do not loop.
+
50  CSND_LOOPMODE_NORELOAD, ///< Don't reload.
51 };
52 
53 /// Creates a sound channel value from a channel number.
@@ -154,24 +154,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
62 /// Sound flags.
63 enum
64 {
-
65  SOUND_LINEAR_INTERP = BIT(6), ///< Linear interpolation.
- -
67  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), ///< Play the sound once.
- - - - -
72  SOUND_ENABLE = BIT(14), ///< Enable sound.
+
65  SOUND_LINEAR_INTERP = BIT(6), ///< Linear interpolation.
+ +
67  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), ///< Play the sound once.
+ + + + +
72  SOUND_ENABLE = BIT(14), ///< Enable sound.
73 };
74 
75 /// Capture modes.
76 enum
77 {
-
78  CAPTURE_REPEAT = 0, ///< Repeat capture.
-
79  CAPTURE_ONE_SHOT = BIT(0), ///< Capture once.
-
80  CAPTURE_FORMAT_16BIT = 0, ///< PCM16
-
81  CAPTURE_FORMAT_8BIT = BIT(1), ///< PCM8
-
82  CAPTURE_ENABLE = BIT(15), ///< Enable capture.
+
78  CAPTURE_REPEAT = 0, ///< Repeat capture.
+
79  CAPTURE_ONE_SHOT = BIT(0), ///< Capture once.
+
80  CAPTURE_FORMAT_16BIT = 0, ///< PCM16
+
81  CAPTURE_FORMAT_8BIT = BIT(1), ///< PCM8
+
82  CAPTURE_ENABLE = BIT(15), ///< Enable capture.
83 };
84 
85 /// Duty cycles for a PSG channel.
@@ -520,46 +520,38 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
428  * @param status Pointer to output the channel status to.
429  */
430 Result csndIsPlaying(u32 channel, u8* status);
+
PSG (Similar to DS?)
Definition: csnd.h:41
void CSND_SetInterp(u32 channel, bool interp)
Sets whether a channel should use interpolation.
volatile u32 vu32
32-bit volatile unsigned integer.
Definition: types.h:26
Various system types.
-
Do not loop.
Definition: csnd.h:49
-
Manual loop.
Definition: csnd.h:47
-
PCM8.
Definition: csnd.h:38
s32 Result
Function result.
Definition: types.h:35
-
PCM8.
Definition: csnd.h:81
75.0% duty cycle
Definition: csnd.h:94
u32 unknownZero
Unknown.
Definition: csnd.h:123
+
Enable capture.
Definition: csnd.h:82
Result CSND_Reset(void)
Resets CSND.
uint16_t u16
16-bit unsigned integer
Definition: types.h:15
-
Enable sound.
Definition: csnd.h:72
u16 _pad2
Padding.
Definition: csnd.h:122
12.5% duty cycle
Definition: csnd.h:89
-
Enable capture.
Definition: csnd.h:82
-
Don't reload.
Definition: csnd.h:50
+
Linear interpolation.
Definition: csnd.h:65
void CSND_SetChnRegsPSG(u32 flags, u32 chnVolumes, u32 capVolumes, CSND_DutyCycle duty)
Sets CSND's PSG channel registers.
void CSND_SetLooping(u32 channel, u32 value)
Sets whether to loop a channel.
+
Normal loop.
Definition: csnd.h:48
void csndWriteCmd(int cmdid, u8 *cmdparams)
Adds a command to the list, copying its arguments from a buffer.
-
Repeat the sound.
Definition: csnd.h:66
-
Linear interpolation.
Definition: csnd.h:65
void CSND_SetChnRegsNoise(u32 flags, u32 chnVolumes, u32 capVolumes)
Sets CSND's noise channel registers.
+
PCM16.
Definition: csnd.h:80
u8 _pad1
Padding.
Definition: csnd.h:105
-
PSG (Similar to DS?)
Definition: csnd.h:41
void CSND_SetEncoding(u32 channel, u32 value)
Sets a channel's encoding.
-
ADPCM.
Definition: csnd.h:70
uint8_t u8
8-bit unsigned integer
Definition: types.h:14
-
Repeat capture.
Definition: csnd.h:78
25.0% duty cycle
Definition: csnd.h:90
#define SOUND_FORMAT(n)
Creates a sound format value from an encoding.
Definition: csnd.h:57
#define SOUND_LOOPMODE(n)
Creates a sound loop mode value from a loop mode.
Definition: csnd.h:60
void csndGetDspFlags(u32 *outSemFlags, u32 *outIrqFlags)
Gets CSND's DSP flags.
Result CSND_FlushDataCache(const void *adr, u32 size)
Flushes the data cache of a memory region.
-
PCM16.
Definition: csnd.h:39
+
Enable sound.
Definition: csnd.h:72
u8 adpcmIndex
Current ADPCM index.
Definition: csnd.h:108
-
PCM8.
Definition: csnd.h:68
CSND_CapInfo * csndGetCapInfo(u32 capUnit)
Gets a capture unit's information.
-
PSG.
Definition: csnd.h:71
uint32_t u32
32-bit unsigned integer
Definition: types.h:16
+
Play the sound once.
Definition: csnd.h:67
Result CSND_StoreDataCache(const void *adr, u32 size)
Stores the data cache of a memory region.
Result CSND_InvalidateDataCache(const void *adr, u32 size)
Invalidates the data cache of a memory region.
void CSND_CapEnable(u32 capUnit, bool enable)
Sets whether a capture unit is enabled.
@@ -569,20 +561,23 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result csndInit(void)
Initializes CSND.
Result CSND_ReleaseCapUnit(u32 capUnit)
Releases a capture unit.
void CSND_SetPlayState(u32 channel, u32 value)
Sets a channel's play state.
+
PCM8.
Definition: csnd.h:38
+
ADPCM.
Definition: csnd.h:70
void CSND_SetChnRegs(u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes)
Sets CSND's channel registers.
+
Repeat capture.
Definition: csnd.h:78
void CSND_SetAdpcmState(u32 channel, int block, int sample, int index)
Sets a channel's ADPCM state.
+
PCM8.
Definition: csnd.h:81
vu32 * csndSharedMem
CSND shared memory.
s16 adpcmSample
Current ADPCM sample.
Definition: csnd.h:107
0.0% duty cycle
Definition: csnd.h:88
-
Capture once.
Definition: csnd.h:79
+
Capture once.
Definition: csnd.h:79
+
PCM16.
Definition: csnd.h:69
void CSND_CapSetBuffer(u32 capUnit, u32 addr, u32 size)
Sets a capture unit's buffer.
void CSND_SetPlayStateR(u32 channel, u32 value)
Sets a channel's play state, resetting registers on stop.
Result CSND_AcquireCapUnit(u32 *capUnit)
Acquires a capture unit.
void CSND_SetBlock(u32 channel, int block, u32 physaddr, u32 size)
Sets the data of a channel's block.
void csndExit(void)
Exits CSND.
Result csndExecCmds(bool waitDone)
Executes pending CSND commands.
-
Normal loop.
Definition: csnd.h:48
-
IMA-ADPCM.
Definition: csnd.h:40
50.0% duty cycle
Definition: csnd.h:92
void CSND_SetTimer(u32 channel, u32 timer)
Sets a channel's timer.
CSND_ChnInfo * csndGetChnInfo(u32 channel)
Gets a channel's information.
@@ -591,25 +586,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result CSND_UpdateInfo(bool waitDone)
Updates CSND information.
37.5% duty cycle
Definition: csnd.h:91
Result CSND_SetDspFlags(bool waitDone)
Sets up DSP flags.
+
Don't reload.
Definition: csnd.h:50
+
PSG.
Definition: csnd.h:71
u16 _pad2
Padding.
Definition: csnd.h:106
Channel info.
Definition: csnd.h:99
u8 active
Capture active.
Definition: csnd.h:120
-
PCM16.
Definition: csnd.h:69
void CSND_SetDuty(u32 channel, CSND_DutyCycle duty)
Sets a channel's duty.
Result csndGetState(u32 channel, CSND_ChnInfo *out)
Gets a channel's state.
void CSND_SetAdpcmReload(u32 channel, bool reload)
Sets a whether channel's ADPCM data should be reloaded when the second block is played.
Result csndIsPlaying(u32 channel, u8 *status)
Gets whether a channel is playing.
+
PCM8.
Definition: csnd.h:68
62.5% duty cycle
Definition: csnd.h:93
-
PCM16.
Definition: csnd.h:80
+
IMA-ADPCM.
Definition: csnd.h:40
void CSND_CapSetBit2(u32 capUnit, bool set)
Sets a capture unit's second bit.
Capture info.
Definition: csnd.h:115
u32 unknownZero
Unknown.
Definition: csnd.h:110
-
Play the sound once.
Definition: csnd.h:67
void CSND_SetBit7(u32 channel, bool set)
Sets bit 7 of a channel.
static u32 CSND_VOL(float vol, float pan)
Converts a vol-pan pair into a left/right volume pair used by the hardware.
Definition: csnd.h:21
void CSND_CapSetTimer(u32 capUnit, u32 timer)
Sets a capture unit's timer.
Result csndPlaySound(int chn, u32 flags, u32 sampleRate, float vol, float pan, void *data0, void *data1, u32 size)
Plays a sound.
+
PCM16.
Definition: csnd.h:39
CSND_DutyCycle
Duty cycles for a PSG channel.
Definition: csnd.h:86
+
Manual loop.
Definition: csnd.h:47
u32 csndChannels
Bitmask of channels that are allowed for usage.
u8 active
Channel active.
Definition: csnd.h:104
void CSND_CapSetRepeat(u32 capUnit, bool repeat)
Sets whether a capture unit should repeat.
@@ -618,6 +616,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
int16_t s16
16-bit signed integer
Definition: types.h:20
void CSND_SetVol(u32 channel, u32 chnVolumes, u32 capVolumes)
Sets a channel's volume.
87.5% duty cycle
Definition: csnd.h:95
+
Repeat the sound.
Definition: csnd.h:66
+
Do not loop.
Definition: csnd.h:49