From 81cad705d58b7682fba1a55bfab622f89bc74e57 Mon Sep 17 00:00:00 2001 From: TravisCI-DocBuilder Date: Wed, 11 Nov 2015 18:33:07 +0000 Subject: [PATCH] Doc generated from commit 5d41effb6ecb9868db095a62a1a87e1bb82ced25 --- 3ds_8h.html | 11 +- 3ds_8h_source.html | 231 ++--- ac_8h.html | 8 +- ac_8h_source.html | 18 +- annotated.html | 18 +- app_launch_2source_2main_8c-example.html | 4 +- apt_8h.html | 212 ++--- apt_8h_source.html | 136 +-- audio_2mic_2source_2main_8c-example.html | 10 +- cam_8h.html | 594 ++++++------- cam_8h_source.html | 264 +++--- cfgnor_8h.html | 123 ++- cfgnor_8h_source.html | 77 +- cfgu_8h_source.html | 4 +- channel_8h.html | 33 +- channel_8h_source.html | 168 ++-- classes.html | 69 +- console_8h.html | 2 +- csnd_8h.html | 292 ++++-- csnd_8h_source.html | 609 +++++++------ dir_0e005207343684f6967052d1f51a7e66.html | 17 +- dir_6dafe9e8493a4966457f520acc17aa32.html | 108 +++ dir_d475325f6a9fe3bfc3a495c72a9e475e.html | 11 +- files.html | 112 +-- fs_8h_source.html | 517 ++++++----- functions_a.html | 4 +- functions_b.html | 2 +- functions_c.html | 2 +- functions_f.html | 24 +- functions_i.html | 12 +- functions_o.html | 12 +- functions_p.html | 8 +- functions_r.html | 2 +- functions_s.html | 6 +- functions_u.html | 21 +- functions_vars_a.html | 4 +- functions_vars_b.html | 2 +- functions_vars_c.html | 2 +- functions_vars_f.html | 24 +- functions_vars_i.html | 12 +- functions_vars_o.html | 12 +- functions_vars_p.html | 8 +- functions_vars_r.html | 2 +- functions_vars_s.html | 6 +- functions_vars_u.html | 21 +- functions_vars_x.html | 2 +- functions_vars_y.html | 2 +- functions_x.html | 2 +- functions_y.html | 2 +- ...tem_language_2source_2main_8c-example.html | 4 +- gfx_8h.html | 46 +- gfx_8h_source.html | 18 +- globals_a.html | 72 +- globals_b.html | 4 +- globals_c.html | 168 ++-- globals_d.html | 16 +- globals_defs_g.html | 16 +- globals_enum.html | 89 +- globals_eval.html | 48 +- globals_eval_b.html | 4 +- globals_eval_c.html | 34 +- globals_eval_d.html | 16 +- globals_eval_g.html | 54 +- globals_eval_h.html | 8 +- globals_eval_i.html | 10 +- globals_eval_k.html | 54 +- globals_eval_m.html | 20 +- globals_eval_n.html | 30 +- globals_eval_o.html | 4 +- globals_eval_p.html | 72 +- globals_eval_s.html | 32 +- globals_func_a.html | 10 +- globals_func_c.html | 125 +-- globals_func_g.html | 60 +- globals_func_h.html | 4 +- globals_func_i.html | 18 + globals_func_m.html | 12 +- globals_func_n.html | 8 +- globals_func_p.html | 32 +- globals_func_q.html | 10 +- globals_func_s.html | 57 +- globals_func_y.html | 20 +- globals_g.html | 153 ++-- globals_h.html | 22 +- globals_i.html | 28 +- globals_k.html | 54 +- globals_m.html | 52 +- globals_n.html | 50 +- globals_o.html | 4 +- globals_p.html | 115 ++- globals_q.html | 10 +- globals_s.html | 89 +- globals_type.html | 2 +- globals_y.html | 50 +- ...224bit-color_2source_2main_8c-example.html | 4 +- ...u_2geoshader_2source_2main_8c-example.html | 10 +- ..._2simple_tri_2source_2main_8c-example.html | 10 +- ...extured_cube_2source_2main_8c-example.html | 10 +- ...-screen-text_2source_2main_8c-example.html | 4 +- ...colored-text_2source_2main_8c-example.html | 4 +- ...2hello-world_2source_2main_8c-example.html | 4 +- ...windows-text_2source_2main_8c-example.html | 4 +- gspgpu_8h.html | 829 ++++++++++++++++++ gspgpu_8h_source.html | 359 ++++++++ gsplcd_8h.html | 218 +++++ gsplcd_8h_source.html | 147 ++++ gx_8h.html | 2 +- gx_8h_source.html | 2 +- hid_8h.html | 188 ++-- hid_8h_source.html | 113 ++- http_2source_2main_8c-example.html | 6 +- httpc_8h.html | 38 +- httpc_8h_source.html | 22 +- ...ead-controls_2source_2main_8c-example.html | 4 +- ...touch-screen_2source_2main_8c-example.html | 4 +- ir_8h.html | 117 ++- ir_8h_source.html | 79 +- ...pplet_launch_2source_2main_8c-example.html | 6 +- linear_8h.html | 8 +- linear_8h_source.html | 4 +- mappable_8h.html | 4 +- mappable_8h_source.html | 4 +- mvd_2source_2main_8c-example.html | 38 +- mvd_8h.html | 158 ++-- mvd_8h_source.html | 194 ++-- ndsp_8h.html | 136 +-- ndsp_8h_source.html | 75 +- ps_8h.html | 108 +-- ps_8h_source.html | 84 +- ptmsysm_8h.html | 150 ++++ ptmsysm_8h_source.html | 124 +++ ptmu_8h.html | 258 ++++++ ptmu_8h_source.html | 153 ++++ qtm_2source_2main_8c-example.html | 44 +- qtm_8h.html | 111 ++- qtm_8h_source.html | 79 +- result_8h.html | 18 +- sdmc_2source_2main_8c-example.html | 6 +- soc_8h.html | 54 +- soc_8h_source.html | 8 +- srv_8h.html | 324 ++++++- srv_8h_source.html | 156 ++-- srvpm_8h.html | 260 ++++++ srvpm_8h_source.html | 149 ++++ structCAMU__PackageParameterCameraSelect.html | 2 +- structCAMU__PackageParameterContext.html | 2 +- ...ctCAMU__PackageParameterContextDetail.html | 2 +- structDebugEventInfo.html | 60 +- structFS__dirent.html | 12 +- structGSPGPU__CaptureInfo.html | 118 +++ structGSPGPU__CaptureInfoEntry.html | 130 +++ structGSPGPU__FramebufferInfo.html | 142 +++ structMVDSTD__Config.html | 190 ++++ structQTM__HeadTrackingInfo.html | 134 +++ structQTM__HeadTrackingInfoCoord.html | 122 +++ structY2RU__ColorCoefficients.html | 142 +++ structY2RU__ConversionParams.html | 150 ++++ structY2RU__DitheringWeightParams.html | 162 ++++ structaptHookCookie.html | 2 +- structtag__ndspWaveBuf.html | 30 +- svc_8h.html | 2 +- threads_2event_2source_2main_8c-example.html | 6 +- time_2rtc_2source_2main_8c-example.html | 4 +- unionCSND__CapInfo.html | 30 +- unionCSND__ChnInfo.html | 48 +- vram_8h.html | 4 +- vram_8h_source.html | 4 +- y2r_8h.html | 264 +++--- y2r_8h_source.html | 746 ++++++++-------- 169 files changed, 8946 insertions(+), 4099 deletions(-) create mode 100644 dir_6dafe9e8493a4966457f520acc17aa32.html create mode 100644 gspgpu_8h.html create mode 100644 gspgpu_8h_source.html create mode 100644 gsplcd_8h.html create mode 100644 gsplcd_8h_source.html create mode 100644 ptmsysm_8h.html create mode 100644 ptmsysm_8h_source.html create mode 100644 ptmu_8h.html create mode 100644 ptmu_8h_source.html create mode 100644 srvpm_8h.html create mode 100644 srvpm_8h_source.html create mode 100644 structGSPGPU__CaptureInfo.html create mode 100644 structGSPGPU__CaptureInfoEntry.html create mode 100644 structGSPGPU__FramebufferInfo.html create mode 100644 structMVDSTD__Config.html create mode 100644 structQTM__HeadTrackingInfo.html create mode 100644 structQTM__HeadTrackingInfoCoord.html create mode 100644 structY2RU__ColorCoefficients.html create mode 100644 structY2RU__ConversionParams.html create mode 100644 structY2RU__DitheringWeightParams.html diff --git a/3ds_8h.html b/3ds_8h.html index 495632c..e0076be 100644 --- a/3ds_8h.html +++ b/3ds_8h.html @@ -98,13 +98,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); #include <3ds/ipc.h>
#include <3ds/svc.h>
#include <3ds/srv.h>
-#include <3ds/linear.h>
-#include <3ds/vram.h>
#include <3ds/os.h>
#include <3ds/synchronization.h>
#include <3ds/gfx.h>
#include <3ds/console.h>
#include <3ds/util/utf.h>
+#include <3ds/allocator/linear.h>
+#include <3ds/allocator/mappable.h>
+#include <3ds/allocator/vram.h>
#include <3ds/services/ac.h>
#include <3ds/services/am.h>
#include <3ds/services/apt.h>
@@ -114,7 +115,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); #include <3ds/services/csnd.h>
#include <3ds/services/dsp.h>
#include <3ds/services/fs.h>
-#include <3ds/services/gsp.h>
+#include <3ds/services/gspgpu.h>
+#include <3ds/services/gsplcd.h>
#include <3ds/services/hid.h>
#include <3ds/services/irrst.h>
#include <3ds/services/httpc.h>
@@ -122,7 +124,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); #include <3ds/services/ns.h>
#include <3ds/services/pm.h>
#include <3ds/services/ps.h>
-#include <3ds/services/ptm.h>
+#include <3ds/services/ptmu.h>
+#include <3ds/services/ptmsysm.h>
#include <3ds/services/soc.h>
#include <3ds/services/mic.h>
#include <3ds/services/mvd.h>
diff --git a/3ds_8h_source.html b/3ds_8h_source.html index a9e6ad5..aaf1979 100644 --- a/3ds_8h_source.html +++ b/3ds_8h_source.html @@ -106,121 +106,128 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
14 #include <3ds/ipc.h>
15 #include <3ds/svc.h>
16 #include <3ds/srv.h>
-
17 #include <3ds/linear.h>
-
18 #include <3ds/vram.h>
-
19 #include <3ds/os.h>
-
20 #include <3ds/synchronization.h>
-
21 #include <3ds/gfx.h>
-
22 #include <3ds/console.h>
-
23 #include <3ds/util/utf.h>
-
24 
-
25 #include <3ds/services/ac.h>
-
26 #include <3ds/services/am.h>
-
27 #include <3ds/services/apt.h>
-
28 #include <3ds/services/cam.h>
-
29 #include <3ds/services/cfgnor.h>
-
30 #include <3ds/services/cfgu.h>
-
31 #include <3ds/services/csnd.h>
-
32 #include <3ds/services/dsp.h>
-
33 #include <3ds/services/fs.h>
-
34 #include <3ds/services/gsp.h>
-
35 #include <3ds/services/hid.h>
-
36 #include <3ds/services/irrst.h>
-
37 #include <3ds/services/httpc.h>
-
38 #include <3ds/services/ir.h>
-
39 #include <3ds/services/ns.h>
-
40 #include <3ds/services/pm.h>
-
41 #include <3ds/services/ps.h>
-
42 #include <3ds/services/ptm.h>
-
43 #include <3ds/services/soc.h>
-
44 #include <3ds/services/mic.h>
-
45 #include <3ds/services/mvd.h>
-
46 #include <3ds/services/news.h>
-
47 #include <3ds/services/qtm.h>
-
48 #include <3ds/services/y2r.h>
-
49 #include <3ds/services/hb.h>
-
50 
-
51 #include <3ds/gpu/gx.h>
-
52 #include <3ds/gpu/gpu.h>
-
53 #include <3ds/gpu/gpu-old.h>
-
54 #include <3ds/gpu/shbin.h>
-
55 #include <3ds/gpu/shaderProgram.h>
-
56 
-
57 #include <3ds/ndsp/ndsp.h>
-
58 #include <3ds/ndsp/channel.h>
-
59 
-
60 #include <3ds/sdmc.h>
-
61 #include <3ds/romfs.h>
-
62 
-
63 #ifdef __cplusplus
-
64 }
-
65 #endif
-
66 /**
-
67  * @example app_launch/source/main.c
-
68  * @example audio/mic/source/main.c
-
69  * @example get_system_language/source/main.c
-
70  * @example graphics/bitmap/24bit-color/source/main.c
-
71  * @example graphics/printing/hello-world/source/main.c
-
72  * @example graphics/printing/both-screen-text/source/main.c
-
73  * @example graphics/printing/colored-text/source/main.c
-
74  * @example graphics/printing/multiple-windows-text/source/main.c
-
75 
-
76  * @example graphics/gpu/geoshader/source/main.c
-
77  graphics/gpu/geoshader/source/gpu.h
-
78  @include graphics/gpu/geoshader/source/gpu.h
-
79  graphics/gpu/geoshader/source/gpu.c
-
80  @include graphics/gpu/geoshader/source/gpu.c
-
81  graphics/gpu/geoshader/source/3dmath.h
-
82  @include graphics/gpu/geoshader/source/3dmath.h
-
83  graphics/gpu/geoshader/source/3dmath.c
-
84  @include graphics/gpu/geoshader/source/3dmath.c
-
85  graphics/gpu/geoshader/source/vshader.pica
-
86  @include graphics/gpu/geoshader/source/vshader.pica
-
87  graphics/gpu/geoshader/source/gshader.pica
-
88  @include graphics/gpu/geoshader/source/gshader.pica
-
89 
-
90 
-
91  * @example graphics/gpu/simple_tri/source/main.c
-
92  graphics/gpu/simple_tri/source/gpu.h
-
93  @include graphics/gpu/simple_tri/source/gpu.h
-
94  graphics/gpu/simple_tri/source/gpu.c
-
95  @include graphics/gpu/simple_tri/source/gpu.c
-
96  graphics/gpu/simple_tri/source/3dmath.h
-
97  @include graphics/gpu/simple_tri/source/3dmath.h
-
98  graphics/gpu/simple_tri/source/3dmath.c
-
99  @include graphics/gpu/simple_tri/source/3dmath.c
-
100  graphics/gpu/simple_tri/source/vshader.pica
-
101  @include graphics/gpu/simple_tri/source/vshader.pica
-
102 
-
103 
-
104  * @example graphics/gpu/textured_cube/source/main.c
-
105  graphics/gpu/textured_cube/source/gpu.h
-
106  @include graphics/gpu/textured_cube/source/gpu.h
-
107  graphics/gpu/textured_cube/source/gpu.c
-
108  @include graphics/gpu/textured_cube/source/gpu.c
-
109  graphics/gpu/textured_cube/source/3dmath.h
-
110  @include graphics/gpu/textured_cube/source/3dmath.h
-
111  graphics/gpu/textured_cube/source/3dmath.c
-
112  @include graphics/gpu/textured_cube/source/3dmath.c
-
113  graphics/gpu/textured_cube/source/vshader.pica
-
114  @include graphics/gpu/textured_cube/source/vshader.pica
-
115 
-
116  * @example http/source/main.c
-
117  * @example input/read-controls/source/main.c
-
118  * @example input/touch-screen/source/main.c
-
119  * @example libapplet_launch/source/main.c
-
120  * @example mvd/source/main.c
-
121  * @example qtm/source/main.c
-
122  * @example sdmc/source/main.c
-
123  * @example threads/event/source/main.c
-
124  * @example time/rtc/source/main.c
-
125  */
-
126 
+
17 #include <3ds/os.h>
+
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/y2r.h>
+
53 #include <3ds/services/hb.h>
+
54 
+
55 #include <3ds/gpu/gx.h>
+
56 #include <3ds/gpu/gpu.h>
+
57 #include <3ds/gpu/gpu-old.h>
+
58 #include <3ds/gpu/shbin.h>
+
59 #include <3ds/gpu/shaderProgram.h>
+
60 
+
61 #include <3ds/ndsp/ndsp.h>
+
62 #include <3ds/ndsp/channel.h>
+
63 
+
64 #include <3ds/sdmc.h>
+
65 #include <3ds/romfs.h>
+
66 
+
67 #ifdef __cplusplus
+
68 }
+
69 #endif
+
70 /**
+
71  * @example app_launch/source/main.c
+
72  * @example audio/mic/source/main.c
+
73  * @example get_system_language/source/main.c
+
74  * @example graphics/bitmap/24bit-color/source/main.c
+
75  * @example graphics/printing/hello-world/source/main.c
+
76  * @example graphics/printing/both-screen-text/source/main.c
+
77  * @example graphics/printing/colored-text/source/main.c
+
78  * @example graphics/printing/multiple-windows-text/source/main.c
+
79 
+
80  * @example graphics/gpu/geoshader/source/main.c
+
81  graphics/gpu/geoshader/source/gpu.h
+
82  @include graphics/gpu/geoshader/source/gpu.h
+
83  graphics/gpu/geoshader/source/gpu.c
+
84  @include graphics/gpu/geoshader/source/gpu.c
+
85  graphics/gpu/geoshader/source/3dmath.h
+
86  @include graphics/gpu/geoshader/source/3dmath.h
+
87  graphics/gpu/geoshader/source/3dmath.c
+
88  @include graphics/gpu/geoshader/source/3dmath.c
+
89  graphics/gpu/geoshader/source/vshader.pica
+
90  @include graphics/gpu/geoshader/source/vshader.pica
+
91  graphics/gpu/geoshader/source/gshader.pica
+
92  @include graphics/gpu/geoshader/source/gshader.pica
+
93 
+
94 
+
95  * @example graphics/gpu/simple_tri/source/main.c
+
96  graphics/gpu/simple_tri/source/gpu.h
+
97  @include graphics/gpu/simple_tri/source/gpu.h
+
98  graphics/gpu/simple_tri/source/gpu.c
+
99  @include graphics/gpu/simple_tri/source/gpu.c
+
100  graphics/gpu/simple_tri/source/3dmath.h
+
101  @include graphics/gpu/simple_tri/source/3dmath.h
+
102  graphics/gpu/simple_tri/source/3dmath.c
+
103  @include graphics/gpu/simple_tri/source/3dmath.c
+
104  graphics/gpu/simple_tri/source/vshader.pica
+
105  @include graphics/gpu/simple_tri/source/vshader.pica
+
106 
+
107 
+
108  * @example graphics/gpu/textured_cube/source/main.c
+
109  graphics/gpu/textured_cube/source/gpu.h
+
110  @include graphics/gpu/textured_cube/source/gpu.h
+
111  graphics/gpu/textured_cube/source/gpu.c
+
112  @include graphics/gpu/textured_cube/source/gpu.c
+
113  graphics/gpu/textured_cube/source/3dmath.h
+
114  @include graphics/gpu/textured_cube/source/3dmath.h
+
115  graphics/gpu/textured_cube/source/3dmath.c
+
116  @include graphics/gpu/textured_cube/source/3dmath.c
+
117  graphics/gpu/textured_cube/source/vshader.pica
+
118  @include graphics/gpu/textured_cube/source/vshader.pica
+
119 
+
120  * @example http/source/main.c
+
121  * @example input/read-controls/source/main.c
+
122  * @example input/touch-screen/source/main.c
+
123  * @example libapplet_launch/source/main.c
+
124  * @example mvd/source/main.c
+
125  * @example qtm/source/main.c
+
126  * @example sdmc/source/main.c
+
127  * @example threads/event/source/main.c
+
128  * @example time/rtc/source/main.c
+
129  */
+
130 
+
GSPLCD service.
Functions for working with shaders.
Various system types.
+
PTMSYSM service.
Shader binary support.
MVD service.
PS service.
+
GSPGPU service.
HID service.
DSP Service to access the DSP processor commands (sound)
CFGNOR service.
@@ -228,7 +235,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
NEWS (Notification) service.
IRRST service.
PM (Process Manager) service.
-
PTM service.
QTM service.
Deprecated GPU functions which should not be used in new code.
Linear memory allocator.
@@ -240,7 +246,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Barebones GPU communications driver.
UTF conversion functions.
RomFS driver.
-
GSP service.
HTTP service.
APT (Applet) service.
OS related stuff.
@@ -252,6 +257,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Y2R service for hardware YUV->RGB conversions.
HB (Homebrew) service.
CAM service for using the 3DS's front and back cameras.
+
PTMU service.
+
Mappable memory allocator.
Inter Process Communication helpers.
GX commands.
Interface for Nintendo's default DSP component.
diff --git a/ac_8h.html b/ac_8h.html index 415c4d1..08d2dbe 100644 --- a/ac_8h.html +++ b/ac_8h.html @@ -108,13 +108,13 @@ Functions void acExit (void)  Exits AC.
  + +Result acWaitInternetConnection (void) + Waits for the system to connect to the internet.
Result ACU_GetWifiStatus (u32 *out)  Gets the current Wifi status. More...
  - -Result ACU_WaitInternetConnection (void) - Waits for the system to connect to the internet.

Detailed Description

AC service.

diff --git a/ac_8h_source.html b/ac_8h_source.html index 677b24e..b93636b 100644 --- a/ac_8h_source.html +++ b/ac_8h_source.html @@ -102,19 +102,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
10 /// Exits AC.
11 void acExit(void);
12 
-
13 /**
-
14  * @brief Gets the current Wifi status.
-
15  * @param out Pointer to output the current Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
-
16  */
- -
18 
-
19 /// Waits for the system to connect to the internet.
- +
13 /// Waits for the system to connect to the internet.
+ +
15 
+
16 /**
+
17  * @brief Gets the current Wifi status.
+
18  * @param out Pointer to output the current Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
+
19  */
+
s32 Result
Function result.
Definition: types.h:43
Result acInit(void)
Initializes AC.
void acExit(void)
Exits AC.
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
-
Result ACU_WaitInternetConnection(void)
Waits for the system to connect to the internet.
+
Result acWaitInternetConnection(void)
Waits for the system to connect to the internet.
Result ACU_GetWifiStatus(u32 *out)
Gets the current Wifi status.
diff --git a/annotated.html b/annotated.html index 2e08a99..857961a 100644 --- a/annotated.html +++ b/annotated.html @@ -117,9 +117,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  CFS_archiveFS archive  CFS_direntDirectory entry  CFS_pathFS path - CGSP_CaptureInfoCapture info - CGSP_CaptureInfoEntryCapture info entry - CGSP_FramebufferInfoFramebuffer information + CGSPGPU_CaptureInfoCapture info + CGSPGPU_CaptureInfoEntryCapture info entry + CGSPGPU_FramebufferInfoFramebuffer information  Chostent  ChttpcContextHTTP context  Cin_addr @@ -127,7 +127,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  Clinger  CMapEventEvent relating to the mapping of memory  CMemInfoMemory information - CmvdstdConfigProcessing configuration + CMVDSTD_ConfigProcessing configuration  CndspAdpcmDataADPCM data  CndspWaveBufWave buffer struct  COutputStringEventEvent relating to debug output @@ -135,8 +135,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  Cpollfd  CPrintConsoleConsole structure used to store the state of a console render context  CProcessEventEvent relating to a process - CqtmHeadtrackingInfoHead tracking info - CqtmHeadtrackingInfoCoordHead tracking coordinate pair + CQTM_HeadTrackingInfoHead tracking info + CQTM_HeadTrackingInfoCoordHead tracking coordinate pair  Crbtree_node_tAn rbtree node  Crbtree_tAn rbtree  CRecursiveLockA recursive lock @@ -151,9 +151,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  Csockaddr_storage  CSyscallInOutEventEvent relating to syscalls  CtouchPositionTouch position - CY2R_ColorCoefficientsCoefficients of the YUV->RGB conversion formula - CY2R_ConversionParamsStructure used to configure all parameters at once - CY2R_DitheringWeightParamsDithering weights + CY2RU_ColorCoefficientsCoefficients of the YUV->RGB conversion formula + CY2RU_ConversionParamsStructure used to configure all parameters at once + CY2RU_DitheringWeightParamsDithering weights diff --git a/app_launch_2source_2main_8c-example.html b/app_launch_2source_2main_8c-example.html index a752475..b7a2eae 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);
@@ -121,7 +121,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
// Flush + swap framebuffers and wait for VBlank. Not really needed in this example
gfxFlushBuffers();
gfxSwapBuffers();
-
gspWaitForVBlank();
+
gspWaitForVBlank();
}
diff --git a/apt_8h.html b/apt_8h.html index 9ae3feb..5b21b97 100644 --- a/apt_8h.html +++ b/apt_8h.html @@ -122,10 +122,10 @@ Macros - - - + + +

Typedefs

-typedef void(* aptHookFn) (int hook, void *param)
 APT hook function.
 
+typedef void(* aptHookFn) (APT_HookType hook, void *param)
 APT hook function.
 
@@ -173,65 +173,65 @@ Enumerations } - - + } + - - + } + - - + } +

Enumerations

 NS Application IDs. More...
 
enum  APP_STATUS {
-  APP_NOTINITIALIZED, +
enum  APT_AppStatus {
+  APP_NOTINITIALIZED,
-  APP_RUNNING, +  APP_RUNNING,
-  APP_SUSPENDED, +  APP_SUSPENDED,
-  APP_EXITING, +  APP_EXITING,
-  APP_SUSPENDING, +  APP_SUSPENDING,
-  APP_SLEEPMODE, +  APP_SLEEPMODE,
-  APP_PREPARE_SLEEPMODE, +  APP_PREPARE_SLEEPMODE,
-  APP_APPLETSTARTED, +  APP_APPLETSTARTED,
-  APP_APPLETCLOSED +  APP_APPLETCLOSED
- }
 App status values. More...
 
 App status values. More...
 
enum  {
-  APTSIGNAL_HOMEBUTTON = 1, +
enum  APT_Signal {
+  APTSIGNAL_HOMEBUTTON = 1,
-  APTSIGNAL_PREPARESLEEP = 3, +  APTSIGNAL_PREPARESLEEP = 3,
-  APTSIGNAL_ENTERSLEEP = 5, +  APTSIGNAL_ENTERSLEEP = 5,
-  APTSIGNAL_WAKEUP = 6, +  APTSIGNAL_WAKEUP = 6,
-  APTSIGNAL_ENABLE = 7, +  APTSIGNAL_ENABLE = 7,
-  APTSIGNAL_POWERBUTTON = 8, +  APTSIGNAL_POWERBUTTON = 8,
-  APTSIGNAL_UTILITY = 9, +  APTSIGNAL_UTILITY = 9,
-  APTSIGNAL_SLEEPSYSTEM = 10, +  APTSIGNAL_SLEEPSYSTEM = 10,
-  APTSIGNAL_ERROR = 11 +  APTSIGNAL_ERROR = 11
- }
 APT signals. More...
 
 APT signals. More...
 
enum  {
-  APTHOOK_ONSUSPEND = 0, +
enum  APT_HookType {
+  APTHOOK_ONSUSPEND = 0,
-  APTHOOK_ONRESTORE, +  APTHOOK_ONRESTORE,
-  APTHOOK_ONSLEEP, +  APTHOOK_ONSLEEP,
-  APTHOOK_ONWAKEUP, +  APTHOOK_ONWAKEUP,
-  APTHOOK_ONEXIT, +  APTHOOK_ONEXIT,
-  APTHOOK_COUNT +  APTHOOK_COUNT
- }
 APT hook types. More...
 
 APT hook types. More...
 
- - - - - - + + + + + + @@ -281,7 +281,7 @@ void  - + @@ -331,9 +331,9 @@ void  - - - + + + @@ -411,121 +411,121 @@ Variables

Detailed Description

APT (Applet) service.

Enumeration Type Documentation

- +

@@ -252,12 +252,12 @@ void 

aptCloseSession (void)
 Closes an APT session.
 
void aptSetStatus (APP_STATUS status)
 Sets the app's status. More...
 
APP_STATUS aptGetStatus (void)
 Gets the app's status. More...
 
void aptSetStatus (APT_AppStatus status)
 Sets the app's status. More...
 
APT_AppStatus aptGetStatus (void)
 Gets the app's status. More...
 
u32 aptGetStatusPower (void)
 Gets the app's power status. More...
 
bool aptMainLoop (void)
 Processes the current APT status. More...
 
void aptHook (aptHookCookie *cookie, aptHookFn callback, void *param)
void aptHook (aptHookCookie *cookie, aptHookFn callback, void *param)
 Sets up an APT status hook. More...
 
void aptUnhook (aptHookCookie *cookie)
Result APT_IsRegistered (NS_APPID appID, u8 *out)
 Gets whether an application is registered. More...
 
Result APT_InquireNotification (u32 appID, u8 *signalType)
 Inquires as to whether a signal has been received. More...
 
Result APT_InquireNotification (u32 appID, APT_Signal *signalType)
 Inquires as to whether a signal has been received. More...
 
Result APT_NotifyToWait (NS_APPID appID)
 Notifies an application to wait. More...
 
- +
anonymous enumenum APT_AppStatus
-

APT signals.

+

App status values.

- - - - - - - - -
Enumerator
APTSIGNAL_HOMEBUTTON  -

Home button pressed.

+
Enumerator
APP_NOTINITIALIZED  +

App not initialized.

APTSIGNAL_PREPARESLEEP  -

Prepare to enter sleep mode.

+
APP_RUNNING  +

App running.

APTSIGNAL_ENTERSLEEP  -

Enter sleep mode.

+
APP_SUSPENDED  +

App suspended.

APTSIGNAL_WAKEUP  -

Wake from sleep mode.

+
APP_EXITING  +

App exiting.

APTSIGNAL_ENABLE  -

Enable.

+
APP_SUSPENDING  +

App suspending.

APTSIGNAL_POWERBUTTON  -

Power button pressed.

+
APP_SLEEPMODE  +

App in sleep mode.

APTSIGNAL_UTILITY  -

Utility called.

+
APP_PREPARE_SLEEPMODE  +

App preparing to enter sleep mode.

APTSIGNAL_SLEEPSYSTEM  -

System sleeping.

+
APP_APPLETSTARTED  +

Applet started.

APTSIGNAL_ERROR  -

Error occurred.

+
APP_APPLETCLOSED  +

Applet closed.

- +
- +
anonymous enumenum APT_HookType

APT hook types.

- - - - - -
Enumerator
APTHOOK_ONSUSPEND  +
Enumerator
APTHOOK_ONSUSPEND 

App suspended.

APTHOOK_ONRESTORE  +
APTHOOK_ONRESTORE 

App restored.

APTHOOK_ONSLEEP  +
APTHOOK_ONSLEEP 

App sleeping.

APTHOOK_ONWAKEUP  +
APTHOOK_ONWAKEUP 

App waking up.

APTHOOK_ONEXIT  +
APTHOOK_ONEXIT 

App exiting.

APTHOOK_COUNT  +
APTHOOK_COUNT 

Number of APT hook types.

- +
- +
enum APP_STATUSenum APT_Signal
-

App status values.

+

APT signals.

- - - - - - - - -
Enumerator
APP_NOTINITIALIZED  -

App not initialized.

+
Enumerator
APTSIGNAL_HOMEBUTTON  +

Home button pressed.

APP_RUNNING  -

App running.

+
APTSIGNAL_PREPARESLEEP  +

Prepare to enter sleep mode.

APP_SUSPENDED  -

App suspended.

+
APTSIGNAL_ENTERSLEEP  +

Enter sleep mode.

APP_EXITING  -

App exiting.

+
APTSIGNAL_WAKEUP  +

Wake from sleep mode.

APP_SUSPENDING  -

App suspending.

+
APTSIGNAL_ENABLE  +

Enable.

APP_SLEEPMODE  -

App in sleep mode.

+
APTSIGNAL_POWERBUTTON  +

Power button pressed.

APP_PREPARE_SLEEPMODE  -

App preparing to enter sleep mode.

+
APTSIGNAL_UTILITY  +

Utility called.

APP_APPLETSTARTED  -

Applet started.

+
APTSIGNAL_SLEEPSYSTEM  +

System sleeping.

APP_APPLETCLOSED  -

Applet closed.

+
APTSIGNAL_ERROR  +

Error occurred.

@@ -1235,7 +1235,7 @@ Variables
- +
@@ -1248,7 +1248,7 @@ Variables - + @@ -1956,12 +1956,12 @@ Variables - +
u8APT_Signal signalType 
- + @@ -2007,7 +2007,7 @@ Variables - + @@ -2052,7 +2052,7 @@ Variables

Processes the current APT status.

Generally used within a main loop.

Returns
Whether the application is closing.
-
Examples:
app_launch/source/main.c, audio/mic/source/main.c, get_system_language/source/main.c, graphics/bitmap/24bit-color/source/main.c, graphics/gpu/geoshader/source/main.c, graphics/gpu/simple_tri/source/main.c, graphics/gpu/textured_cube/source/main.c, graphics/printing/both-screen-text/source/main.c, graphics/printing/colored-text/source/main.c, graphics/printing/hello-world/source/main.c, graphics/printing/multiple-windows-text/source/main.c, http/source/main.c, input/read-controls/source/main.c, input/touch-screen/source/main.c, libapplet_launch/source/main.c, mvd/source/main.c, qtm/source/main.c, sdmc/source/main.c, threads/event/source/main.c, and time/rtc/source/main.c.
+
Examples:
app_launch/source/main.c, audio/mic/source/main.c, get_system_language/source/main.c, graphics/bitmap/24bit-color/source/main.c, graphics/gpu/geoshader/source/main.c, graphics/gpu/simple_tri/source/main.c, graphics/gpu/textured_cube/source/main.c, graphics/printing/both-screen-text/source/main.c, graphics/printing/colored-text/source/main.c, graphics/printing/hello-world/source/main.c, graphics/printing/multiple-windows-text/source/main.c, http/source/main.c, input/read-controls/source/main.c, input/touch-screen/source/main.c, libapplet_launch/source/main.c, mvd/source/main.c, qtm/source/main.c, sdmc/source/main.c, threads/event/source/main.c, and time/rtc/source/main.c.
@@ -2071,18 +2071,18 @@ Variables

Triggers a return to the home menu.

-

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.

+

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.

- +
APP_STATUS aptGetStatus APT_AppStatus aptGetStatus ( void  )
aptHookFn aptHookFn  callback,
- + diff --git a/apt_8h_source.html b/apt_8h_source.html index c004d0b..816970d 100644 --- a/apt_8h_source.html +++ b/apt_8h_source.html @@ -107,7 +107,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
15  *
16  * Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs
17  */
-
18 typedef enum{
+
18 typedef enum {
19  APPID_HOMEMENU = 0x101, ///< Home Menu
20  APPID_CAMERA = 0x110, ///< Camera applet
21  APPID_FRIENDS_LIST = 0x112, ///< Friends List applet
@@ -128,55 +128,55 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
36  APPID_MINT = 0x407, ///< mint
37  APPID_EXTRAPAD = 0x408, ///< extrapad
38  APPID_MEMOLIB = 0x409, ///< memolib
-
39 }NS_APPID;
+
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.
-
52 }APP_STATUS;
+
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 enum {
-
56  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
+
55 typedef enum {
+
56  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
57  // 2: sleep-mode related?
-
58  APTSIGNAL_PREPARESLEEP = 3, ///< Prepare to enter sleep mode.
+
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 };
+
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 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.
+
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.
76 
-
77  APTHOOK_COUNT, ///< Number of APT hook types.
-
78 };
+
77  APTHOOK_COUNT, ///< Number of APT hook types.
+
78 } APT_HookType;
79 
80 /// APT hook function.
-
81 typedef void (*aptHookFn)(int hook, void* param);
+
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.
+
87  aptHookFn callback; ///< Hook callback.
88  void* param; ///< Callback parameter.
90 
@@ -199,13 +199,13 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
107  * @brief Sets the app's status.
108  * @param status Status to set.
109  */
-
110 void aptSetStatus(APP_STATUS status);
+
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.
@@ -251,7 +251,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
159  * @param callback Function to call when APT's status changes.
160  * @param param User-defined parameter to pass to the callback.
161  */
-
162 void aptHook(aptHookCookie* cookie, aptHookFn callback, void* param);
+
162 void aptHook(aptHookCookie* cookie, aptHookFn callback, void* param);
163 
164 /**
165  * @brief Removes an APT status hook.
@@ -370,7 +370,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
278  * @param appID ID of the application.
279  * @param signalType Pointer to output the signal type to.
280  */
-
281 Result APT_InquireNotification(u32 appID, u8* signalType);
+
281 Result APT_InquireNotification(u32 appID, APT_Signal* signalType);
282 
283 /**
284  * @brief Notifies an application to wait.
@@ -545,113 +545,115 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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
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:43
-
Number of APT hook types.
Definition: apt.h:77
Result APT_DoAppJump(u32 NSbuf0Size, u32 NSbuf1Size, u8 *NSbuf0Ptr, u8 *NSbuf1Ptr)
Performs an application jump.
void aptOpenSession(void)
Opens an APT session.
-
Prepare to enter sleep mode.
Definition: apt.h:58
+
Enter sleep mode.
Definition: apt.h:60
APT hook cookie.
Definition: apt.h:84
+
System sleeping.
Definition: apt.h:65
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
uint16_t u16
16-bit unsigned integer
Definition: types.h:23
-
App suspended.
Definition: apt.h:71
+
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
Result aptInit(void)
Initializes APT.
void aptHook(aptHookCookie *cookie, aptHookFn callback, void *param)
Sets up an APT status hook.
-
App running.
Definition: apt.h:44
Friends List applet.
Definition: apt.h:21
-
App sleeping.
Definition: apt.h:73
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.
-
App not initialized.
Definition: apt.h:43
struct tag_aptHookCookie * next
Next cookie.
Definition: apt.h:86
Instruction Manual applet.
Definition: apt.h:24
+
APT_AppStatus aptGetStatus(void)
Gets the app's status.
u32 Handle
Resource handle.
Definition: types.h:42
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
NS_APPID aptGetMenuAppID(void)
Gets the menu's app ID.
-
Applet closed.
Definition: apt.h:51
+
App waking up.
Definition: apt.h:74
+
App running.
Definition: apt.h:44
Notifications applet.
Definition: apt.h:25
Result APT_JumpToHomeMenu(const u8 *param, size_t paramSize, Handle handle)
Jumps to the home menu.
-
void(* aptHookFn)(int hook, void *param)
APT hook function.
Definition: apt.h:81
-
Wake from sleep mode.
Definition: apt.h:61
uint8_t u8
8-bit unsigned integer
Definition: types.h:22
+
Power button pressed.
Definition: apt.h:63
Miiverse posting applet (solv3)
Definition: apt.h:27
Result APT_ReceiveParameter(NS_APPID appID, u32 bufferSize, u32 *buffer, u32 *actualSize, u8 *signalType)
Receives a parameter.
+
Home button pressed.
Definition: apt.h:56
uint64_t u64
64-bit unsigned integer
Definition: types.h:25
-
App suspending.
Definition: apt.h:47
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 preparing to enter sleep mode.
Definition: apt.h:49
+
App not initialized.
Definition: apt.h:43
Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf)
Starts a system applet.
Miiverse applet (olv)
Definition: apt.h:26
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
Handle aptEvents[3]
APT events.
-
Error occurred.
Definition: apt.h:66
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
+
void aptSetStatus(APT_AppStatus status)
Sets the app's status.
void aptCloseSession(void)
Closes an APT session.
-
App restored.
Definition: apt.h:72
-
System sleeping.
Definition: apt.h:65
+
App exiting.
Definition: apt.h:46
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
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
Result APT_PrepareToJumpToApplication(u32 a)
Prepares to jump to an application.
-
Power button pressed.
Definition: apt.h:63
-
void aptSetStatus(APP_STATUS status)
Sets the app's status.
-
Utility called.
Definition: apt.h:64
+
Error occurred.
Definition: apt.h:66
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
Result APT_GetAppCpuTimeLimit(u32 *percent)
Gets the application's CPU time limit.
void * param
Callback parameter.
Definition: apt.h:88
-
App waking up.
Definition: apt.h:74
Game Notes applet.
Definition: apt.h:22
-
App exiting.
Definition: apt.h:46
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
Result APT_AppletUtility(u32 *out, u32 a, u32 size1, u8 *buf1, u32 size2, u8 *buf2)
Calls an applet utility function.
-
APP_STATUS
App status values.
Definition: apt.h:42
-
Result APT_InquireNotification(u32 appID, u8 *signalType)
Inquires as to whether a signal has been received.
-
Enter sleep mode.
Definition: apt.h:60
+
Utility called.
Definition: apt.h:64
+
Wake from sleep mode.
Definition: apt.h:61
memolib
Definition: apt.h:38
Result APT_HardwareResetAsync(void)
Asynchronously resets the hardware.
-
APP_STATUS aptGetStatus(void)
Gets the app's status.
+
Applet closed.
Definition: apt.h:51
Internet Browser.
Definition: apt.h:23
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
Result APT_Finalize(NS_APPID appId)
Terminates an application's registration with APT.
appletEd
Definition: apt.h:32
Result APT_LaunchLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize)
Launches a library applet.
-
Applet started.
Definition: apt.h:50
-
Home button pressed.
Definition: apt.h:56
-
App suspended.
Definition: apt.h:45
+
App suspended.
Definition: apt.h:45
PNOTE_AP.
Definition: apt.h:33
Result APT_GetAppletProgramInfo(u32 id, u32 flags, u16 *titleversion)
Gets an applet's program information.
-
App in sleep mode.
Definition: apt.h:48
Result APT_CheckNew3DS(u8 *out)
Checks whether the system is a New 3DS.
+
App in sleep mode.
Definition: apt.h:48
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
-
Enable.
Definition: apt.h:62
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.
-
App exiting.
Definition: apt.h:75
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
void aptReturnToMenu(void)
Triggers a return to the home menu.
+
App suspending.
Definition: apt.h:47
void aptSetStatus (APP_STATUS APT_AppStatus  status)
- - + } + - - + } + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + @@ -524,9 +524,9 @@ Functions - - - + + + @@ -538,15 +538,15 @@ Functions Result  - - - - - - - - - + + + + + + + + + @@ -554,40 +554,68 @@ Functions

Detailed Description

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

Enumeration Type Documentation

- +

Enumerations

enum  CAMU_Port {
-  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  CAMU_CameraSelect {
-  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, @@ -365,150 +365,150 @@ Functions
void camExit (void)
 Closes the cam service. More...
 
Result CAMU_StartCapture (CAMU_Port port)
 Begins capture on the specified camera port. More...
 
Result CAMU_StopCapture (CAMU_Port port)
 Terminates capture on the specified camera port. More...
 
Result CAMU_IsBusy (bool *busy, CAMU_Port port)
 Gets whether the specified camera port is busy. More...
 
Result CAMU_ClearBuffer (CAMU_Port port)
 Clears the buffer and error flags of the specified camera port. More...
 
Result CAMU_GetVsyncInterruptEvent (Handle *event, CAMU_Port port)
 Gets a handle to the event signaled on vsync interrupts. More...
 
Result CAMU_GetBufferErrorInterruptEvent (Handle *event, CAMU_Port port)
 Gets a handle to the event signaled on camera buffer errors. More...
 
Result CAMU_SetReceiving (Handle *event, void *dst, CAMU_Port port, u32 imageSize, s16 transferUnit)
 Initiates the process of receiving a camera frame. More...
 
Result CAMU_IsFinishedReceiving (bool *finishedReceiving, CAMU_Port port)
 Gets whether the specified camera port has finished receiving image data. More...
 
Result CAMU_SetTransferLines (CAMU_Port port, s16 lines, s16 width, s16 height)
 Sets the number of lines to transfer into an image buffer. More...
 
Result CAMU_StartCapture (u32 port)
 Begins capture on the specified camera port. More...
 
Result CAMU_StopCapture (u32 port)
 Terminates capture on the specified camera port. More...
 
Result CAMU_IsBusy (bool *busy, u32 port)
 Gets whether the specified camera port is busy. More...
 
Result CAMU_ClearBuffer (u32 port)
 Clears the buffer and error flags of the specified camera port. More...
 
Result CAMU_GetVsyncInterruptEvent (Handle *event, u32 port)
 Gets a handle to the event signaled on vsync interrupts. More...
 
Result CAMU_GetBufferErrorInterruptEvent (Handle *event, u32 port)
 Gets a handle to the event signaled on camera buffer errors. More...
 
Result CAMU_SetReceiving (Handle *event, void *dst, u32 port, u32 imageSize, s16 transferUnit)
 Initiates the process of receiving a camera frame. More...
 
Result CAMU_IsFinishedReceiving (bool *finishedReceiving, u32 port)
 Gets whether the specified camera port has finished receiving image data. More...
 
Result CAMU_SetTransferLines (u32 port, s16 lines, s16 width, s16 height)
 Sets the number of lines to transfer into an image buffer. More...
 
Result CAMU_GetMaxLines (s16 *maxLines, s16 width, s16 height)
 Gets the maximum number of lines that can be saved to an image buffer. More...
 
Result CAMU_SetTransferBytes (CAMU_Port port, u32 bytes, s16 width, s16 height)
 Sets the number of bytes to transfer into an image buffer. More...
 
Result CAMU_GetTransferBytes (u32 *transferBytes, CAMU_Port port)
 Gets the number of bytes to transfer into an image buffer. More...
 
Result CAMU_SetTransferBytes (u32 port, u32 bytes, s16 width, s16 height)
 Sets the number of bytes to transfer into an image buffer. More...
 
Result CAMU_GetTransferBytes (u32 *transferBytes, u32 port)
 Gets the number of bytes to transfer into an image buffer. More...
 
Result CAMU_GetMaxBytes (u32 *maxBytes, s16 width, s16 height)
 Gets the maximum number of bytes that can be saved to an image buffer. More...
 
Result CAMU_SetTrimming (CAMU_Port port, bool trimming)
 Sets whether image trimming is enabled. More...
 
Result CAMU_IsTrimming (bool *trimming, CAMU_Port port)
 Gets whether image trimming is enabled. More...
 
Result CAMU_SetTrimmingParams (CAMU_Port port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd)
 Sets the parameters used for trimming images. More...
 
Result CAMU_GetTrimmingParams (s16 *xStart, s16 *yStart, s16 *xEnd, s16 *yEnd, CAMU_Port port)
 Gets the parameters used for trimming images. More...
 
Result CAMU_SetTrimmingParamsCenter (CAMU_Port port, s16 trimWidth, s16 trimHeight, s16 camWidth, s16 camHeight)
 Sets the parameters used for trimming images, relative to the center of the image. More...
 
Result CAMU_Activate (CAMU_CameraSelect select)
 Activates the specified camera. More...
 
Result CAMU_SwitchContext (CAMU_CameraSelect select, CAMU_Context context)
 Switches the specified camera's active context. More...
 
Result CAMU_SetExposure (CAMU_CameraSelect select, s8 exposure)
 Sets the exposure value of the specified camera. More...
 
Result CAMU_SetWhiteBalance (CAMU_CameraSelect select, CAMU_WhiteBalance whiteBalance)
 Sets the white balance mode of the specified camera. More...
 
Result CAMU_SetWhiteBalanceWithoutBaseUp (CAMU_CameraSelect select, CAMU_WhiteBalance whiteBalance)
 Sets the white balance mode of the specified camera. More...
 
Result CAMU_SetSharpness (CAMU_CameraSelect select, s8 sharpness)
 Sets the sharpness of the specified camera. More...
 
Result CAMU_SetAutoExposure (CAMU_CameraSelect select, bool autoExposure)
 Sets whether auto exposure is enabled on the specified camera. More...
 
Result CAMU_IsAutoExposure (bool *autoExposure, CAMU_CameraSelect select)
 Gets whether auto exposure is enabled on the specified camera. More...
 
Result CAMU_SetAutoWhiteBalance (CAMU_CameraSelect select, bool autoWhiteBalance)
 Sets whether auto white balance is enabled on the specified camera. More...
 
Result CAMU_IsAutoWhiteBalance (bool *autoWhiteBalance, CAMU_CameraSelect select)
 Gets whether auto white balance is enabled on the specified camera. More...
 
Result CAMU_FlipImage (CAMU_CameraSelect select, CAMU_Flip flip, CAMU_Context context)
 Flips the image of the specified camera in the specified context. More...
 
Result CAMU_SetDetailSize (CAMU_CameraSelect 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. More...
 
Result CAMU_SetSize (CAMU_CameraSelect select, CAMU_Size size, CAMU_Context context)
 Sets the image resolution of the given camera in the given context. More...
 
Result CAMU_SetFrameRate (CAMU_CameraSelect select, CAMU_FrameRate frameRate)
 Sets the frame rate of the given camera. More...
 
Result CAMU_SetPhotoMode (CAMU_CameraSelect select, CAMU_PhotoMode photoMode)
 Sets the photo mode of the given camera. More...
 
Result CAMU_SetEffect (CAMU_CameraSelect select, CAMU_Effect effect, CAMU_Context context)
 Sets the special effects of the given camera in the given context. More...
 
Result CAMU_SetContrast (CAMU_CameraSelect select, CAMU_Contrast contrast)
 Sets the contrast mode of the given camera. More...
 
Result CAMU_SetLensCorrection (CAMU_CameraSelect select, CAMU_LensCorrection lensCorrection)
 Sets the lens correction mode of the given camera. More...
 
Result CAMU_SetOutputFormat (CAMU_CameraSelect select, CAMU_OutputFormat format, CAMU_Context context)
 Sets the output format of the given camera in the given context. More...
 
Result CAMU_SetAutoExposureWindow (CAMU_CameraSelect select, s16 x, s16 y, s16 width, s16 height)
 Sets the region to base auto exposure off of for the specified camera. More...
 
Result CAMU_SetAutoWhiteBalanceWindow (CAMU_CameraSelect select, s16 x, s16 y, s16 width, s16 height)
 Sets the region to base auto white balance off of for the specified camera. More...
 
Result CAMU_SetNoiseFilter (CAMU_CameraSelect select, bool noiseFilter)
 Sets whether the specified camera's noise filter is enabled. More...
 
Result CAMU_SynchronizeVsyncTiming (CAMU_CameraSelect select1, CAMU_CameraSelect select2)
 Synchronizes the specified cameras' vsync timing. More...
 
Result CAMU_GetLatestVsyncTiming (s64 *timing, CAMU_Port port, u32 past)
 Gets the vsync timing record of the specified camera for the specified number of signals. More...
 
Result CAMU_SetTrimming (u32 port, bool trimming)
 Sets whether image trimming is enabled. More...
 
Result CAMU_IsTrimming (bool *trimming, u32 port)
 Gets whether image trimming is enabled. More...
 
Result CAMU_SetTrimmingParams (u32 port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd)
 Sets the parameters used for trimming images. More...
 
Result CAMU_GetTrimmingParams (s16 *xStart, s16 *yStart, s16 *xEnd, s16 *yEnd, u32 port)
 Gets the parameters used for trimming images. More...
 
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. More...
 
Result CAMU_Activate (u32 select)
 Activates the specified camera. More...
 
Result CAMU_SwitchContext (u32 select, CAMU_Context context)
 Switches the specified camera's active context. More...
 
Result CAMU_SetExposure (u32 select, s8 exposure)
 Sets the exposure value of the specified camera. More...
 
Result CAMU_SetWhiteBalance (u32 select, CAMU_WhiteBalance whiteBalance)
 Sets the white balance mode of the specified camera. More...
 
Result CAMU_SetWhiteBalanceWithoutBaseUp (u32 select, CAMU_WhiteBalance whiteBalance)
 Sets the white balance mode of the specified camera. More...
 
Result CAMU_SetSharpness (u32 select, s8 sharpness)
 Sets the sharpness of the specified camera. More...
 
Result CAMU_SetAutoExposure (u32 select, bool autoExposure)
 Sets whether auto exposure is enabled on the specified camera. More...
 
Result CAMU_IsAutoExposure (bool *autoExposure, u32 select)
 Gets whether auto exposure is enabled on the specified camera. More...
 
Result CAMU_SetAutoWhiteBalance (u32 select, bool autoWhiteBalance)
 Sets whether auto white balance is enabled on the specified camera. More...
 
Result CAMU_IsAutoWhiteBalance (bool *autoWhiteBalance, u32 select)
 Gets whether auto white balance is enabled on the specified camera. More...
 
Result CAMU_FlipImage (u32 select, CAMU_Flip flip, CAMU_Context context)
 Flips the image of the specified camera in the specified context. More...
 
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. More...
 
Result CAMU_SetSize (u32 select, CAMU_Size size, CAMU_Context context)
 Sets the image resolution of the given camera in the given context. More...
 
Result CAMU_SetFrameRate (u32 select, CAMU_FrameRate frameRate)
 Sets the frame rate of the given camera. More...
 
Result CAMU_SetPhotoMode (u32 select, CAMU_PhotoMode photoMode)
 Sets the photo mode of the given camera. More...
 
Result CAMU_SetEffect (u32 select, CAMU_Effect effect, CAMU_Context context)
 Sets the special effects of the given camera in the given context. More...
 
Result CAMU_SetContrast (u32 select, CAMU_Contrast contrast)
 Sets the contrast mode of the given camera. More...
 
Result CAMU_SetLensCorrection (u32 select, CAMU_LensCorrection lensCorrection)
 Sets the lens correction mode of the given camera. More...
 
Result CAMU_SetOutputFormat (u32 select, CAMU_OutputFormat format, CAMU_Context context)
 Sets the output format of the given camera in the given context. More...
 
Result CAMU_SetAutoExposureWindow (u32 select, s16 x, s16 y, s16 width, s16 height)
 Sets the region to base auto exposure off of for the specified camera. More...
 
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. More...
 
Result CAMU_SetNoiseFilter (u32 select, bool noiseFilter)
 Sets whether the specified camera's noise filter is enabled. More...
 
Result CAMU_SynchronizeVsyncTiming (u32 select1, u32 select2)
 Synchronizes the specified cameras' vsync timing. More...
 
Result CAMU_GetLatestVsyncTiming (s64 *timing, u32 port, u32 past)
 Gets the vsync timing record of the specified camera for the specified number of signals. More...
 
Result CAMU_GetStereoCameraCalibrationData (CAMU_StereoCameraCalibrationData *data)
 Gets the specified camera's stereo camera calibration data. More...
 
Result CAMU_SetStereoCameraCalibrationData (CAMU_StereoCameraCalibrationData data)
 Sets the specified camera's stereo camera calibration data. More...
 
Result CAMU_WriteRegisterI2c (CAMU_CameraSelect select, u16 addr, u16 data)
 Writes to the specified I2C register of the specified camera. More...
 
Result CAMU_WriteMcuVariableI2c (CAMU_CameraSelect select, u16 addr, u16 data)
 Writes to the specified MCU variable of the specified camera. More...
 
Result CAMU_ReadRegisterI2cExclusive (u16 *data, CAMU_CameraSelect select, u16 addr)
 Reads the specified I2C register of the specified camera. More...
 
Result CAMU_ReadMcuVariableI2cExclusive (u16 *data, CAMU_CameraSelect select, u16 addr)
 Reads the specified MCU variable of the specified camera. More...
 
Result CAMU_WriteRegisterI2c (u32 select, u16 addr, u16 data)
 Writes to the specified I2C register of the specified camera. More...
 
Result CAMU_WriteMcuVariableI2c (u32 select, u16 addr, u16 data)
 Writes to the specified MCU variable of the specified camera. More...
 
Result CAMU_ReadRegisterI2cExclusive (u16 *data, u32 select, u16 addr)
 Reads the specified I2C register of the specified camera. More...
 
Result CAMU_ReadMcuVariableI2cExclusive (u16 *data, u32 select, u16 addr)
 Reads the specified MCU variable of the specified camera. More...
 
Result CAMU_SetImageQualityCalibrationData (CAMU_ImageQualityCalibrationData data)
 Sets the specified camera's image quality calibration data. More...
 
Result CAMU_SetPackageParameterWithContextDetail (CAMU_PackageParameterContextDetail param)
 Configures a camera with pre-packaged configuration data without a context and extra resolution details. More...
 
Result CAMU_GetSuitableY2rStandardCoefficient (Y2R_StandardCoefficient *coefficient)
 Gets the Y2R coefficient applied to image data by the camera. More...
 
Result CAMU_GetSuitableY2rStandardCoefficient (Y2RU_StandardCoefficient *coefficient)
 Gets the Y2R coefficient applied to image data by the camera. More...
 
Result CAMU_PlayShutterSound (CAMU_ShutterSoundType sound)
 Plays the specified shutter sound. More...
 
CAMU_DriverFinalize (void)
 Finalizes the camera driver.
 
Result CAMU_GetActivatedCamera (CAMU_CameraSelect *select)
 Gets the current activated camera. More...
 
Result CAMU_GetSleepCamera (CAMU_CameraSelect *select)
 Gets the current sleep camera. More...
 
Result CAMU_SetSleepCamera (CAMU_CameraSelect select)
 Sets the current sleep camera. More...
 
Result CAMU_GetActivatedCamera (u32 *select)
 Gets the current activated camera. More...
 
Result CAMU_GetSleepCamera (u32 *select)
 Gets the current sleep camera. More...
 
Result CAMU_SetSleepCamera (u32 select)
 Sets the current sleep camera. More...
 
Result CAMU_SetBrightnessSynchronization (bool brightnessSynchronization)
 Sets whether to enable synchronization of left and right camera brightnesses. More...
 
- + + +
enum CAMU_CameraSelectanonymous enum
+
+ +

Camera connection target ports.

+ + + + + +
Enumerator
PORT_NONE  +

No port.

+
PORT_CAM1  +

CAM1 port.

+
PORT_CAM2  +

CAM2 port.

+
PORT_BOTH  +

Both ports.

+
+ +
+
+ +
+
+ + +
anonymous enum

Camera combinations.

- - - - - - - -
Enumerator
SELECT_NONE  +
Enumerator
SELECT_NONE 

No camera.

SELECT_OUT1  +
SELECT_OUT1 

Outer camera 1.

SELECT_IN1  +
SELECT_IN1 

Inner camera 1.

SELECT_OUT2  +
SELECT_OUT2 

Outer camera 2.

SELECT_IN1_OUT1  +
SELECT_IN1_OUT1 

Outer camera 1 and inner camera 1.

SELECT_OUT1_OUT2  +
SELECT_OUT1_OUT2 

Both outer cameras.

SELECT_IN1_OUT2  +
SELECT_IN1_OUT2 

Inner camera 1 and outer camera 2.

SELECT_ALL  +
SELECT_ALL 

All cameras.

@@ -882,34 +910,6 @@ Functions -
-
- -
-
- - - - -
enum CAMU_Port
-
- -

Camera connection target ports.

- - - - - -
Enumerator
PORT_NONE  -

No port.

-
PORT_CAM1  -

CAM1 port.

-
PORT_CAM2  -

CAM2 port.

-
PORT_BOTH  -

Both ports.

-
-
@@ -1053,14 +1053,14 @@ Functions - +
- + @@ -1077,14 +1077,14 @@ Functions - +
Result CAMU_Activate (CAMU_CameraSelect u32  select)
- + @@ -1101,14 +1101,14 @@ Functions - +
Result CAMU_ClearBuffer (CAMU_Port u32  port)
- + @@ -1143,14 +1143,14 @@ Functions - +
Result CAMU_FlipImage (CAMU_CameraSelect u32  select,
- + @@ -1167,7 +1167,7 @@ Functions - +
Result CAMU_GetActivatedCamera (CAMU_CameraSelectu32 select)
@@ -1180,7 +1180,7 @@ Functions - + @@ -1226,7 +1226,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1239,7 +1239,7 @@ Functions - + @@ -1352,14 +1352,14 @@ Functions - +
CAMU_Port u32  port,
- + @@ -1400,14 +1400,14 @@ Functions - +
Result CAMU_GetSleepCamera (CAMU_CameraSelectu32 select)
- + @@ -1424,7 +1424,7 @@ Functions - +
Result CAMU_GetSuitableY2rStandardCoefficient (Y2R_StandardCoefficientY2RU_StandardCoefficient coefficient)
@@ -1437,7 +1437,7 @@ Functions - + @@ -1459,7 +1459,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1490,7 +1490,7 @@ Functions - + @@ -1515,7 +1515,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1528,7 +1528,7 @@ Functions - + @@ -1550,7 +1550,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1563,7 +1563,7 @@ Functions - + @@ -1585,7 +1585,7 @@ Functions - +
CAMU_CameraSelect u32  select 
@@ -1598,7 +1598,7 @@ Functions - + @@ -1620,7 +1620,7 @@ Functions - +
CAMU_CameraSelect u32  select 
@@ -1633,7 +1633,7 @@ Functions - + @@ -1655,7 +1655,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1668,7 +1668,7 @@ Functions - + @@ -1690,7 +1690,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1703,7 +1703,7 @@ Functions - + @@ -1749,7 +1749,7 @@ Functions - +
CAMU_Port u32  port 
@@ -1762,7 +1762,7 @@ Functions - + @@ -1791,7 +1791,7 @@ Functions - +
CAMU_CameraSelect u32  select,
@@ -1804,7 +1804,7 @@ Functions - + @@ -1833,14 +1833,14 @@ Functions - +
CAMU_CameraSelect u32  select,
- + @@ -1868,14 +1868,14 @@ Functions - +
Result CAMU_SetAutoExposure (CAMU_CameraSelect u32  select,
- + @@ -1924,14 +1924,14 @@ Functions - +
Result CAMU_SetAutoExposureWindow (CAMU_CameraSelect u32  select,
- + @@ -1959,14 +1959,14 @@ Functions - +
Result CAMU_SetAutoWhiteBalance (CAMU_CameraSelect u32  select,
- + @@ -2039,14 +2039,14 @@ Functions - +
Result CAMU_SetAutoWhiteBalanceWindow (CAMU_CameraSelect u32  select,
- + @@ -2074,14 +2074,14 @@ Functions - +
Result CAMU_SetContrast (CAMU_CameraSelect u32  select,
- + @@ -2151,14 +2151,14 @@ Functions - +
Result CAMU_SetDetailSize (CAMU_CameraSelect u32  select,
- + @@ -2193,14 +2193,14 @@ Functions - +
Result CAMU_SetEffect (CAMU_CameraSelect u32  select,
- + @@ -2228,14 +2228,14 @@ Functions - +
Result CAMU_SetExposure (CAMU_CameraSelect u32  select,
- + @@ -2287,14 +2287,14 @@ Functions - +
Result CAMU_SetFrameRate (CAMU_CameraSelect u32  select,
- + @@ -2322,14 +2322,14 @@ Functions - +
Result CAMU_SetLensCorrection (CAMU_CameraSelect u32  select,
- + @@ -2357,14 +2357,14 @@ Functions - +
Result CAMU_SetNoiseFilter (CAMU_CameraSelect u32  select,
- + @@ -2471,14 +2471,14 @@ Functions - +
Result CAMU_SetOutputFormat (CAMU_CameraSelect u32  select,
- + @@ -2506,7 +2506,7 @@ Functions - +
Result CAMU_SetPhotoMode (CAMU_CameraSelect u32  select,
@@ -2525,7 +2525,7 @@ Functions - + @@ -2562,14 +2562,14 @@ Functions - +
CAMU_Port u32  port,
- + @@ -2597,14 +2597,14 @@ Functions - +
Result CAMU_SetSharpness (CAMU_CameraSelect u32  select,
- + @@ -2639,14 +2639,14 @@ Functions - +
Result CAMU_SetSize (CAMU_CameraSelect u32  select,
- + @@ -2687,14 +2687,14 @@ Functions - +
Result CAMU_SetSleepCamera (CAMU_CameraSelect u32  select)
- + @@ -2736,14 +2736,14 @@ Functions - +
Result CAMU_SetTransferBytes (CAMU_Port u32  port,
- + @@ -2785,14 +2785,14 @@ Functions - +
Result CAMU_SetTransferLines (CAMU_Port u32  port,
- + @@ -2820,14 +2820,14 @@ Functions - +
Result CAMU_SetTrimming (CAMU_Port u32  port,
- + @@ -2876,14 +2876,14 @@ Functions - +
Result CAMU_SetTrimmingParams (CAMU_Port u32  port,
- + @@ -2932,14 +2932,14 @@ Functions - +
Result CAMU_SetTrimmingParamsCenter (CAMU_Port u32  port,
- + @@ -2967,14 +2967,14 @@ Functions - +
Result CAMU_SetWhiteBalance (CAMU_CameraSelect u32  select,
- + @@ -3002,14 +3002,14 @@ Functions - +
Result CAMU_SetWhiteBalanceWithoutBaseUp (CAMU_CameraSelect u32  select,
- + @@ -3026,14 +3026,14 @@ Functions - +
Result CAMU_StartCapture (CAMU_Port u32  port)
- + @@ -3050,14 +3050,14 @@ Functions - +
Result CAMU_StopCapture (CAMU_Port u32  port)
- + @@ -3085,20 +3085,20 @@ Functions - +
Result CAMU_SwitchContext (CAMU_CameraSelect u32  select,
- + - + @@ -3120,14 +3120,14 @@ Functions - +
Result CAMU_SynchronizeVsyncTiming (CAMU_CameraSelect u32  select1,
CAMU_CameraSelect u32  select2 
- + @@ -3162,14 +3162,14 @@ Functions - +
Result CAMU_WriteMcuVariableI2c (CAMU_CameraSelect u32  select,
- + diff --git a/cam_8h_source.html b/cam_8h_source.html index f39734e..e445d7e 100644 --- a/cam_8h_source.html +++ b/cam_8h_source.html @@ -100,28 +100,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
8 #include <3ds/types.h>
9 
10 /// Camera connection target ports.
-
11 typedef enum {
-
12  PORT_NONE = 0x0, ///< No port.
-
13  PORT_CAM1 = BIT(0), ///< CAM1 port.
-
14  PORT_CAM2 = BIT(1), ///< CAM2 port.
+
11 enum {
+
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.
-
18 } CAMU_Port;
+
17  PORT_BOTH = PORT_CAM1 | PORT_CAM2, ///< Both ports.
+
18 };
19 
20 /// Camera combinations.
-
21 typedef 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.
+
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.
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.
35 typedef enum {
@@ -292,7 +292,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
200 
201 /// Batch camera configuration for use without a context.
202 typedef struct {
-
203  u8 camera; ///< #CAMU_CameraSelect Selected camera.
+
203  u8 camera; ///< Selected camera.
204  s8 exposure; ///< Camera exposure.
205  u8 whiteBalance; ///< #CAMU_WhiteBalance Camera white balance.
206  s8 sharpness; ///< Camera sharpness.
@@ -316,7 +316,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
224 
225 /// Batch camera configuration for use with a context.
226 typedef struct {
-
227  u8 camera; ///< #CAMU_CameraSelect Selected camera.
+
227  u8 camera; ///< Selected camera.
228  u8 context; ///< #CAMU_Context Selected context.
229  u8 flip; ///< #CAMU_Flip Camera image flip mode.
230  u8 effect; ///< #CAMU_Effect Camera image special effects.
@@ -325,7 +325,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
233 
234 /// Batch camera configuration for use with a context and with detailed size information.
235 typedef struct {
-
236  u8 camera; ///< #CAMU_CameraSelect Selected camera.
+
236  u8 camera; ///< Selected camera.
237  u8 context; ///< #CAMU_Context Selected context.
238  u8 flip; ///< #CAMU_Flip Camera image flip mode.
239  u8 effect; ///< #CAMU_Effect Camera image special effects.
@@ -355,40 +355,40 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
263  * Begins capture on the specified camera port.
264  * @param port Port to begin capture on.
265  */
- +
267 
268 /**
269  * Terminates capture on the specified camera port.
270  * @param port Port to terminate capture on.
271  */
- +
273 
274 /**
275  * @brief Gets whether the specified camera port is busy.
276  * @param busy Pointer to output the busy state to.
277  * @param port Port to check.
278  */
-
279 Result CAMU_IsBusy(bool* busy, CAMU_Port port);
+
279 Result CAMU_IsBusy(bool* busy, u32 port);
280 
281 /**
282  * @brief Clears the buffer and error flags of the specified camera port.
283  * @param port Port to clear.
284  */
- +
286 
287 /**
288  * @brief Gets a handle to the event signaled on vsync interrupts.
289  * @param event Pointer to output the event handle to.
290  * @param port Port to use.
291  */
- +
293 
294 /**
295  * @brief Gets a handle to the event signaled on camera buffer errors.
296  * @param event Pointer to output the event handle to.
297  * @param port Port to use.
298  */
- +
300 
301 /**
302  * @brief Initiates the process of receiving a camera frame.
@@ -398,14 +398,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
306  * @param imageSize Size of the image to receive.
307  * @param transferUnit Transfer unit to use when receiving.
308  */
-
309 Result CAMU_SetReceiving(Handle* event, void* dst, CAMU_Port port, u32 imageSize, s16 transferUnit);
+
309 Result CAMU_SetReceiving(Handle* event, void* dst, u32 port, u32 imageSize, s16 transferUnit);
310 
311 /**
312  * @brief Gets whether the specified camera port has finished receiving image data.
313  * @param finishedReceiving Pointer to output the receiving status to.
314  * @param port Port to check.
315  */
-
316 Result CAMU_IsFinishedReceiving(bool* finishedReceiving, CAMU_Port port);
+
316 Result CAMU_IsFinishedReceiving(bool* finishedReceiving, u32 port);
317 
318 /**
319  * @brief Sets the number of lines to transfer into an image buffer.
@@ -414,7 +414,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
322  * @param width Width of the image.
323  * @param height Height of the image.
324  */
-
325 Result CAMU_SetTransferLines(CAMU_Port port, s16 lines, s16 width, s16 height);
+
325 Result CAMU_SetTransferLines(u32 port, s16 lines, s16 width, s16 height);
326 
327 /**
328  * @brief Gets the maximum number of lines that can be saved to an image buffer.
@@ -431,14 +431,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
339  * @param width Width of the image.
340  * @param height Height of the image.
341  */
-
342 Result CAMU_SetTransferBytes(CAMU_Port port, u32 bytes, s16 width, s16 height);
+
342 Result CAMU_SetTransferBytes(u32 port, u32 bytes, s16 width, s16 height);
343 
344 /**
345  * @brief Gets the number of bytes to transfer into an image buffer.
346  * @param transferBytes Pointer to write the number of bytes to.
347  * @param port Port to use.
348  */
-
349 Result CAMU_GetTransferBytes(u32* transferBytes, CAMU_Port port);
+
349 Result CAMU_GetTransferBytes(u32* transferBytes, u32 port);
350 
351 /**
352  * @brief Gets the maximum number of bytes that can be saved to an image buffer.
@@ -453,14 +453,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
361  * @param port Port to use.
362  * @param trimming Whether image trimming is enabled.
363  */
-
364 Result CAMU_SetTrimming(CAMU_Port port, bool trimming);
+
364 Result CAMU_SetTrimming(u32 port, bool trimming);
365 
366 /**
367  * @brief Gets whether image trimming is enabled.
368  * @param trimming Pointer to output the trim state to.
369  * @param port Port to use.
370  */
-
371 Result CAMU_IsTrimming(bool* trimming, CAMU_Port port);
+
371 Result CAMU_IsTrimming(bool* trimming, u32 port);
372 
373 /**
374  * @brief Sets the parameters used for trimming images.
@@ -470,7 +470,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
378  * @param xEnd End X coordinate.
379  * @param yEnd End Y coordinate.
380  */
-
381 Result CAMU_SetTrimmingParams(CAMU_Port port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd);
+
381 Result CAMU_SetTrimmingParams(u32 port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd);
382 
383 /**
384  * @brief Gets the parameters used for trimming images.
@@ -480,7 +480,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
388  * @param yEnd Pointer to write the end Y coordinate to.
389  * @param port Port to use.
390  */
-
391 Result CAMU_GetTrimmingParams(s16* xStart, s16* yStart, s16* xEnd, s16* yEnd, CAMU_Port port);
+
391 Result CAMU_GetTrimmingParams(s16* xStart, s16* yStart, s16* xEnd, s16* yEnd, u32 port);
392 
393 /**
394  * @brief Sets the parameters used for trimming images, relative to the center of the image.
@@ -490,34 +490,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
398  * @param camWidth Camera width.
399  * @param camHeight Camera height.
400  */
-
401 Result CAMU_SetTrimmingParamsCenter(CAMU_Port port, s16 trimWidth, s16 trimHeight, s16 camWidth, s16 camHeight);
+
401 Result CAMU_SetTrimmingParamsCenter(u32 port, s16 trimWidth, s16 trimHeight, s16 camWidth, s16 camHeight);
402 
403 /**
404  * @brief Activates the specified camera.
405  * @param select Camera to use.
406  */
- +
407 Result CAMU_Activate(u32 select);
408 
409 /**
410  * @brief Switches the specified camera's active context.
411  * @param select Camera to use.
412  * @param context Context to use.
413  */
- +
414 Result CAMU_SwitchContext(u32 select, CAMU_Context context);
415 
416 /**
417  * @brief Sets the exposure value of the specified camera.
418  * @param select Camera to use.
419  * @param exposure Exposure value to use.
420  */
-
421 Result CAMU_SetExposure(CAMU_CameraSelect select, s8 exposure);
+
421 Result CAMU_SetExposure(u32 select, s8 exposure);
422 
423 /**
424  * @brief Sets the white balance mode of the specified camera.
425  * @param select Camera to use.
426  * @param whiteBalance White balance mode to use.
427  */
- +
428 Result CAMU_SetWhiteBalance(u32 select, CAMU_WhiteBalance whiteBalance);
429 
430 /**
431  * @brief Sets the white balance mode of the specified camera.
@@ -525,42 +525,42 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
433  * @param select Camera to use.
434  * @param whiteBalance White balance mode to use.
435  */
- +
437 
438 /**
439  * @brief Sets the sharpness of the specified camera.
440  * @param select Camera to use.
441  * @param sharpness Sharpness to use.
442  */
-
443 Result CAMU_SetSharpness(CAMU_CameraSelect select, s8 sharpness);
+
443 Result CAMU_SetSharpness(u32 select, s8 sharpness);
444 
445 /**
446  * @brief Sets whether auto exposure is enabled on the specified camera.
447  * @param select Camera to use.
448  * @param autoWhiteBalance Whether auto exposure is enabled.
449  */
-
450 Result CAMU_SetAutoExposure(CAMU_CameraSelect select, bool autoExposure);
+
450 Result CAMU_SetAutoExposure(u32 select, bool autoExposure);
451 
452 /**
453  * @brief Gets whether auto exposure is enabled on the specified camera.
454  * @param autoExposure Pointer to output the auto exposure state to.
455  * @param select Camera to use.
456  */
-
457 Result CAMU_IsAutoExposure(bool* autoExposure, CAMU_CameraSelect select);
+
457 Result CAMU_IsAutoExposure(bool* autoExposure, u32 select);
458 
459 /**
460  * @brief Sets whether auto white balance is enabled on the specified camera.
461  * @param select Camera to use.
462  * @param autoWhiteBalance Whether auto white balance is enabled.
463  */
-
464 Result CAMU_SetAutoWhiteBalance(CAMU_CameraSelect select, bool autoWhiteBalance);
+
464 Result CAMU_SetAutoWhiteBalance(u32 select, bool autoWhiteBalance);
465 
466 /**
467  * @brief Gets whether auto white balance is enabled on the specified camera.
468  * @param autoWhiteBalance Pointer to output the auto white balance state to.
469  * @param select Camera to use.
470  */
-
471 Result CAMU_IsAutoWhiteBalance(bool* autoWhiteBalance, CAMU_CameraSelect select);
+
471 Result CAMU_IsAutoWhiteBalance(bool* autoWhiteBalance, u32 select);
472 
473 /**
474  * @brief Flips the image of the specified camera in the specified context.
@@ -568,7 +568,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
476  * @param flip Flip mode to use.
477  * @param context Context to use.
478  */
- +
479 Result CAMU_FlipImage(u32 select, CAMU_Flip flip, CAMU_Context context);
480 
481 /**
482  * @brief Sets the image resolution of the given camera in the given context, in detail.
@@ -581,7 +581,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
489  * @param cropY1 Second crop point Y.
490  * @param context Context to use.
491  */
-
492 Result CAMU_SetDetailSize(CAMU_CameraSelect select, s16 width, s16 height, s16 cropX0, s16 cropY0, s16 cropX1, s16 cropY1, CAMU_Context context);
+
492 Result CAMU_SetDetailSize(u32 select, s16 width, s16 height, s16 cropX0, s16 cropY0, s16 cropX1, s16 cropY1, CAMU_Context context);
493 
494 /**
495  * @brief Sets the image resolution of the given camera in the given context.
@@ -589,21 +589,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
497  * @param size Size to use.
498  * @param context Context to use.
499  */
- +
500 Result CAMU_SetSize(u32 select, CAMU_Size size, CAMU_Context context);
501 
502 /**
503  * @brief Sets the frame rate of the given camera.
504  * @param select Camera to use.
505  * @param frameRate Frame rate to use.
506  */
- +
507 Result CAMU_SetFrameRate(u32 select, CAMU_FrameRate frameRate);
508 
509 /**
510  * @brief Sets the photo mode of the given camera.
511  * @param select Camera to use.
512  * @param photoMode Photo mode to use.
513  */
- +
514 Result CAMU_SetPhotoMode(u32 select, CAMU_PhotoMode photoMode);
515 
516 /**
517  * @brief Sets the special effects of the given camera in the given context.
@@ -611,21 +611,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
519  * @param effect Effect to use.
520  * @param context Context to use.
521  */
- +
522 Result CAMU_SetEffect(u32 select, CAMU_Effect effect, CAMU_Context context);
523 
524 /**
525  * @brief Sets the contrast mode of the given camera.
526  * @param select Camera to use.
527  * @param contrast Contrast mode to use.
528  */
- +
529 Result CAMU_SetContrast(u32 select, CAMU_Contrast contrast);
530 
531 /**
532  * @brief Sets the lens correction mode of the given camera.
533  * @param select Camera to use.
534  * @param lensCorrection Lens correction mode to use.
535  */
- +
536 Result CAMU_SetLensCorrection(u32 select, CAMU_LensCorrection lensCorrection);
537 
538 /**
539  * @brief Sets the output format of the given camera in the given context.
@@ -633,7 +633,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
541  * @param format Format to output.
542  * @param context Context to use.
543  */
- +
545 
546 /**
547  * @brief Sets the region to base auto exposure off of for the specified camera.
@@ -643,7 +643,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
551  * @param width Width of the region.
552  * @param height Height of the region.
553  */
-
554 Result CAMU_SetAutoExposureWindow(CAMU_CameraSelect select, s16 x, s16 y, s16 width, s16 height);
+
554 Result CAMU_SetAutoExposureWindow(u32 select, s16 x, s16 y, s16 width, s16 height);
555 
556 /**
557  * @brief Sets the region to base auto white balance off of for the specified camera.
@@ -653,21 +653,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
561  * @param width Width of the region.
562  * @param height Height of the region.
563  */
- +
564 Result CAMU_SetAutoWhiteBalanceWindow(u32 select, s16 x, s16 y, s16 width, s16 height);
565 
566 /**
567  * @brief Sets whether the specified camera's noise filter is enabled.
568  * @param select Camera to use.
569  * @param noiseFilter Whether the noise filter is enabled.
570  */
-
571 Result CAMU_SetNoiseFilter(CAMU_CameraSelect select, bool noiseFilter);
+
571 Result CAMU_SetNoiseFilter(u32 select, bool noiseFilter);
572 
573 /**
574  * @brief Synchronizes the specified cameras' vsync timing.
575  * @param select1 First camera.
576  * @param select2 Second camera.
577  */
- +
578 Result CAMU_SynchronizeVsyncTiming(u32 select1, u32 select2);
579 
580 /**
581  * @brief Gets the vsync timing record of the specified camera for the specified number of signals.
@@ -675,7 +675,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
583  * @param port Port to use.
584  * @param past Number of past timings to retrieve.
585  */
-
586 Result CAMU_GetLatestVsyncTiming(s64* timing, CAMU_Port port, u32 past);
+
586 Result CAMU_GetLatestVsyncTiming(s64* timing, u32 port, u32 past);
587 
588 /**
589  * @brief Gets the specified camera's stereo camera calibration data.
@@ -695,7 +695,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
603  * @param addr Address to write to.
604  * @param data Data to write.
605  */
- +
606 Result CAMU_WriteRegisterI2c(u32 select, u16 addr, u16 data);
607 
608 /**
609  * @brief Writes to the specified MCU variable of the specified camera.
@@ -703,7 +703,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
611  * @param addr Address to write to.
612  * @param data Data to write.
613  */
- +
614 Result CAMU_WriteMcuVariableI2c(u32 select, u16 addr, u16 data);
615 
616 /**
617  * @brief Reads the specified I2C register of the specified camera.
@@ -711,7 +711,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
619  * @param select Camera to read from.
620  * @param addr Address to read.
621  */
- +
622 Result CAMU_ReadRegisterI2cExclusive(u16* data, u32 select, u16 addr);
623 
624 /**
625  * @brief Reads the specified MCU variable of the specified camera.
@@ -719,7 +719,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
627  * @param select Camera to read from.
628  * @param addr Address to read.
629  */
- +
630 Result CAMU_ReadMcuVariableI2cExclusive(u16* data, u32 select, u16 addr);
631 
632 /**
633  * @brief Sets the specified camera's image quality calibration data.
@@ -755,7 +755,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
663  * @brief Gets the Y2R coefficient applied to image data by the camera.
664  * @param coefficient Pointer to output the Y2R coefficient to.
665  */
- +
667 
668 /**
669  * @brief Plays the specified shutter sound.
@@ -773,19 +773,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
681  * @brief Gets the current activated camera.
682  * @param select Pointer to output the current activated camera to.
683  */
- +
685 
686 /**
687  * @brief Gets the current sleep camera.
688  * @param select Pointer to output the current sleep camera to.
689  */
- +
691 
692 /**
693  * @brief Sets the current sleep camera.
694  * @param select Camera to set.
695  */
- +
697 
698 /**
699  * @brief Sets whether to enable synchronization of left and right camera brightnesses.
@@ -793,45 +793,46 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
701  */
702 Result CAMU_SetBrightnessSynchronization(bool brightnessSynchronization);
703 
-
Both outer cameras.
Definition: cam.h:29
-
Result CAMU_SetLensCorrection(CAMU_CameraSelect select, CAMU_LensCorrection lensCorrection)
Sets the lens correction mode of the given camera.
-
Result CAMU_GetTransferBytes(u32 *transferBytes, CAMU_Port port)
Gets the number of bytes to transfer into an image buffer.
s16 autoWhiteBalanceWindowWidth
Width of the region to use for auto white balance.
Definition: cam.h:221
-
Inner camera 1.
Definition: cam.h:24
s16 autoExposureWindowHeight
Height of the region to use for auto exposure.
Definition: cam.h:218
s16 imageWidth
Image width.
Definition: cam.h:196
15-10 FPS.
Definition: cam.h:79
-
Result CAMU_ReadMcuVariableI2cExclusive(u16 *data, CAMU_CameraSelect select, u16 addr)
Reads the specified MCU variable of the specified camera.
-
Result CAMU_WriteMcuVariableI2c(CAMU_CameraSelect select, u16 addr, u16 data)
Writes to the specified MCU variable of the specified camera.
+
Result CAMU_WriteMcuVariableI2c(u32 select, u16 addr, u16 data)
Writes to the specified MCU variable of the specified camera.
int8_t s8
8-bit signed integer
Definition: types.h:27
-
Result CAMU_SetSize(CAMU_CameraSelect select, CAMU_Size size, CAMU_Context context)
Sets the image resolution of the given camera in the given context.
-
Result CAMU_IsAutoExposure(bool *autoExposure, CAMU_CameraSelect select)
Gets whether auto exposure is enabled on the specified camera.
+
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.
+
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
-
Inner camera 1 and outer camera 2.
Definition: cam.h:30
Batch camera configuration for use with a context.
Definition: cam.h:226
s16 imageHeight
Image height.
Definition: cam.h:197
s32 Result
Function result.
Definition: types.h:43
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
-
Result CAMU_SwitchContext(CAMU_CameraSelect select, CAMU_Context context)
Switches the specified camera's active context.
CAMU_FrameRate
Camera capture frame rates.
Definition: cam.h:68
-
Y2R_StandardCoefficient
Preset conversion coefficients based on ITU standards for the YUV->RGB formula.
Definition: y2r.h:88
8.5 FPS.
Definition: cam.h:73
u8 contrast
CAMU_Contrast Camera contrast.
Definition: cam.h:211
-
u8 camera
CAMU_CameraSelect Selected camera.
Definition: cam.h:203
+
u8 camera
Selected camera.
Definition: cam.h:203
6000K white balance.
Definition: cam.h:90
s16 autoWhiteBalanceWindowX
X of the region to use for auto white balance.
Definition: cam.h:219
-
Result CAMU_WriteRegisterI2c(CAMU_CameraSelect select, u16 addr, u16 data)
Writes to the specified I2C register of the specified camera.
+
Result CAMU_SetWhiteBalance(u32 select, CAMU_WhiteBalance whiteBalance)
Sets the white balance mode of the specified camera.
15 FPS.
Definition: cam.h:69
+
Result CAMU_SetAutoExposureWindow(u32 select, s16 x, s16 y, s16 width, s16 height)
Sets the region to base auto exposure off of for the specified camera.
+
Result CAMU_Activate(u32 select)
Activates the specified camera.
uint16_t u16
16-bit unsigned integer
Definition: types.h:23
+
Result CAMU_ReadMcuVariableI2cExclusive(u16 *data, u32 select, u16 addr)
Reads the specified MCU variable of the specified camera.
s16 autoWhiteBalanceWindowHeight
Height of the region to use for auto white balance.
Definition: cam.h:222
Horizontal flip.
Definition: cam.h:47
CAMU_Flip
Ways to flip the camera image.
Definition: cam.h:45
@@ -844,47 +845,48 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Stereo camera calibration data.
Definition: cam.h:183
Context A.
Definition: cam.h:37
Both contexts.
Definition: cam.h:41
+
Result CAMU_GetActivatedCamera(u32 *select)
Gets the current activated camera.
float translationX
X axis translation to match the left camera image with the right.
Definition: cam.h:188
10 FPS.
Definition: cam.h:72
CAMU_OutputFormat
Camera image output formats.
Definition: cam.h:155
+
Result CAMU_FlipImage(u32 select, CAMU_Flip flip, CAMU_Context context)
Flips the image of the specified camera in the specified context.
u8 lensCorrection
CAMU_LensCorrection Camera lens correction.
Definition: cam.h:212
CAMU_ShutterSoundType
Camera shutter sounds.
Definition: cam.h:161
s16 kGL
Left color correction matrix green normalization coefficient.
Definition: cam.h:171
u16 awbX0Left
Left camera, color correction matrix position threshold.
Definition: cam.h:179
-
Result CAMU_ReadRegisterI2cExclusive(u16 *data, CAMU_CameraSelect select, u16 addr)
Reads the specified I2C register of the specified camera.
Normal mode.
Definition: cam.h:105
Result CAMU_SetPackageParameterWithoutContext(CAMU_PackageParameterCameraSelect param)
Configures a camera with pre-packaged configuration data without a context.
-
Outer camera 1 and inner camera 1.
Definition: cam.h:28
Result CAMU_DriverInitialize(void)
Initializes the camera driver.
-
Result CAMU_GetActivatedCamera(CAMU_CameraSelect *select)
Gets the current activated camera.
Landscape mode.
Definition: cam.h:107
u32 Handle
Resource handle.
Definition: types.h:42
+
Result CAMU_SetFrameRate(u32 select, CAMU_FrameRate frameRate)
Sets the frame rate of the given camera.
s16 kRL
Left color correction matrix red normalization coefficient.
Definition: cam.h:170
Letter mode.
Definition: cam.h:109
-
Result CAMU_SetPhotoMode(CAMU_CameraSelect select, CAMU_PhotoMode photoMode)
Sets the photo mode of the given camera.
+
Result CAMU_GetSuitableY2rStandardCoefficient(Y2RU_StandardCoefficient *coefficient)
Gets the Y2R coefficient applied to image data by the camera.
Result CAMU_SetBrightnessSynchronization(bool brightnessSynchronization)
Sets whether to enable synchronization of left and right camera brightnesses.
s16 cropX0
First crop point X.
Definition: cam.h:242
s16 ccmPosition
Color correction matrix position.
Definition: cam.h:173
+
Result CAMU_GetTrimmingParams(s16 *xStart, s16 *yStart, s16 *xEnd, s16 *yEnd, u32 port)
Gets the parameters used for trimming images.
Normal lens correction. (70)
Definition: cam.h:150
-
Result CAMU_SetAutoExposureWindow(CAMU_CameraSelect select, s16 x, s16 y, s16 width, s16 height)
Sets the region to base auto exposure off of for the specified camera.
u8 padding
Padding. (Aligns last 3 fields to 4 bytes)
Definition: cam.h:214
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
-
Result CAMU_Activate(CAMU_CameraSelect select)
Activates the specified camera.
+
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:22
-
CAM1 port.
Definition: cam.h:13
+
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
-
u8 camera
CAMU_CameraSelect Selected camera.
Definition: cam.h:236
+
u8 camera
Selected camera.
Definition: cam.h:236
u16 awbX0Right
Right camera, color correction matrix position threshold.
Definition: cam.h:178
s16 height
Image height.
Definition: cam.h:241
20-5 FPS.
Definition: cam.h:76
-
Result CAMU_FlipImage(CAMU_CameraSelect select, CAMU_Flip flip, CAMU_Context context)
Flips the image of the specified camera in the specified context.
s16 width
Image width.
Definition: cam.h:240
Negative film effect.
Definition: cam.h:118
Negative effect.
Definition: cam.h:117
-
Result CAMU_SetTransferBytes(CAMU_Port port, u32 bytes, s16 width, s16 height)
Sets the number of bytes to transfer into an image buffer.
Pattern 6.
Definition: cam.h:129
DS LCD size. (256x192)
Definition: cam.h:59
Pattern 2.
Definition: cam.h:125
@@ -897,110 +899,106 @@ 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:24
-
Result CAMU_IsTrimming(bool *trimming, CAMU_Port port)
Gets whether image trimming is enabled.
-
Result CAMU_StartCapture(CAMU_Port port)
Begins capture on the specified camera port.
+
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_GetTrimmingParams(s16 *xStart, s16 *yStart, s16 *xEnd, s16 *yEnd, CAMU_Port port)
Gets the parameters used for trimming images.
+
Result CAMU_IsAutoWhiteBalance(bool *autoWhiteBalance, u32 select)
Gets whether auto white balance is enabled on the specified camera.
DS LCD x4 size. (512x384)
Definition: cam.h:60
-
Result CAMU_SetTrimmingParams(CAMU_Port port, s16 xStart, s16 yStart, s16 xEnd, s16 yEnd)
Sets the parameters used for trimming images.
Result CAMU_DriverFinalize(void)
Finalizes the camera driver.
QVGA size. (320x240)
Definition: cam.h:55
Vertical flip.
Definition: cam.h:48
u8 whiteBalance
CAMU_WhiteBalance Camera white balance.
Definition: cam.h:205
-
Result CAMU_SetTransferLines(CAMU_Port port, s16 lines, s16 width, s16 height)
Sets the number of lines to transfer into an image buffer.
-
Result CAMU_SetExposure(CAMU_CameraSelect select, s8 exposure)
Sets the exposure value of the specified camera.
+
CAM1 port.
Definition: cam.h:13
30-5 FPS.
Definition: cam.h:78
-
Result CAMU_GetSuitableY2rStandardCoefficient(Y2R_StandardCoefficient *coefficient)
Gets the Y2R coefficient applied to image data by the camera.
-
CAMU_CameraSelect
Camera combinations.
Definition: cam.h:21
-
Result CAMU_SetNoiseFilter(CAMU_CameraSelect select, bool noiseFilter)
Sets whether the specified camera's noise filter is enabled.
+
Result CAMU_SetSleepCamera(u32 select)
Sets the current sleep camera.
+
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_SetFrameRate(CAMU_CameraSelect select, CAMU_FrameRate frameRate)
Sets the frame rate of the given camera.
-
No port.
Definition: cam.h:12
-
Result CAMU_SetDetailSize(CAMU_CameraSelect 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.
-
All cameras.
Definition: cam.h:31
-
Result CAMU_SetWhiteBalanceWithoutBaseUp(CAMU_CameraSelect select, CAMU_WhiteBalance whiteBalance)
Sets the white balance mode of the specified camera.
-
CAMU_Port
Camera connection target ports.
Definition: cam.h:11
+
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.
+
Result CAMU_SetSize(u32 select, CAMU_Size size, CAMU_Context context)
Sets the image resolution of the given camera in the given context.
+
Result CAMU_GetTransferBytes(u32 *transferBytes, u32 port)
Gets the number of bytes to transfer into an image buffer.
No lens correction.
Definition: cam.h:144
15-5 FPS.
Definition: cam.h:70
-
Result CAMU_SetContrast(CAMU_CameraSelect select, CAMU_Contrast contrast)
Sets the contrast mode of the given camera.
Result CAMU_GetMaxBytes(u32 *maxBytes, s16 width, s16 height)
Gets the maximum number of bytes that can be saved to an image buffer.
Normal shutter sound.
Definition: cam.h:162
u8 size
CAMU_Size Camera image resolution.
Definition: cam.h:231
-
Result CAMU_SetTrimming(CAMU_Port port, bool trimming)
Sets whether image trimming is enabled.
u8 noiseFilterOn
#bool Whether to enable the camera's noise filter.
Definition: cam.h:213
+
Result CAMU_SetAutoExposure(u32 select, bool autoExposure)
Sets whether auto exposure is enabled on the specified camera.
+
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
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
No context.
Definition: cam.h:36
+
Result CAMU_WriteRegisterI2c(u32 select, u16 addr, u16 data)
Writes to the specified I2C register of the specified camera.
u8 flip
CAMU_Flip Camera image flip mode.
Definition: cam.h:229
+
Result CAMU_StopCapture(u32 port)
Terminates capture on the specified camera port.
Shutter sound to end a movie.
Definition: cam.h:164
-
CAM2 port.
Definition: cam.h:14
float distanceToChart
Distance between cameras and measurement chart.
Definition: cam.h:194
CAMU_Context
Camera contexts.
Definition: cam.h:35
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.
u8 isValidRotationXY
#bool Whether the X and Y rotation data is valid.
Definition: cam.h:184
+
Result CAMU_SwitchContext(u32 select, CAMU_Context context)
Switches the specified camera's active context.
CAMU_PhotoMode
Camera photo modes.
Definition: cam.h:104
Pattern 1.
Definition: cam.h:124
-
Outer camera 2.
Definition: cam.h:25
Result CAMU_PlayShutterSound(CAMU_ShutterSoundType sound)
Plays the specified shutter sound.
-
Result CAMU_SynchronizeVsyncTiming(CAMU_CameraSelect select1, CAMU_CameraSelect select2)
Synchronizes the specified cameras' vsync timing.
u16 awbCcmL10Left
Left camera, left color correction matrix blue/green gain.
Definition: cam.h:177
-
Result CAMU_SetOutputFormat(CAMU_CameraSelect select, CAMU_OutputFormat format, CAMU_Context context)
Sets the output format of the given camera in the given context.
float distanceCameras
Distance between left and right cameras.
Definition: cam.h:195
#define BIT(n)
Creates a bitmask from a bit number.
Definition: types.h:47
-
Result CAMU_SetAutoWhiteBalanceWindow(CAMU_CameraSelect select, s16 x, s16 y, s16 width, s16 height)
Sets the region to base auto white balance off of for the specified camera.
CTR Top LCD size. (400x240)
Definition: cam.h:61
+
Result CAMU_GetBufferErrorInterruptEvent(Handle *event, u32 port)
Gets a handle to the event signaled on camera buffer errors.
Normal contrast. (6)
Definition: cam.h:138
Shutter sound to begin a movie.
Definition: cam.h:163
-
Outer camera 1.
Definition: cam.h:23
-
Both ports.
Definition: cam.h:17
u16 awbCcmL9Right
Right camera, left color correction matrix red/green gain.
Definition: cam.h:174
-
Result CAMU_SetWhiteBalance(CAMU_CameraSelect select, CAMU_WhiteBalance whiteBalance)
Sets the white balance mode of the specified camera.
CAMU_Size
Camera image resolutions.
Definition: cam.h:53
+
Result CAMU_SetWhiteBalanceWithoutBaseUp(u32 select, CAMU_WhiteBalance whiteBalance)
Sets the white balance mode of the specified camera.
int64_t s64
64-bit signed integer
Definition: types.h:30
-
Result CAMU_SetSharpness(CAMU_CameraSelect select, s8 sharpness)
Sets the sharpness of the specified camera.
-
Result CAMU_GetLatestVsyncTiming(s64 *timing, CAMU_Port port, u32 past)
Gets the vsync timing record of the specified camera for the specified number of signals.
Batch camera configuration for use with a context and with detailed size information.
Definition: cam.h:235
Result CAMU_SetImageQualityCalibrationData(CAMU_ImageQualityCalibrationData data)
Sets the specified camera's image quality calibration data.
-
Result CAMU_IsFinishedReceiving(bool *finishedReceiving, CAMU_Port port)
Gets whether the specified camera port has finished receiving image data.
+
Result CAMU_SetContrast(u32 select, CAMU_Contrast contrast)
Sets the contrast mode of the given camera.
Result CAMU_SetPackageParameterWithContext(CAMU_PackageParameterContext param)
Configures a camera with pre-packaged configuration data with a context.
Y2R service for hardware YUV->RGB conversions.
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
-
Result CAMU_SetEffect(CAMU_CameraSelect select, CAMU_Effect effect, CAMU_Context context)
Sets the special effects of the given camera in the given context.
-
Result CAMU_SetSleepCamera(CAMU_CameraSelect select)
Sets the current sleep camera.
+
Outer camera 1.
Definition: cam.h:23
5200K white balance.
Definition: cam.h:89
QCIF size. (176x144)
Definition: cam.h:58
Bright lens correction. (90)
Definition: cam.h:151
s16 autoExposureWindowY
Y of the region to use for auto exposure.
Definition: cam.h:216
+
Result CAMU_GetVsyncInterruptEvent(Handle *event, u32 port)
Gets a handle to the event signaled on vsync interrupts.
Sepia effect.
Definition: cam.h:119
-
Result CAMU_GetSleepCamera(CAMU_CameraSelect *select)
Gets the current sleep camera.
Batch camera configuration for use without a context.
Definition: cam.h:202
-
Result CAMU_IsBusy(bool *busy, CAMU_Port port)
Gets whether the specified camera port is busy.
Pattern 7.
Definition: cam.h:130
-
Result CAMU_SetAutoWhiteBalance(CAMU_CameraSelect select, bool autoWhiteBalance)
Sets whether auto white balance is enabled on the specified camera.
Pattern 10.
Definition: cam.h:133
-
Result CAMU_StopCapture(CAMU_Port port)
Terminates capture on the specified camera port.
+
Result CAMU_SetExposure(u32 select, s8 exposure)
Sets the exposure value of the specified camera.
CAMU_WhiteBalance
Camera white balance modes.
Definition: cam.h:85
+
Result CAMU_IsTrimming(bool *trimming, u32 port)
Gets whether image trimming is enabled.
+
Result CAMU_SetTransferBytes(u32 port, u32 bytes, s16 width, s16 height)
Sets the number of bytes to transfer into an image buffer.
+
Y2RU_StandardCoefficient
Preset conversion coefficients based on ITU standards for the YUV->RGB formula.
Definition: y2r.h:88
20-10 FPS.
Definition: cam.h:80
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
-
Result CAMU_SetTrimmingParamsCenter(CAMU_Port port, s16 trimWidth, s16 trimHeight, s16 camWidth, s16 camHeight)
Sets the parameters used for trimming images, relative to the center of the image.
-
Result CAMU_GetBufferErrorInterruptEvent(Handle *event, CAMU_Port port)
Gets a handle to the event signaled on camera buffer errors.
+
Result CAMU_SetNoiseFilter(u32 select, bool noiseFilter)
Sets whether the specified camera's noise filter is enabled.
Pattern 5.
Definition: cam.h:128
-
Result CAMU_ClearBuffer(CAMU_Port port)
Clears the buffer and error flags of the specified camera port.
-
Result CAMU_GetVsyncInterruptEvent(Handle *event, CAMU_Port port)
Gets a handle to the event signaled on vsync interrupts.
u8 autoExposureOn
#bool Whether to automatically determine the proper exposure.
Definition: cam.h:207
-
u8 camera
CAMU_CameraSelect Selected camera.
Definition: cam.h:227
+
u8 camera
Selected camera.
Definition: cam.h:227
s16 cropY1
Second crop point Y.
Definition: cam.h:245
+
Result CAMU_IsBusy(bool *busy, u32 port)
Gets whether the specified camera port is busy.
s8 exposure
Camera exposure.
Definition: cam.h:204
u8 flip
CAMU_Flip Camera image flip mode.
Definition: cam.h:238
20 FPS.
Definition: cam.h:75
@@ -1008,22 +1006,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
u8 context
CAMU_Context Selected context.
Definition: cam.h:228
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
-
Result CAMU_SetReceiving(Handle *event, void *dst, CAMU_Port port, u32 imageSize, s16 transferUnit)
Initiates the process of receiving a camera frame.
float rotationZ
Z axis rotation to match the left camera image with the right.
Definition: cam.h:187
u8 effect
CAMU_Effect Camera image special effects.
Definition: cam.h:239
void camExit(void)
Closes the cam service.
High contrast. (7)
Definition: cam.h:139
QQVGA size. (160x120)
Definition: cam.h:56
-
Result CAMU_SetAutoExposure(CAMU_CameraSelect select, bool autoExposure)
Sets whether auto exposure is enabled on the specified camera.
-
No camera.
Definition: cam.h:22
+
Result CAMU_SetOutputFormat(u32 select, CAMU_OutputFormat format, CAMU_Context context)
Sets the output format of the given camera in the given context.
+
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
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
int16_t s16
16-bit signed integer
Definition: types.h:28
Result CAMU_SetStereoCameraCalibrationData(CAMU_StereoCameraCalibrationData data)
Sets the specified camera's stereo camera calibration data.
-
Result CAMU_IsAutoWhiteBalance(bool *autoWhiteBalance, CAMU_CameraSelect select)
Gets whether auto white balance is enabled on the specified camera.
float scale
Scale to match the left camera image with the right.
Definition: cam.h:186
Auto white balance.
Definition: cam.h:86
CAMU_Effect
Camera special effects.
Definition: cam.h:113
diff --git a/cfgnor_8h.html b/cfgnor_8h.html index f632452..10c88df 100644 --- a/cfgnor_8h.html +++ b/cfgnor_8h.html @@ -100,12 +100,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Result CAMU_WriteRegisterI2c (CAMU_CameraSelect u32  select,
+ + + + + + + + + + + + - + - + @@ -113,51 +126,10 @@ Functions - - - - - -

Functions

Result cfgnorInit (u8 value)
 Initializes CFGNOR. More...
 
+void cfgnorExit (void)
 Exits CFGNOR.
 
Result cfgnorDumpFlash (u32 *buf, u32 size)
 Dumps the NOR flash. More...
 
Result cfgnorWriteFlash (u32 *buf, u32 size)
 Writes the NOR flash. More...
 
Result CFGNOR_Initialize (u8 value)
 Initializes CFGNOR. More...
 Initializes the CFGNOR session. More...
 
Result CFGNOR_Shutdown (void)
 Shuts down CFGNOR.
 Shuts down the CFGNOR session.
 
Result CFGNOR_ReadData (u32 offset, u32 *buf, u32 size)
 Reads data from NOR. More...
Result CFGNOR_WriteData (u32 offset, u32 *buf, u32 size)
 Writes data to NOR. More...
 
Result CFGNOR_DumpFlash (u32 *buf, u32 size)
 Dumps the NOR flash. More...
 
Result CFGNOR_WriteFlash (u32 *buf, u32 size)
 Writes the NOR flash. More...
 

Detailed Description

CFGNOR service.

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - -
Result CFGNOR_DumpFlash (u32buf,
u32 size 
)
-
- -

Dumps the NOR flash.

-
Parameters
- - - -
bufBuffer to dump to.
sizeSize of the buffer.
-
-
- -
-
@@ -172,7 +144,7 @@ Functions
-

Initializes CFGNOR.

+

Initializes the CFGNOR session.

Parameters
@@ -266,12 +238,71 @@ Functions - + +
+
+
valueUnknown, usually 1.
+ + + + + + + + + + + + + + + + + +
Result cfgnorDumpFlash (u32buf,
u32 size 
)
+
+ +

Dumps the NOR flash.

+
Parameters
+ + + +
bufBuffer to dump to.
sizeSize of the buffer.
+
+
+ +
+
+ +
+
+ + + + + + + + +
Result cfgnorInit (u8 value)
+
+ +

Initializes CFGNOR.

+
Parameters
+ + +
valueUnknown, usually 1.
+
+
+ +
+
+
- + diff --git a/cfgnor_8h_source.html b/cfgnor_8h_source.html index 99517bb..d4e47c5 100644 --- a/cfgnor_8h_source.html +++ b/cfgnor_8h_source.html @@ -100,49 +100,60 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
8  * @brief Initializes CFGNOR.
9  * @param value Unknown, usually 1.
10  */
- +
11 Result cfgnorInit(u8 value);
12 
-
13 /// Shuts down CFGNOR.
- +
13 /// Exits CFGNOR
+
14 void cfgnorExit(void);
15 
16 /**
-
17  * @brief Reads data from NOR.
-
18  * @param offset Offset to read from.
-
19  * @param buf Buffer to read data to.
-
20  * @param size Size of the buffer.
-
21  */
-
22 Result CFGNOR_ReadData(u32 offset, u32 *buf, u32 size);
-
23 
-
24 /**
-
25  * @brief Writes data to NOR.
-
26  * @param offset Offset to write to.
-
27  * @param buf Buffer to write data from.
-
28  * @param size Size of the buffer.
-
29  */
-
30 Result CFGNOR_WriteData(u32 offset, u32 *buf, u32 size);
-
31 
-
32 /**
-
33  * @brief Dumps the NOR flash.
-
34  * @param buf Buffer to dump to.
-
35  * @param size Size of the buffer.
-
36  */
-
37 Result CFGNOR_DumpFlash(u32 *buf, u32 size);
+
17  * @brief Dumps the NOR flash.
+
18  * @param buf Buffer to dump to.
+
19  * @param size Size of the buffer.
+
20  */
+
21 Result cfgnorDumpFlash(u32 *buf, u32 size);
+
22 
+
23 /**
+
24  * @brief Writes the NOR flash.
+
25  * @param buf Buffer to write from.
+
26  * @param size Size of the buffer.
+
27  */
+
28 Result cfgnorWriteFlash(u32 *buf, u32 size);
+
29 
+
30 /**
+
31  * @brief Initializes the CFGNOR session.
+
32  * @param value Unknown, usually 1.
+
33  */
+ +
35 
+
36 /// Shuts down the CFGNOR session.
+
38 
39 /**
-
40  * @brief Writes the NOR flash.
-
41  * @param buf Buffer to write from.
-
42  * @param size Size of the buffer.
-
43  */
-
44 Result CFGNOR_WriteFlash(u32 *buf, u32 size);
+
40  * @brief Reads data from NOR.
+
41  * @param offset Offset to read from.
+
42  * @param buf Buffer to read data to.
+
43  * @param size Size of the buffer.
+
44  */
+
45 Result CFGNOR_ReadData(u32 offset, u32 *buf, u32 size);
+
46 
+
47 /**
+
48  * @brief Writes data to NOR.
+
49  * @param offset Offset to write to.
+
50  * @param buf Buffer to write data from.
+
51  * @param size Size of the buffer.
+
52  */
+
53 Result CFGNOR_WriteData(u32 offset, u32 *buf, u32 size);
s32 Result
Function result.
Definition: types.h:43
+
Result cfgnorInit(u8 value)
Initializes CFGNOR.
uint8_t u8
8-bit unsigned integer
Definition: types.h:22
-
Result CFGNOR_WriteFlash(u32 *buf, u32 size)
Writes the NOR flash.
Result CFGNOR_ReadData(u32 offset, u32 *buf, u32 size)
Reads data from NOR.
-
Result CFGNOR_Initialize(u8 value)
Initializes CFGNOR.
+
Result CFGNOR_Initialize(u8 value)
Initializes the CFGNOR session.
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
-
Result CFGNOR_Shutdown(void)
Shuts down CFGNOR.
+
void cfgnorExit(void)
Exits CFGNOR.
+
Result cfgnorDumpFlash(u32 *buf, u32 size)
Dumps the NOR flash.
+
Result CFGNOR_Shutdown(void)
Shuts down the CFGNOR session.
+
Result cfgnorWriteFlash(u32 *buf, u32 size)
Writes the NOR flash.
Result CFGNOR_WriteData(u32 offset, u32 *buf, u32 size)
Writes data to NOR.
-
Result CFGNOR_DumpFlash(u32 *buf, u32 size)
Dumps the NOR flash.
- - - + + + @@ -190,15 +190,15 @@ Data types } - - + } +
Result CFGNOR_WriteFlash Result cfgnorWriteFlash ( u32 buf,
void ndspChnSetFormat (int id, u16 format)
 Sets the format of a channel. More...
 
void ndspChnSetInterp (int id, int type)
 Sets the interpolation type of a channel. More...
 
void ndspChnSetInterp (int id, ndspInterpType type)
 Sets the interpolation type of a channel. More...
 
void ndspChnSetRate (int id, float rate)
 Sets the sample rate of a channel. More...
 
 Channel format flags for use with ndspChnSetFormat. More...
 
enum  {
-  NDSP_INTERP_POLYPHASE = 0, +
enum  ndspInterpType {
+  NDSP_INTERP_POLYPHASE = 0,
-  NDSP_INTERP_LINEAR = 1, +  NDSP_INTERP_LINEAR = 1,
-  NDSP_INTERP_NONE = 2 +  NDSP_INTERP_NONE = 2
- }
 Interpolation types. More...
 
 Interpolation types. More...
 

Detailed Description

@@ -273,25 +273,25 @@ Data types
- +
- +
anonymous enumenum ndspInterpType

Interpolation types.

- - -
Enumerator
NDSP_INTERP_POLYPHASE  +
Enumerator
NDSP_INTERP_POLYPHASE 

Polyphase interpolation.

NDSP_INTERP_LINEAR  +
NDSP_INTERP_LINEAR 

Linear interpolation.

NDSP_INTERP_NONE  +
NDSP_INTERP_NONE 

No interpolation.

@@ -552,7 +552,6 @@ Data types

Sets the format of a channel.

-
See also
NDSP_Encoding
Parameters
@@ -563,7 +562,7 @@ Data types - +
idID of the channel (0..23).
@@ -576,7 +575,7 @@ Data types - + diff --git a/channel_8h_source.html b/channel_8h_source.html index 74e7994..5f894ce 100644 --- a/channel_8h_source.html +++ b/channel_8h_source.html @@ -130,12 +130,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
38 };
39 
40 /// Interpolation types.
-
41 enum
+
41 typedef enum
42 {
-
43  NDSP_INTERP_POLYPHASE = 0, ///< Polyphase interpolation
-
44  NDSP_INTERP_LINEAR = 1, ///< Linear interpolation
-
45  NDSP_INTERP_NONE = 2, ///< No interpolation
-
46 };
+
43  NDSP_INTERP_POLYPHASE = 0, ///< Polyphase interpolation
+
44  NDSP_INTERP_LINEAR = 1, ///< Linear interpolation
+
45  NDSP_INTERP_NONE = 2, ///< No interpolation
+
47 
48 ///@}
49 
@@ -179,100 +179,102 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
87 ///@{
88 /**
89  * @brief Sets the format of a channel.
-
90  * @sa NDSP_Encoding
-
91  * @param id ID of the channel (0..23).
-
92  * @param format Format to use.
-
93  */
-
94 void ndspChnSetFormat(int id, u16 format);
-
95 
-
96 /**
-
97  * @brief Sets the interpolation type of a channel.
-
98  * @param id ID of the channel (0..23).
-
99  * @param type Interpolation type to use.
-
100  */
-
101 void ndspChnSetInterp(int id, int type);
-
102 
-
103 /**
-
104  * @brief Sets the sample rate of a channel.
-
105  * @param id ID of the channel (0..23).
-
106  * @param rate Sample rate to use.
-
107  */
-
108 void ndspChnSetRate(int id, float rate);
-
109 
-
110 /**
-
111  * @brief Sets the mix parameters (volumes) of a channel.
-
112  * @param id ID of the channel (0..23).
-
113  * @param mix Mix parameters to use. Working hypothesis:
-
114  * - 0: Front left volume.
-
115  * - 1: Front right volume.
-
116  * - 2: Back left volume:
-
117  * - 3: Back right volume:
-
118  * - 4..7: Same as 0..3, but for auxiliary output 0.
-
119  * - 8..11: Same as 0..3, but for auxiliary output 1.
-
120  */
-
121 void ndspChnSetMix(int id, float mix[12]);
-
122 
-
123 /**
-
124  * @brief Sets the DSPADPCM coefficients of a channel.
-
125  * @param id ID of the channel (0..23).
-
126  * @param coefs DSPADPCM coefficients to use.
-
127  */
-
128 void ndspChnSetAdpcmCoefs(int id, u16 coefs[16]);
-
129 ///@}
-
130 
-
131 ///@name Wave buffers
-
132 ///@{
-
133 /**
-
134  * @brief Clears the wave buffer queue of a channel and stops playback.
-
135  * @param id ID of the channel (0..23).
-
136  */
-
137 void ndspChnWaveBufClear(int id);
-
138 
-
139 /**
-
140  * @brief Adds a wave buffer to the wave buffer queue of a channel.
-
141  * @remark If the channel's wave buffer queue was empty before the use of this function, playback is started.
-
142  * @param id ID of the channel (0..23).
-
143  * @param buf Wave buffer to add.
-
144  */
-
145 void ndspChnWaveBufAdd(int id, ndspWaveBuf* buf);
-
146 ///@}
-
147 
-
148 ///@name IIR filters
-
149 ///@{
-
150 /**
-
151  * @brief Configures whether the IIR monopole filter of a channel is enabled.
-
152  * @param id ID of the channel (0..23).
-
153  * @param enable Whether to enable the IIR monopole filter.
-
154  */
-
155 void ndspChnIirMonoSetEnable(int id, bool enable);
-
156 // ndspChnIirMonoSetParams
-
157 /**
-
158  * @brief Configures whether the IIR biquad filter of a channel is enabled.
-
159  * @param id ID of the channel (0..23).
-
160  * @param enable Whether to enable the IIR biquad filter.
-
161  */
-
162 void ndspChnIirBiquadSetEnable(int id, bool enable);
-
163 // ndspChnIirBiquadSetParams
-
164 ///@}
+
90  * @param id ID of the channel (0..23).
+
91  * @param format Format to use.
+
92  */
+
93 void ndspChnSetFormat(int id, u16 format);
+
94 
+
95 /**
+
96  * @brief Sets the interpolation type of a channel.
+
97  * @param id ID of the channel (0..23).
+
98  * @param type Interpolation type to use.
+
99  */
+
100 void ndspChnSetInterp(int id, ndspInterpType type);
+
101 
+
102 /**
+
103  * @brief Sets the sample rate of a channel.
+
104  * @param id ID of the channel (0..23).
+
105  * @param rate Sample rate to use.
+
106  */
+
107 void ndspChnSetRate(int id, float rate);
+
108 
+
109 /**
+
110  * @brief Sets the mix parameters (volumes) of a channel.
+
111  * @param id ID of the channel (0..23).
+
112  * @param mix Mix parameters to use. Working hypothesis:
+
113  * - 0: Front left volume.
+
114  * - 1: Front right volume.
+
115  * - 2: Back left volume:
+
116  * - 3: Back right volume:
+
117  * - 4..7: Same as 0..3, but for auxiliary output 0.
+
118  * - 8..11: Same as 0..3, but for auxiliary output 1.
+
119  */
+
120 void ndspChnSetMix(int id, float mix[12]);
+
121 
+
122 /**
+
123  * @brief Sets the DSPADPCM coefficients of a channel.
+
124  * @param id ID of the channel (0..23).
+
125  * @param coefs DSPADPCM coefficients to use.
+
126  */
+
127 void ndspChnSetAdpcmCoefs(int id, u16 coefs[16]);
+
128 ///@}
+
129 
+
130 ///@name Wave buffers
+
131 ///@{
+
132 /**
+
133  * @brief Clears the wave buffer queue of a channel and stops playback.
+
134  * @param id ID of the channel (0..23).
+
135  */
+
136 void ndspChnWaveBufClear(int id);
+
137 
+
138 /**
+
139  * @brief Adds a wave buffer to the wave buffer queue of a channel.
+
140  * @remark If the channel's wave buffer queue was empty before the use of this function, playback is started.
+
141  * @param id ID of the channel (0..23).
+
142  * @param buf Wave buffer to add.
+
143  */
+
144 void ndspChnWaveBufAdd(int id, ndspWaveBuf* buf);
+
145 ///@}
+
146 
+
147 ///@name IIR filters
+
148 ///@{
+
149 /**
+
150  * @brief Configures whether the IIR monopole filter of a channel is enabled.
+
151  * @param id ID of the channel (0..23).
+
152  * @param enable Whether to enable the IIR monopole filter.
+
153  */
+
154 void ndspChnIirMonoSetEnable(int id, bool enable);
+
155 // ndspChnIirMonoSetParams
+
156 /**
+
157  * @brief Configures whether the IIR biquad filter of a channel is enabled.
+
158  * @param id ID of the channel (0..23).
+
159  * @param enable Whether to enable the IIR biquad filter.
+
160  */
+
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:23
+
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
void ndspChnIirMonoSetEnable(int id, bool enable)
Configures whether the IIR monopole filter of a channel is enabled.
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
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
(Alias) Buffer contains Mono PCM8.
Definition: channel.h:31
-
No interpolation.
Definition: channel.h:45
u16 ndspChnGetWaveBufSeq(int id)
Gets the sequence ID of the wave buffer that is currently playing in a channel.
#define NDSP_CHANNELS(n)
Specifies the number of channels used in a sample.
Definition: channel.h:18
-
Polyphase interpolation.
Definition: channel.h:43
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
@@ -283,10 +285,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
(Alias) Buffer contains Mono ADPCM.
Definition: channel.h:33
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.
-
void ndspChnSetInterp(int id, int type)
Sets the interpolation type 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.
-
Linear interpolation.
Definition: channel.h:44
(?) Unknown, under research
Definition: channel.h:37
void ndspChnSetFormat(int id, u16 format)
Sets the format of a channel.
diff --git a/classes.html b/classes.html index 983930c..ba2673b 100644 --- a/classes.html +++ b/classes.html @@ -90,52 +90,51 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y
int ndspInterpType  type 
- + + - - - + + + - - - - + + + - + + - - + + + - - - - - + + + + +
  A  
-
DVLE_uniformEntry_s   
  O  
-
angularRate   
  n  
+
DVLE_uniformEntry_s   MVDSTD_Config   Y2RU_ConversionParams   
  l  
DVLP_s   aptHookCookie   
DVLP_s   
  O  
+
Y2RU_DitheringWeightParams   
AM_TitleEntry   
  E  
-
OutputStringEvent   
  c  
-
ndspAdpcmData   
  a  
+
linger   
  C  
-
  P  
-
tag_ndspWaveBuf   
ExceptionEvent   circlePosition   
  p  
+
OutputStringEvent   
  n  
CAMU_ImageQualityCalibrationData   ExitProcessEvent   PageInfo   
  f  
-
CAMU_PackageParameterCameraSelect   ExitThreadEvent   PrintConsole   pollfd   
ExceptionEvent   
  P  
+
accelVector   
CAMU_ImageQualityCalibrationData   ExitProcessEvent   angularRate   ndspAdpcmData   
CAMU_PackageParameterCameraSelect   ExitThreadEvent   PageInfo   aptHookCookie   tag_ndspWaveBuf   
CAMU_PackageParameterContext   
  F  
-
ProcessEvent   float24Uniform_s   
  q  
-
CAMU_PackageParameterContextDetail   
  R  
-
  h  
+
PrintConsole   
  c  
+
  p  
CAMU_StereoCameraCalibrationData   FS_archive   qtmHeadtrackingInfo   
ConsoleFont   FS_dirent   RecursiveLock   hostent   qtmHeadtrackingInfoCoord   
CreateThreadEvent   FS_path   
  S  
-
httpcContext   
  r  
+
CAMU_PackageParameterContextDetail   ProcessEvent   
CAMU_StereoCameraCalibrationData   FS_archive   
  Q  
+
circlePosition   pollfd   
ConsoleFont   FS_dirent   
  f  
+
  r  
CreateThreadEvent   FS_path   QTM_HeadTrackingInfo   
CSND_CapInfo   
  G  
-
  i  
-
CSND_ChnInfo   SchedulerInOutEvent   rbtree_node   
QTM_HeadTrackingInfoCoord   float24Uniform_s   rbtree_node   
CSND_ChnInfo   
  R  
+
  h  
+
rbtree   
  D  
-
GSP_CaptureInfo   SyscallInOutEvent   in_addr   rbtree   
GSP_CaptureInfoEntry   
  Y  
-
ip_mreq   romfs_dir   
DebugEventInfo   GSP_FramebufferInfo   
  l  
-
romfs_file   
GSPGPU_CaptureInfo   romfs_dir   
GSPGPU_CaptureInfoEntry   RecursiveLock   hostent   romfs_file   
DebugEventInfo   GSPGPU_FramebufferInfo   
  S  
+
httpcContext   romfs_header   
DVLB_s   
  M  
-
Y2R_ColorCoefficients   romfs_header   
DVLE_constEntry_s   Y2R_ConversionParams   linger   
  s  
-
DVLE_outEntry_s   MapEvent   Y2R_DitheringWeightParams   
  m  
+
  i  
+
  s  
DVLE_s   MemInfo   
  a  
-
shaderInstance_s   
mvdstdConfig   
accelVector   
DVLE_constEntry_s   SchedulerInOutEvent   
DVLE_outEntry_s   MapEvent   SyscallInOutEvent   in_addr   shaderInstance_s   
DVLE_s   MemInfo   
  Y  
+
ip_mreq   shaderProgram_s   
Y2RU_ColorCoefficients   
A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y
diff --git a/console_8h.html b/console_8h.html index 2f4bb49..d4e31ee 100644 --- a/console_8h.html +++ b/console_8h.html @@ -305,7 +305,7 @@ void 
Returns
A pointer to the current console.
-
Examples:
audio/mic/source/main.c, get_system_language/source/main.c, graphics/bitmap/24bit-color/source/main.c, graphics/printing/both-screen-text/source/main.c, graphics/printing/colored-text/source/main.c, graphics/printing/hello-world/source/main.c, graphics/printing/multiple-windows-text/source/main.c, http/source/main.c, input/read-controls/source/main.c, input/touch-screen/source/main.c, libapplet_launch/source/main.c, qtm/source/main.c, threads/event/source/main.c, and time/rtc/source/main.c.
+
Examples:
audio/mic/source/main.c, get_system_language/source/main.c, graphics/bitmap/24bit-color/source/main.c, graphics/printing/both-screen-text/source/main.c, graphics/printing/colored-text/source/main.c, graphics/printing/hello-world/source/main.c, graphics/printing/multiple-windows-text/source/main.c, http/source/main.c, input/read-controls/source/main.c, input/touch-screen/source/main.c, libapplet_launch/source/main.c, qtm/source/main.c, threads/event/source/main.c, and time/rtc/source/main.c.
diff --git a/csnd_8h.html b/csnd_8h.html index 554b6e6..521db5e 100644 --- a/csnd_8h.html +++ b/csnd_8h.html @@ -137,83 +137,83 @@ Macros - - + } + - - + } + - - + } + - - + } + - - + } +

Enumerations

enum  {
-  CSND_ENCODING_PCM8 = 0, +
enum  {
+  CSND_ENCODING_PCM8 = 0,
-  CSND_ENCODING_PCM16, +  CSND_ENCODING_PCM16,
-  CSND_ENCODING_ADPCM, +  CSND_ENCODING_ADPCM,
-  CSND_ENCODING_PSG +  CSND_ENCODING_PSG
- }
 CSND encodings. More...
 
 CSND encodings. More...
 
enum  {
-  CSND_LOOPMODE_MANUAL = 0, +
enum  {
+  CSND_LOOPMODE_MANUAL = 0,
-  CSND_LOOPMODE_NORMAL, +  CSND_LOOPMODE_NORMAL,
-  CSND_LOOPMODE_ONESHOT, +  CSND_LOOPMODE_ONESHOT,
-  CSND_LOOPMODE_NORELOAD +  CSND_LOOPMODE_NORELOAD
- }
 CSND loop modes. More...
 
 CSND loop modes. More...
 
enum  {
-  SOUND_LINEAR_INTERP = BIT(6), +
enum  {
+  SOUND_LINEAR_INTERP = BIT(6),
-  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL), +  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL),
-  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), +  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT),
-  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8), +  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8),
-  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16), +  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16),
-  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM), +  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM),
-  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG), +  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG),
-  SOUND_ENABLE = BIT(14) +  SOUND_ENABLE = BIT(14)
- }
 Sound flags. More...
 
 Sound flags. More...
 
enum  {
-  CAPTURE_REPEAT = 0, +
enum  {
+  CAPTURE_REPEAT = 0,
-  CAPTURE_ONE_SHOT = BIT(0), +  CAPTURE_ONE_SHOT = BIT(0),
-  CAPTURE_FORMAT_16BIT = 0, +  CAPTURE_FORMAT_16BIT = 0,
-  CAPTURE_FORMAT_8BIT = BIT(1), +  CAPTURE_FORMAT_8BIT = BIT(1),
-  CAPTURE_ENABLE = BIT(15) +  CAPTURE_ENABLE = BIT(15)
- }
 Capture modes. More...
 
 Capture modes. More...
 
enum  {
-  DutyCycle_0 = 7, +
enum  CSND_DutyCycle {
+  DutyCycle_0 = 7,
-  DutyCycle_12 = 0, +  DutyCycle_12 = 0,
-  DutyCycle_25 = 1, +  DutyCycle_25 = 1,
-  DutyCycle_37 = 2, +  DutyCycle_37 = 2,
-  DutyCycle_50 = 3, +  DutyCycle_50 = 3,
-  DutyCycle_62 = 4, +  DutyCycle_62 = 4,
-  DutyCycle_75 = 5, +  DutyCycle_75 = 5,
-  DutyCycle_87 = 6 +  DutyCycle_87 = 6
- }
 Duty cycles for a PSG channel. More...
 
 Duty cycles for a PSG channel. More...
 
+ + + + + + + + + @@ -268,9 +277,9 @@ void  - - - + + + @@ -286,9 +295,9 @@ void  - - - + + + @@ -357,7 +366,7 @@ Variables

CSND service.

Usage of this service is deprecated in favor of NDSP.

Enumeration Type Documentation

- +

@@ -227,6 +227,15 @@ Functions

Result CSND_ReleaseCapUnit (u32 capUnit)
 Releases a capture unit. More...
 
Result CSND_FlushDataCache (const void *adr, u32 size)
 Flushes the data cache of a memory region. More...
 
Result CSND_StoreDataCache (const void *adr, u32 size)
 Stores the data cache of a memory region. More...
 
Result CSND_InvalidateDataCache (const void *adr, u32 size)
 Invalidates the data cache of a memory region. More...
 
Result CSND_Reset (void)
 Resets CSND. More...
 
void CSND_SetInterp (u32 channel, bool interp)
 Sets whether a channel should use interpolation. More...
 
void CSND_SetDuty (u32 channel, u32 duty)
 Sets a channel's duty. More...
 
void CSND_SetDuty (u32 channel, CSND_DutyCycle duty)
 Sets a channel's duty. More...
 
void CSND_SetTimer (u32 channel, u32 timer)
 Sets a channel's timer. More...
 
void CSND_SetChnRegs (u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes)
 Sets CSND's channel registers. More...
 
void CSND_SetChnRegsPSG (u32 flags, u32 chnVolumes, u32 capVolumes, u32 duty)
 Sets CSND's PSG channel registers. More...
 
void CSND_SetChnRegsPSG (u32 flags, u32 chnVolumes, u32 capVolumes, CSND_DutyCycle duty)
 Sets CSND's PSG channel registers. More...
 
void CSND_SetChnRegsNoise (u32 flags, u32 chnVolumes, u32 capVolumes)
 Sets CSND's noise channel registers. More...
 
@@ -369,23 +378,23 @@ Variables

CSND encodings.

- - - -
Enumerator
CSND_ENCODING_PCM8  +
Enumerator
CSND_ENCODING_PCM8 

PCM8.

CSND_ENCODING_PCM16  +
CSND_ENCODING_PCM16 

PCM16.

CSND_ENCODING_ADPCM  +
CSND_ENCODING_ADPCM 

IMA-ADPCM.

CSND_ENCODING_PSG  +
CSND_ENCODING_PSG 

PSG (Similar to DS?)

- +
@@ -397,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.

- +
@@ -425,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.

- +
@@ -465,59 +474,59 @@ 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.

- +
- +
anonymous enumenum CSND_DutyCycle

Duty cycles for a PSG channel.

- - - - - - - -
Enumerator
DutyCycle_0  +
Enumerator
DutyCycle_0 

0.0% duty cycle

DutyCycle_12  +
DutyCycle_12 

12.5% duty cycle

DutyCycle_25  +
DutyCycle_25 

25.0% duty cycle

DutyCycle_37  +
DutyCycle_37 

37.5% duty cycle

DutyCycle_50  +
DutyCycle_50 

50.0% duty cycle

DutyCycle_62  +
DutyCycle_62 

62.5% duty cycle

DutyCycle_75  +
DutyCycle_75 

75.0% duty cycle

DutyCycle_87  +
DutyCycle_87 

87.5% duty cycle

@@ -764,6 +773,76 @@ Variables +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Result CSND_FlushDataCache (const void * adr,
u32 size 
)
+
+ +

Flushes the data cache of a memory region.

+
Parameters
+ + + +
adrAddress of the memory region.
sizeSize of the memory region.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Result CSND_InvalidateDataCache (const void * adr,
u32 size 
)
+
+ +

Invalidates the data cache of a memory region.

+
Parameters
+ + + +
adrAddress of the memory region.
sizeSize of the memory region.
+
+
+
@@ -1131,7 +1210,7 @@ Variables - +
@@ -1156,7 +1235,7 @@ Variables - + @@ -1204,7 +1283,7 @@ Variables - +
u32 CSND_DutyCycle  duty 
@@ -1217,7 +1296,7 @@ Variables - + @@ -1490,6 +1569,41 @@ Variables + + + +
+
+
u32 CSND_DutyCycle  duty 
+ + + + + + + + + + + + + + + + + +
Result CSND_StoreDataCache (const void * adr,
u32 size 
)
+
+ +

Stores the data cache of a memory region.

+
Parameters
+ + + +
adrAddress of the memory region.
sizeSize of the memory region.
+
+
+
diff --git a/csnd_8h_source.html b/csnd_8h_source.html index 8bf5c42..dd10846 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,38 +154,38 @@ 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.
-
86 enum
+
86 typedef enum
87 {
-
88  DutyCycle_0 = 7, ///< 0.0% duty cycle
-
89  DutyCycle_12 = 0, ///< 12.5% duty cycle
-
90  DutyCycle_25 = 1, ///< 25.0% duty cycle
-
91  DutyCycle_37 = 2, ///< 37.5% duty cycle
-
92  DutyCycle_50 = 3, ///< 50.0% duty cycle
-
93  DutyCycle_62 = 4, ///< 62.5% duty cycle
-
94  DutyCycle_75 = 5, ///< 75.0% duty cycle
-
95  DutyCycle_87 = 6 ///< 87.5% duty cycle
-
96 };
+
88  DutyCycle_0 = 7, ///< 0.0% duty cycle
+
89  DutyCycle_12 = 0, ///< 12.5% duty cycle
+
90  DutyCycle_25 = 1, ///< 25.0% duty cycle
+
91  DutyCycle_37 = 2, ///< 37.5% duty cycle
+
92  DutyCycle_50 = 3, ///< 50.0% duty cycle
+
93  DutyCycle_62 = 4, ///< 62.5% duty cycle
+
94  DutyCycle_75 = 5, ///< 75.0% duty cycle
+
95  DutyCycle_87 = 6 ///< 87.5% duty cycle
+
97 
98 /// Channel info.
99 typedef union
@@ -235,364 +235,389 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
144 
145 /**
-
146  * @brief Resets CSND.
-
147  * Note: Currently breaks sound, don't use for now!
-
148  */
-
149 Result CSND_Reset(void);
-
150 
-
151 /// Initializes CSND.
-
152 Result csndInit(void);
-
153 
-
154 /// Exits CSND.
-
155 void csndExit(void);
-
156 
-
157 /**
-
158  * @brief Adds a command to the list, returning a buffer to write arguments to.
-
159  * @param cmdid ID of the command to add.
-
160  * @return A buffer to write command arguments to.
-
161  */
-
162 u32* csndAddCmd(int cmdid);
-
163 
-
164 /**
-
165  * @brief Adds a command to the list, copying its arguments from a buffer.
-
166  * @param cmdid ID of the command to add.
-
167  * @param cmdparams Buffer containing the command's parameters.
-
168  */
-
169 void csndWriteCmd(int cmdid, u8* cmdparams);
-
170 
-
171 /**
-
172  * @brief Executes pending CSND commands.
-
173  * @param waitDone Whether to wait until the commands have finished executing.
-
174  */
-
175 Result csndExecCmds(bool waitDone);
-
176 
-
177 /**
-
178  * @brief Sets a channel's play state, resetting registers on stop.
-
179  * @param channel Channel to use.
-
180  * @param value Play state to set.
-
181  */
-
182 void CSND_SetPlayStateR(u32 channel, u32 value);
-
183 
-
184 /**
-
185  * @brief Sets a channel's play state.
-
186  * @param channel Channel to use.
-
187  * @param value Play state to set.
-
188  */
-
189 void CSND_SetPlayState(u32 channel, u32 value);
-
190 
-
191 /**
-
192  * @brief Sets a channel's encoding.
-
193  * @param channel Channel to use.
-
194  * @param value Encoding to set.
+
146  * @brief Flushes the data cache of a memory region.
+
147  * @param adr Address of the memory region.
+
148  * @param size Size of the memory region.
+
149  */
+
150 Result CSND_FlushDataCache(const void* adr, u32 size);
+
151 
+
152 /**
+
153  * @brief Stores the data cache of a memory region.
+
154  * @param adr Address of the memory region.
+
155  * @param size Size of the memory region.
+
156  */
+
157 Result CSND_StoreDataCache(const void* adr, u32 size);
+
158 
+
159 /**
+
160  * @brief Invalidates the data cache of a memory region.
+
161  * @param adr Address of the memory region.
+
162  * @param size Size of the memory region.
+
163  */
+
164 Result CSND_InvalidateDataCache(const void* adr, u32 size);
+
165 
+
166 /**
+
167  * @brief Resets CSND.
+
168  * Note: Currently breaks sound, don't use for now!
+
169  */
+
170 Result CSND_Reset(void);
+
171 
+
172 /// Initializes CSND.
+
173 Result csndInit(void);
+
174 
+
175 /// Exits CSND.
+
176 void csndExit(void);
+
177 
+
178 /**
+
179  * @brief Adds a command to the list, returning a buffer to write arguments to.
+
180  * @param cmdid ID of the command to add.
+
181  * @return A buffer to write command arguments to.
+
182  */
+
183 u32* csndAddCmd(int cmdid);
+
184 
+
185 /**
+
186  * @brief Adds a command to the list, copying its arguments from a buffer.
+
187  * @param cmdid ID of the command to add.
+
188  * @param cmdparams Buffer containing the command's parameters.
+
189  */
+
190 void csndWriteCmd(int cmdid, u8* cmdparams);
+
191 
+
192 /**
+
193  * @brief Executes pending CSND commands.
+
194  * @param waitDone Whether to wait until the commands have finished executing.
195  */
-
196 void CSND_SetEncoding(u32 channel, u32 value);
+
196 Result csndExecCmds(bool waitDone);
197 
198 /**
-
199  * @brief Sets the data of a channel's block.
+
199  * @brief Sets a channel's play state, resetting registers on stop.
200  * @param channel Channel to use.
-
201  * @param block Block to set.
-
202  * @param physaddr Physical address to set the block to.
-
203  * @param size Size of the block.
-
204  */
-
205 void CSND_SetBlock(u32 channel, int block, u32 physaddr, u32 size);
-
206 
-
207 /**
-
208  * @brief Sets whether to loop a channel.
-
209  * @param channel Channel to use.
-
210  * @param value Whether to loop the channel.
-
211  */
-
212 void CSND_SetLooping(u32 channel, u32 value);
-
213 
-
214 /**
-
215  * @brief Sets bit 7 of a channel.
-
216  * @param channel Channel to use.
-
217  * @param set Value to set.
-
218  */
-
219 void CSND_SetBit7(u32 channel, bool set);
-
220 
-
221 /**
-
222  * @brief Sets whether a channel should use interpolation.
-
223  * @param channel Channel to use.
-
224  * @param interp Whether to use interpolation.
+
201  * @param value Play state to set.
+
202  */
+
203 void CSND_SetPlayStateR(u32 channel, u32 value);
+
204 
+
205 /**
+
206  * @brief Sets a channel's play state.
+
207  * @param channel Channel to use.
+
208  * @param value Play state to set.
+
209  */
+
210 void CSND_SetPlayState(u32 channel, u32 value);
+
211 
+
212 /**
+
213  * @brief Sets a channel's encoding.
+
214  * @param channel Channel to use.
+
215  * @param value Encoding to set.
+
216  */
+
217 void CSND_SetEncoding(u32 channel, u32 value);
+
218 
+
219 /**
+
220  * @brief Sets the data of a channel's block.
+
221  * @param channel Channel to use.
+
222  * @param block Block to set.
+
223  * @param physaddr Physical address to set the block to.
+
224  * @param size Size of the block.
225  */
-
226 void CSND_SetInterp(u32 channel, bool interp);
+
226 void CSND_SetBlock(u32 channel, int block, u32 physaddr, u32 size);
227 
228 /**
-
229  * @brief Sets a channel's duty.
+
229  * @brief Sets whether to loop a channel.
230  * @param channel Channel to use.
-
231  * @param duty Duty to set.
+
231  * @param value Whether to loop the channel.
232  */
-
233 void CSND_SetDuty(u32 channel, u32 duty);
+
233 void CSND_SetLooping(u32 channel, u32 value);
234 
235 /**
-
236  * @brief Sets a channel's timer.
+
236  * @brief Sets bit 7 of a channel.
237  * @param channel Channel to use.
-
238  * @param timer Timer to set.
+
238  * @param set Value to set.
239  */
-
240 void CSND_SetTimer(u32 channel, u32 timer);
+
240 void CSND_SetBit7(u32 channel, bool set);
241 
242 /**
-
243  * @brief Sets a channel's volume.
+
243  * @brief Sets whether a channel should use interpolation.
244  * @param channel Channel to use.
-
245  * @param chnVolumes Channel volume data to set.
-
246  * @param capVolumes Capture volume data to set.
-
247  */
-
248 void CSND_SetVol(u32 channel, u32 chnVolumes, u32 capVolumes);
-
249 
-
250 /**
-
251  * @brief Sets a channel's ADPCM state.
-
252  * @param channel Channel to use.
-
253  * @param block Current block.
-
254  * @param sample Current sample.
-
255  * @param index Current index.
-
256  */
-
257 void CSND_SetAdpcmState(u32 channel, int block, int sample, int index);
-
258 
-
259 /**
-
260  * @brief Sets a whether channel's ADPCM data should be reloaded when the second block is played.
-
261  * @param channel Channel to use.
-
262  * @param reload Whether to reload ADPCM data.
-
263  */
-
264 void CSND_SetAdpcmReload(u32 channel, bool reload);
-
265 
-
266 /**
-
267  * @brief Sets CSND's channel registers.
-
268  * @param flags Flags to set.
-
269  * @param physaddr0 Physical address of the first buffer to play.
-
270  * @param physaddr1 Physical address of the second buffer to play.
-
271  * @param totalbytesize Total size of the data to play.
-
272  * @param chnVolumes Channel volume data.
-
273  * @param capVolumes Capture volume data.
-
274  */
-
275 void CSND_SetChnRegs(u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes);
-
276 
-
277 /**
-
278  * @brief Sets CSND's PSG channel registers.
-
279  * @param flags Flags to set.
-
280  * @param chnVolumes Channel volume data.
-
281  * @param capVolumes Capture volume data.
-
282  * @param duty Duty value to set.
-
283  */
-
284 void CSND_SetChnRegsPSG(u32 flags, u32 chnVolumes, u32 capVolumes, u32 duty);
-
285 
-
286 /**
-
287  * @brief Sets CSND's noise channel registers.
-
288  * @param flags Flags to set.
-
289  * @param chnVolumes Channel volume data.
-
290  * @param capVolumes Capture volume data.
-
291  */
-
292 void CSND_SetChnRegsNoise(u32 flags, u32 chnVolumes, u32 capVolumes);
-
293 
-
294 /**
-
295  * @brief Sets whether a capture unit is enabled.
-
296  * @param capUnit Capture unit to use.
-
297  * @param enable Whether to enable the capture unit.
-
298  */
-
299 void CSND_CapEnable(u32 capUnit, bool enable);
-
300 
-
301 /**
-
302  * @brief Sets whether a capture unit should repeat.
-
303  * @param capUnit Capture unit to use.
-
304  * @param repeat Whether the capture unit should repeat.
-
305  */
-
306 void CSND_CapSetRepeat(u32 capUnit, bool repeat);
-
307 
-
308 /**
-
309  * @brief Sets a capture unit's format.
-
310  * @param capUnit Capture unit to use.
-
311  * @param eightbit Format to use.
+
245  * @param interp Whether to use interpolation.
+
246  */
+
247 void CSND_SetInterp(u32 channel, bool interp);
+
248 
+
249 /**
+
250  * @brief Sets a channel's duty.
+
251  * @param channel Channel to use.
+
252  * @param duty Duty to set.
+
253  */
+
254 void CSND_SetDuty(u32 channel, CSND_DutyCycle duty);
+
255 
+
256 /**
+
257  * @brief Sets a channel's timer.
+
258  * @param channel Channel to use.
+
259  * @param timer Timer to set.
+
260  */
+
261 void CSND_SetTimer(u32 channel, u32 timer);
+
262 
+
263 /**
+
264  * @brief Sets a channel's volume.
+
265  * @param channel Channel to use.
+
266  * @param chnVolumes Channel volume data to set.
+
267  * @param capVolumes Capture volume data to set.
+
268  */
+
269 void CSND_SetVol(u32 channel, u32 chnVolumes, u32 capVolumes);
+
270 
+
271 /**
+
272  * @brief Sets a channel's ADPCM state.
+
273  * @param channel Channel to use.
+
274  * @param block Current block.
+
275  * @param sample Current sample.
+
276  * @param index Current index.
+
277  */
+
278 void CSND_SetAdpcmState(u32 channel, int block, int sample, int index);
+
279 
+
280 /**
+
281  * @brief Sets a whether channel's ADPCM data should be reloaded when the second block is played.
+
282  * @param channel Channel to use.
+
283  * @param reload Whether to reload ADPCM data.
+
284  */
+
285 void CSND_SetAdpcmReload(u32 channel, bool reload);
+
286 
+
287 /**
+
288  * @brief Sets CSND's channel registers.
+
289  * @param flags Flags to set.
+
290  * @param physaddr0 Physical address of the first buffer to play.
+
291  * @param physaddr1 Physical address of the second buffer to play.
+
292  * @param totalbytesize Total size of the data to play.
+
293  * @param chnVolumes Channel volume data.
+
294  * @param capVolumes Capture volume data.
+
295  */
+
296 void CSND_SetChnRegs(u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes);
+
297 
+
298 /**
+
299  * @brief Sets CSND's PSG channel registers.
+
300  * @param flags Flags to set.
+
301  * @param chnVolumes Channel volume data.
+
302  * @param capVolumes Capture volume data.
+
303  * @param duty Duty value to set.
+
304  */
+
305 void CSND_SetChnRegsPSG(u32 flags, u32 chnVolumes, u32 capVolumes, CSND_DutyCycle duty);
+
306 
+
307 /**
+
308  * @brief Sets CSND's noise channel registers.
+
309  * @param flags Flags to set.
+
310  * @param chnVolumes Channel volume data.
+
311  * @param capVolumes Capture volume data.
312  */
-
313 void CSND_CapSetFormat(u32 capUnit, bool eightbit);
+
313 void CSND_SetChnRegsNoise(u32 flags, u32 chnVolumes, u32 capVolumes);
314 
315 /**
-
316  * @brief Sets a capture unit's second bit.
+
316  * @brief Sets whether a capture unit is enabled.
317  * @param capUnit Capture unit to use.
-
318  * @param set Value to set.
+
318  * @param enable Whether to enable the capture unit.
319  */
-
320 void CSND_CapSetBit2(u32 capUnit, bool set);
+
320 void CSND_CapEnable(u32 capUnit, bool enable);
321 
322 /**
-
323  * @brief Sets a capture unit's timer.
+
323  * @brief Sets whether a capture unit should repeat.
324  * @param capUnit Capture unit to use.
-
325  * @param timer Timer to set.
+
325  * @param repeat Whether the capture unit should repeat.
326  */
-
327 void CSND_CapSetTimer(u32 capUnit, u32 timer);
+
327 void CSND_CapSetRepeat(u32 capUnit, bool repeat);
328 
329 /**
-
330  * @brief Sets a capture unit's buffer.
+
330  * @brief Sets a capture unit's format.
331  * @param capUnit Capture unit to use.
-
332  * @param addr Buffer address to use.
-
333  * @param size Size of the buffer.
-
334  */
-
335 void CSND_CapSetBuffer(u32 capUnit, u32 addr, u32 size);
-
336 
-
337 /**
-
338  * @brief Sets a capture unit's capture registers.
-
339  * @param capUnit Capture unit to use.
-
340  * @param flags Capture unit flags.
-
341  * @param addr Capture unit buffer address.
-
342  * @param size Buffer size.
-
343  */
-
344 void CSND_SetCapRegs(u32 capUnit, u32 flags, u32 addr, u32 size);
-
345 
-
346 /**
-
347  * @brief Sets up DSP flags.
-
348  * @param waitDone Whether to wait for completion.
-
349  */
-
350 Result CSND_SetDspFlags(bool waitDone);
-
351 
-
352 /**
-
353  * @brief Updates CSND information.
-
354  * @param waitDone Whether to wait for completion.
+
332  * @param eightbit Format to use.
+
333  */
+
334 void CSND_CapSetFormat(u32 capUnit, bool eightbit);
+
335 
+
336 /**
+
337  * @brief Sets a capture unit's second bit.
+
338  * @param capUnit Capture unit to use.
+
339  * @param set Value to set.
+
340  */
+
341 void CSND_CapSetBit2(u32 capUnit, bool set);
+
342 
+
343 /**
+
344  * @brief Sets a capture unit's timer.
+
345  * @param capUnit Capture unit to use.
+
346  * @param timer Timer to set.
+
347  */
+
348 void CSND_CapSetTimer(u32 capUnit, u32 timer);
+
349 
+
350 /**
+
351  * @brief Sets a capture unit's buffer.
+
352  * @param capUnit Capture unit to use.
+
353  * @param addr Buffer address to use.
+
354  * @param size Size of the buffer.
355  */
-
356 Result CSND_UpdateInfo(bool waitDone);
+
356 void CSND_CapSetBuffer(u32 capUnit, u32 addr, u32 size);
357 
358 /**
-
359  * @brief Plays a sound.
-
360  * @param chn Channel to play the sound on.
-
361  * @param flags Flags containing information about the sound.
-
362  * @param sampleRate Sample rate of the sound.
-
363  * @param vol The volume, ranges from 0.0 to 1.0 included.
-
364  * @param pan The pan, ranges from -1.0 to 1.0 included.
-
365  * @param data0 First block of sound data.
-
366  * @param data1 Second block of sound data. This is the block that will be looped over.
-
367  * @param size Size of the sound data.
-
368  *
-
369  * In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size.
+
359  * @brief Sets a capture unit's capture registers.
+
360  * @param capUnit Capture unit to use.
+
361  * @param flags Capture unit flags.
+
362  * @param addr Capture unit buffer address.
+
363  * @param size Buffer size.
+
364  */
+
365 void CSND_SetCapRegs(u32 capUnit, u32 flags, u32 addr, u32 size);
+
366 
+
367 /**
+
368  * @brief Sets up DSP flags.
+
369  * @param waitDone Whether to wait for completion.
370  */
-
371 Result csndPlaySound(int chn, u32 flags, u32 sampleRate, float vol, float pan, void* data0, void* data1, u32 size);
+
371 Result CSND_SetDspFlags(bool waitDone);
372 
373 /**
-
374  * @brief Gets CSND's DSP flags.
-
375  * Note: Requires previous CSND_UpdateInfo()
-
376  * @param outSemFlags Pointer to write semaphore flags to.
-
377  * @param outIrqFlags Pointer to write interrupt flags to.
-
378  */
-
379 void csndGetDspFlags(u32* outSemFlags, u32* outIrqFlags);
-
380 
-
381 /**
-
382  * @brief Gets a channel's information.
-
383  * Note: Requires previous CSND_UpdateInfo()
-
384  * @param channel Channel to get information for.
-
385  * @return The channel's information.
-
386  */
- -
388 
-
389 /**
-
390  * @brief Gets a capture unit's information.
-
391  * Note: Requires previous CSND_UpdateInfo()
-
392  * @param capUnit Capture unit to get information for.
-
393  * @return The capture unit's information.
-
394  */
- -
396 
-
397 /**
-
398  * @brief Gets a channel's state.
-
399  * @param channel Channel to get the state of.
-
400  * @param out Pointer to output channel information to.
-
401  */
-
402 Result csndGetState(u32 channel, CSND_ChnInfo* out);
-
403 
-
404 /**
-
405  * @brief Gets whether a channel is playing.
-
406  * @param channel Channel to check.
-
407  * @param status Pointer to output the channel status to.
-
408  */
-
409 Result csndIsPlaying(u32 channel, u8* status);
-
Don't reload.
Definition: csnd.h:50
+
374  * @brief Updates CSND information.
+
375  * @param waitDone Whether to wait for completion.
+
376  */
+
377 Result CSND_UpdateInfo(bool waitDone);
+
378 
+
379 /**
+
380  * @brief Plays a sound.
+
381  * @param chn Channel to play the sound on.
+
382  * @param flags Flags containing information about the sound.
+
383  * @param sampleRate Sample rate of the sound.
+
384  * @param vol The volume, ranges from 0.0 to 1.0 included.
+
385  * @param pan The pan, ranges from -1.0 to 1.0 included.
+
386  * @param data0 First block of sound data.
+
387  * @param data1 Second block of sound data. This is the block that will be looped over.
+
388  * @param size Size of the sound data.
+
389  *
+
390  * In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size.
+
391  */
+
392 Result csndPlaySound(int chn, u32 flags, u32 sampleRate, float vol, float pan, void* data0, void* data1, u32 size);
+
393 
+
394 /**
+
395  * @brief Gets CSND's DSP flags.
+
396  * Note: Requires previous CSND_UpdateInfo()
+
397  * @param outSemFlags Pointer to write semaphore flags to.
+
398  * @param outIrqFlags Pointer to write interrupt flags to.
+
399  */
+
400 void csndGetDspFlags(u32* outSemFlags, u32* outIrqFlags);
+
401 
+
402 /**
+
403  * @brief Gets a channel's information.
+
404  * Note: Requires previous CSND_UpdateInfo()
+
405  * @param channel Channel to get information for.
+
406  * @return The channel's information.
+
407  */
+ +
409 
+
410 /**
+
411  * @brief Gets a capture unit's information.
+
412  * Note: Requires previous CSND_UpdateInfo()
+
413  * @param capUnit Capture unit to get information for.
+
414  * @return The capture unit's information.
+
415  */
+ +
417 
+
418 /**
+
419  * @brief Gets a channel's state.
+
420  * @param channel Channel to get the state of.
+
421  * @param out Pointer to output channel information to.
+
422  */
+
423 Result csndGetState(u32 channel, CSND_ChnInfo* out);
+
424 
+
425 /**
+
426  * @brief Gets whether a channel is playing.
+
427  * @param channel Channel to check.
+
428  * @param status Pointer to output the channel status to.
+
429  */
+
430 Result csndIsPlaying(u32 channel, u8* status);
void CSND_SetInterp(u32 channel, bool interp)
Sets whether a channel should use interpolation.
-
IMA-ADPCM.
Definition: csnd.h:40
volatile u32 vu32
32-bit volatile unsigned integer.
Definition: types.h:34
Various system types.
-
Repeat the sound.
Definition: csnd.h:66
+
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:43
+
PCM8.
Definition: csnd.h:81
+
75.0% duty cycle
Definition: csnd.h:94
u32 unknownZero
Unknown.
Definition: csnd.h:123
Result CSND_Reset(void)
Resets CSND.
uint16_t u16
16-bit unsigned integer
Definition: types.h:23
-
50.0% duty cycle
Definition: csnd.h:92
+
Enable sound.
Definition: csnd.h:72
u16 _pad2
Padding.
Definition: csnd.h:122
-
PCM16.
Definition: csnd.h:69
+
12.5% duty cycle
Definition: csnd.h:89
+
Enable capture.
Definition: csnd.h:82
+
Don't reload.
Definition: csnd.h:50
+
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.
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.
-
Enable capture.
Definition: csnd.h:82
-
Capture once.
Definition: csnd.h:79
u8 _pad1
Padding.
Definition: csnd.h:105
-
ADPCM.
Definition: csnd.h:70
+
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:22
-
0.0% duty cycle
Definition: csnd.h:88
-
Play the sound once.
Definition: csnd.h:67
+
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
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.
-
75.0% duty cycle
Definition: csnd.h:94
+
PSG.
Definition: csnd.h:71
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
+
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.
u32 * csndAddCmd(int cmdid)
Adds a command to the list, returning a buffer to write arguments to.
-
Repeat capture.
Definition: csnd.h:78
void CSND_CapSetFormat(u32 capUnit, bool eightbit)
Sets a capture unit's format.
-
25.0% duty cycle
Definition: csnd.h:90
-
37.5% duty cycle
Definition: csnd.h:91
void CSND_SetCapRegs(u32 capUnit, u32 flags, u32 addr, u32 size)
Sets a capture unit's capture registers.
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.
-
void CSND_SetChnRegsPSG(u32 flags, u32 chnVolumes, u32 capVolumes, u32 duty)
Sets CSND's PSG channel registers.
-
12.5% duty cycle
Definition: csnd.h:89
void CSND_SetChnRegs(u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes)
Sets CSND's channel registers.
-
Normal loop.
Definition: csnd.h:48
void CSND_SetAdpcmState(u32 channel, int block, int sample, int index)
Sets a channel's ADPCM state.
vu32 * csndSharedMem
CSND shared memory.
s16 adpcmSample
Current ADPCM sample.
Definition: csnd.h:107
-
PCM16.
Definition: csnd.h:80
-
void CSND_SetDuty(u32 channel, u32 duty)
Sets a channel's duty.
+
0.0% duty cycle
Definition: csnd.h:88
+
Capture once.
Definition: csnd.h:79
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.
#define BIT(n)
Creates a bitmask from a bit number.
Definition: types.h:47
u32 csndSharedMemSize
CSND shared memory size.
-
PCM8.
Definition: csnd.h:81
Result CSND_UpdateInfo(bool waitDone)
Updates CSND information.
-
PSG (Similar to DS?)
Definition: csnd.h:41
+
37.5% duty cycle
Definition: csnd.h:91
Result CSND_SetDspFlags(bool waitDone)
Sets up DSP flags.
u16 _pad2
Padding.
Definition: csnd.h:106
Channel info.
Definition: csnd.h:99
u8 active
Capture active.
Definition: csnd.h:120
-
Manual loop.
Definition: csnd.h:47
-
PSG.
Definition: csnd.h:71
+
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.
-
62.5% duty cycle
Definition: csnd.h:93
-
PCM8.
Definition: csnd.h:38
+
62.5% duty cycle
Definition: csnd.h:93
+
PCM16.
Definition: csnd.h:80
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
-
PCM16.
Definition: csnd.h:39
-
Do not loop.
Definition: csnd.h:49
-
Linear interpolation.
Definition: csnd.h:65
+
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
-
Enable sound.
Definition: csnd.h:72
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.
+
CSND_DutyCycle
Duty cycles for a PSG channel.
Definition: csnd.h:86
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.
-
PCM8.
Definition: csnd.h:68
u8 _pad3
Padding.
Definition: csnd.h:109
-
87.5% duty cycle
Definition: csnd.h:95
u8 _pad1
Padding.
Definition: csnd.h:121
int16_t s16
16-bit signed integer
Definition: types.h:28
void CSND_SetVol(u32 channel, u32 chnVolumes, u32 capVolumes)
Sets a channel's volume.
+
87.5% duty cycle
Definition: csnd.h:95