1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<BASE target="main">
8<TITLE>Camera Library (CAMERA) Function List</TITLE>
9<LINK rel="stylesheet" href="../css/apilist.css">
10</HEAD>
11<BODY>
12<H1>Camera Library (CAMERA) Function List</H1>
13
14<H3><A name="Init">Initialization</A></H3>
15<TABLE border="1" width="100%">
16  <TBODY>
17    <TR>
18      <TH nowrap width="25%"><A href="CAMERA_Init.html" target="_self">CAMERA_Init</A></TH>
19      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
20      <TD>Initializes the camera library.</TD>
21    </TR>
22    <TR>
23      <TH nowrap width="25%"><A href="CAMERA_End.html" target="_self">CAMERA_End</A></TH>
24      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
25      <TD>Shuts down the camera library.</TD>
26    </TR>
27    <TR>
28      <TH nowrap width="25%"><FONT color="gray">CAMERA_Reset</FONT></TH>
29      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
30      <TD>Resets the camera.<BR>
31          (This does not need to be called because <A href="CAMERA_Init.html" target="_self"><CODE>CAMERA_Init</CODE></A> calls it internally.)</TD>
32    </TR>
33    <TR>
34      <TH nowrap width="25%"><FONT color="gray">CAMERA_I2CInit*</FONT></TH>
35      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
36      <TD>Initializes the camera registers.<BR>
37          (This does not need to be called because <A href="CAMERA_Init.html" target="_self"><CODE>CAMERA_Init</CODE></A> calls it.)</TD>
38    </TR>
39  </TBODY>
40</TABLE>
41
42<H3><A name="Capture">Capture-Related</A></H3>
43<TABLE border="1" width="100%">
44  <TBODY>
45    <TR>
46      <TH nowrap width="25%"><A href="CAMERA_Start.html" target="_self">CAMERA_Start</A></TH>
47      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
48      <TD>High-level function to start the camera and begin capturing.</TD>
49    </TR>
50    <TR>
51      <TH nowrap width="25%"><A href="CAMERA_Stop.html" target="_self">CAMERA_Stop</A></TH>
52      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
53      <TD>High-level function to stop capturing and put the camera in standby mode.</TD>
54    </TR>
55    <TR>
56      <TH nowrap width="25%"><A href="CAMERA_I2CActivate.html" target="_self">CAMERA_I2CActivate*</A></TH>
57      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
58      <TD>Specifies the inner or outer camera and activates it.</TD>
59    </TR>
60    <TR>
61      <TH nowrap width="25%"><A href="CAMERA_StartCapture.html" target="_self">CAMERA_StartCapture</A></TH>
62      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
63      <TD>Starts capturing.</TD>
64    </TR>
65    <TR>
66      <TH nowrap width="25%"><A href="CAMERA_StopCapture.html" target="_self">CAMERA_StopCapture</A></TH>
67      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
68      <TD>Stops capturing.</TD>
69    </TR>
70    <TR>
71      <TH nowrap width="25%"><A href="CAMERA_DmaRecv.html" target="_self">CAMERA_DmaRecv</A></TH>
72      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
73      <TD>Receives frame data from the camera buffer.</TD>
74    </TR>
75    <TR>
76      <TH nowrap width="25%"><A href="CAMERA_DmaRecvAsync.html" target="_self">CAMERA_DmaRecvAsync</A></TH>
77      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
78      <TD>Receives frame data asynchronously from the camera buffer.</TD>
79    </TR>
80    <TR>
81      <TH nowrap width="25%"><A href="CAMERA_DmaPipeInfinity.html" target="_self">CAMERA_DmaPipeInfinity</A></TH>
82      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
83      <TD>Continues to receive consecutive data from the camera buffer.</TD>
84    </TR>
85    <TR>
86      <TH nowrap width="25%"><A href="CAMERA_IsBusy.html" target="_self">CAMERA_IsBusy</A></TH>
87      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
88      <TD>Returns whether the camera is currently getting image data.</TD>
89    </TR>
90  </TBODY>
91</TABLE>
92
93<H3><A name="Config">Camera Settings</A></H3>
94<TABLE border="1" width="100%">
95  <TBODY>
96    <TR>
97      <TH nowrap width="25%"><A href="CAMERA_SetTrimmingParamsCenter.html" target="_self">CAMERA_SetTrimmingParamsCenter</A></TH>
98      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
99      <TD>Configures trimming values for the camera based around a center point.</TD>
100    </TR>
101    <TR>
102      <TH nowrap width="25%"><A href="CAMERA_SetTrimmingParams.html" target="_self">CAMERA_SetTrimmingParams</A></TH>
103      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
104      <TD>Configures trimming values for the camera.</TD>
105    </TR>
106    <TR>
107      <TH nowrap width="25%"><A href="CAMERA_GetTrimmingParams.html" target="_self">CAMERA_GetTrimmingParams</A></TH>
108      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
109      <TD>Gets the trimming values for the camera.</TD>
110    </TR>
111    <TR>
112      <TH nowrap width="25%"><A href="CAMERA_SetTrimming.html" target="_self">CAMERA_SetTrimming</A></TH>
113      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
114      <TD>Enables or disables trimming for the camera.</TD>
115    </TR>
116    <TR>
117      <TH nowrap width="25%"><A href="CAMERA_IsTrimming.html" target="_self">CAMERA_IsTrimming</A></TH>
118      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
119      <TD>Determines whether trimming is enabled or disabled for the camera.</TD>
120    </TR>
121    <TR>
122      <TH nowrap width="25%"><A href="CAMERA_I2CSize.html" target="_self">CAMERA_I2CSize*</A></TH>
123      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
124      <TD>Sets the camera resolution.</TD>
125    </TR>
126    <TR>
127      <TH nowrap width="25%"><A href="CAMERA_I2CFrameRate.html" target="_self">CAMERA_I2CFrameRate*</A></TH>
128      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
129      <TD>Sets the camera's frame rate.</TD>
130    </TR>
131    <TR>
132      <TH nowrap width="25%"><A href="CAMERA_I2CEffect.html" target="_self">CAMERA_I2CEffect*</A></TH>
133      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
134      <TD>Configures effects for camera images.</TD>
135    </TR>
136    <TR>
137      <TH nowrap width="25%"><A href="CAMERA_I2CFlip.html" target="_self">CAMERA_I2CFlip*</A></TH>
138      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
139      <TD>Configures flipping on camera images.</TD>
140    </TR>
141    <TR>
142      <TH nowrap width="25%"><A href="CAMERA_I2CPhotoMode.html" target="_self">CAMERA_I2CPhotoMode*</A></TH>
143      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
144      <TD>Sets the camera's photo mode.</TD>
145    </TR>
146    <TR>
147      <TH nowrap width="25%"><A href="CAMERA_I2CWhiteBalance.html" target="_self">CAMERA_I2CWhiteBalance*</A></TH>
148      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
149      <TD>Sets the camera's white balance.</TD>
150    </TR>
151    <TR>
152      <TH nowrap width="25%"><A href="CAMERA_I2CExposure.html" target="_self">CAMERA_I2CExposure*</A></TH>
153      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
154      <TD>Configures the camera's exposure.</TD>
155    </TR>
156    <TR>
157      <TH nowrap width="25%"><A href="CAMERA_I2CSharpness.html" target="_self">CAMERA_I2CSharpness*</A></TH>
158      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
159      <TD>Sets the camera's sharpness.</TD>
160    </TR>
161    <TR>
162      <TH nowrap width="25%"><A href="CAMERA_I2CAutoExposure.html" target="_self">CAMERA_I2CAutoExposure*</A></TH>
163      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
164      <TD>Enables or disables the camera's automatic exposure feature.</TD>
165    </TR>
166    <TR>
167      <TH nowrap width="25%"><A href="CAMERA_I2CAutoWhiteBalance.html" target="_self">CAMERA_I2CAutoWhiteBalance*</A></TH>
168      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
169      <TD>Enables or disables the auto-adjustment feature for the camera's white balance.</TD>
170    </TR>
171    <TR>
172      <TH nowrap width="25%"><A href="CAMERA_SetOutputFormat.html" target="_self">CAMERA_SetOutputFormat</A></TH>
173      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
174      <TD>Sets the camera's output format.</TD>
175    </TR>
176    <TR>
177      <TH nowrap width="25%"><A href="CAMERA_GetOutputFormat.html" target="_self">CAMERA_GetOutputFormat</A></TH>
178      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
179      <TD>Gets the camera's output format.</TD>
180    </TR>
181    <TR>
182      <TH nowrap width="25%"><A href="CAMERA_GetErrorStatus.html" target="_self">CAMERA_GetErrorStatus</A></TH>
183      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
184      <TD>Checks the error flag for the line buffer.</TD>
185    </TR>
186    <TR>
187      <TH nowrap width="25%"><A href="CAMERA_ClearBuffer.html" target="_self">CAMERA_ClearBuffer</A></TH>
188      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
189      <TD>Clears the line buffer and the error flag.</TD>
190    </TR>
191    <TR>
192      <TH nowrap width="25%"><A href="CAMERA_SetVsyncCallback.html" target="_self">CAMERA_SetVsyncCallback</A></TH>
193      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
194      <TD>Sets the callback function that is invoked during a camera VSync interrupt.</TD>
195    </TR>
196    <TR>
197      <TH nowrap width="25%"><A href="CAMERA_SetBufferErrorCallback.html" target="_self">CAMERA_SetBufferErrorCallback</A></TH>
198      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
199      <TD>Sets the callback function that is invoked during a camera buffer error interrupt.</TD>
200    </TR>
201    <TR>
202      <TH nowrap width="25%"><A href="CAMERA_SetRebootCallback.html" target="_self">CAMERA_SetRebootCallback</A></TH>
203      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
204      <TD>Sets the callback function that is invoked after the camera has finished restarting.</TD>
205    </TR>
206    <TR>
207      <TH nowrap width="25%"><A href="CAMERA_SetTransferLines.html" target="_self">CAMERA_SetTransferLines</A></TH>
208      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
209      <TD>Sets the number of lines to transfer to the buffer at once.</TD>
210    </TR>
211    <TR>
212      <TH nowrap width="25%"><A href="CAMERA_GetTransferLines.html" target="_self">CAMERA_GetTransferLines</A></TH>
213      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
214      <TD>Gets the number of lines to transfer to the buffer at once.</TD>
215    </TR>
216    <TR>
217      <TH nowrap width="25%"><A href="CAMERA_I2CContextSwitch.html" target="_self">CAMERA_I2CContextSwitch*</A></TH>
218      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
219      <TD>Switches the camera context.</TD>
220    </TR>
221    <TR>
222      <TH nowrap width="25%"><A href="CAMERA_SetLED.html" target="_self">CAMERA_SetLED*</A></TH>
223      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
224      <TD>Switches the outer camera LED between lit and blinking.</TD>
225    </TR>
226    <TR>
227      <TH nowrap width="25%"><A href="CAMERA_SwitchOffLED.html" target="_self">CAMERA_SwitchOffLED*</A></TH>
228      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
229      <TD>Turns off the outer camera LED for the duration of a single blink.</TD>
230    </TR>
231  </TBODY>
232</TABLE>
233
234<H3><A name="Utility">Utility Functions</A></H3>
235<TABLE border="1" width="100%">
236  <TBODY>
237    <TR>
238      <TH nowrap width="25%"><A href="CAMERA_SizeToWidth.html" target="_self">CAMERA_SizeToWidth</A></TH>
239      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
240      <TD>Returns the width of the specified camera resolution.</TD>
241    </TR>
242    <TR>
243      <TH nowrap width="25%"><A href="CAMERA_SizeToHeight.html" target="_self">CAMERA_SizeToHeight</A></TH>
244      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
245      <TD>Returns the height of the specified camera resolution.</TD>
246    </TR>
247    <TR>
248      <TH nowrap width="25%"><A href="CAMERA_SizeToPixels.html" target="_self">CAMERA_SizeToPixels</A></TH>
249      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
250      <TD>Returns the number of pixels for the specified camera resolution.</TD>
251    </TR>
252    <TR>
253      <TH nowrap width="25%"><A href="CAMERA_WidthHeightToSize.html" target="_self">CAMERA_WidthHeightToSize</A></TH>
254      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
255      <TD>Returns the camera resolution that corresponds to the specified width and height.</TD>
256    </TR>
257    <TR>
258      <TH nowrap width="25%"><A href="CAMERA_WidthToSize.html" target="_self">CAMERA_WidthToSize</A></TH>
259      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
260      <TD>Returns the camera resolution that corresponds to the specified width.</TD>
261    </TR>
262    <TR>
263      <TH nowrap width="25%"><A href="CAMERA_HeightToSize.html" target="_self">CAMERA_HeightToSize</A></TH>
264      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
265      <TD>Returns the camera resolution that corresponds to the specified height.</TD>
266    </TR>
267    <TR>
268      <TH nowrap width="25%"><A href="CAMERA_PixelsToSize.html" target="_self">CAMERA_PixelsToSize</A></TH>
269      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
270      <TD>Returns the camera resolution that corresponds to the specified number of pixels.</TD>
271    </TR>
272    <TR>
273      <TH nowrap width="25%"><A href="CAMERA_GetMaxLinesRound.html" target="_self">CAMERA_GetMaxLinesRound</A></TH>
274      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
275      <TD>Rounds the <A href="CAMERA_GET_MAX_LINES.html"><CODE>CAMERA_GET_MAX_LINES</CODE></A> value to one that is suitable for <A href="CAMERA_SetTransferLines.html"><CODE>CAMERA_SetTransferLines</CODE></A>.</TD>
276    </TR>
277    <TR>
278      <TH nowrap width="25%"><A href="CAMERA_GetBytesAtOnce.html" target="_self">CAMERA_GetBytesAtOnce</A></TH>
279      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
280      <TD>Returns the one-time transfer size when data is received from the camera buffer.</TD>
281    </TR>
282  </TBODY>
283</TABLE>
284
285<H3><A name="Macro">Macros</A></H3>
286<TABLE border="1" width="100%">
287  <TBODY>
288    <TR>
289      <TH nowrap width="25%"><A href="CAMERA_GET_MAX_LINES.html" target="_self">CAMERA_GET_MAX_LINES</A></TH>
290      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
291      <TD>Calculates the number of lines to transfer at once.</TD>
292    </TR>
293    <TR>
294      <TH nowrap width="25%"><A href="CAMERA_GET_LINE_BYTES.html" target="_self">CAMERA_GET_LINE_BYTES</A></TH>
295      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
296      <TD>Calculates the number of bytes to transfer with a single line.</TD>
297    </TR>
298    <TR>
299      <TH nowrap width="25%"><A href="CAMERA_GET_FRAME_BYTES.html" target="_self">CAMERA_GET_FRAME_BYTES</A></TH>
300      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
301      <TD>Calculates the number of bytes to transfer with a single frame.</TD>
302    </TR>
303  </TBODY>
304</TABLE>
305
306<H3><A name="Struct">Constants and Structures</A></H3>
307<TABLE border="1" width="100%">
308  <TBODY>
309    <TR>
310      <TH nowrap width="25%"><A href="CAMERASelect.html" target="_self">CAMERASelect</A></TH>
311      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
312      <TD>This is an enumerated type that is used to specify the camera.</TD>
313    </TR>
314    <TR>
315      <TH nowrap width="25%"><A href="CAMERAContext.html" target="_self">CAMERAContext</A></TH>
316      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
317      <TD>This is an enumerated type that is used to specify the camera setting context.</TD>
318    </TR>
319    <TR>
320      <TH nowrap width="25%"><A href="CAMERASize.html" target="_self">CAMERASize</A></TH>
321      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
322      <TD>This is an enumerated type that is used to specify the camera's resolution.</TD>
323    </TR>
324    <TR>
325      <TH nowrap width="25%"><A href="CAMERAEffect.html" target="_self">CAMERAEffect</A></TH>
326      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
327      <TD>This is an enumerated type that is used to specify the effects to apply to the camera's output data.</TD>
328    </TR>
329    <TR>
330      <TH nowrap width="25%"><A href="CAMERAFlip.html" target="_self">CAMERAFlip</A></TH>
331      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
332      <TD>This is an enumerated type that is used to specify flipping for the camera's output data.</TD>
333    </TR>
334    <TR>
335      <TH nowrap width="25%"><A href="CAMERAPhotoMode.html" target="_self">CAMERAPhotoMode</A></TH>
336      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
337      <TD>This is an enumerated type that is used to specify the camera's photo mode.</TD>
338    </TR>
339    <TR>
340      <TH nowrap width="25%"><A href="CAMERAWhiteBalance.html" target="_self">CAMERAWhiteBalance</A></TH>
341      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
342      <TD>This is an enumerated type that is used to specify the camera's white balance.</TD>
343    </TR>
344    <TR>
345      <TH nowrap width="25%"><A href="CAMERAFrameRate.html" target="_self">CAMERAFrameRate</A></TH>
346      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
347      <TD>This is an enumerated type that is used to specify the camera's frame rate.</TD>
348    </TR>
349    <TR>
350      <TH nowrap width="25%"><A href="CAMERAIntrVsync.html" target="_self">CAMERAIntrVsync</A></TH>
351      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
352      <TD>This enumerated type is used to specify when camera VSync interrupts will occur.</TD>
353    </TR>
354    <TR>
355      <TH nowrap width="25%"><A href="CAMERAOutput.html" target="_self">CAMERAOutput</A></TH>
356      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
357      <TD>This is an enumerated type that is used to specify the camera's output data format.</TD>
358    </TR>
359    <TR>
360      <TH nowrap width="25%"><A href="CAMERACallback.html" target="_self">CAMERACallback</A></TH>
361      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
362      <TD>This is the callback function type invoked when asynchronous camera processing has completed.</TD>
363    </TR>
364    <TR>
365      <TH nowrap width="25%"><A href="CAMERAIntrCallback.html" target="_self">CAMERAIntrCallback</A></TH>
366      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
367      <TD>This is the callback function type invoked when each kind of camera interrupt occurs.</TD>
368    </TR>
369    <TR>
370      <TH nowrap width="25%"><A href="CAMERAResult.html" target="_self">CAMERAResult</A></TH>
371      <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD>
372      <TD>This enumerated type indicates the result of a camera operation.</TD>
373    </TR>
374  </TBODY>
375</TABLE>
376
377<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table>
378
379<hr><p>CONFIDENTIAL</p></body>
380</HTML>
381