Files
discoverpixy/group___d_c_m_i.html
2015-05-12 11:12:43 +02:00

685 lines
34 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>discoverpixy: DCMI</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DCMI<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>DCMI driver modules.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for DCMI:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___d_c_m_i.png" border="0" alt="" usemap="#group______d__c__m__i"/>
<map name="group______d__c__m__i" id="group______d__c__m__i">
<area shape="rect" id="node1" href="group___d_c_m_i___exported___constants.html" title="DCMI_Exported_Constants" alt="" coords="312,5,491,32"/><area shape="rect" id="node4" href="group___d_c_m_i___private___functions.html" title="DCMI_Private_Functions" alt="" coords="319,56,483,83"/><area shape="rect" id="node3" href="group___s_t_m32_f4xx___std_periph___driver.html" title="STM32F4xx_StdPeriph\l_Driver" alt="" coords="5,23,161,65"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group___d_c_m_i___exported___constants"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___exported___constants.html">DCMI_Exported_Constants</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group___d_c_m_i___private___functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___private___functions.html">DCMI_Private_Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d_c_m_i___init_type_def.html">DCMI_InitTypeDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">DCMI Init structure definition. <a href="struct_d_c_m_i___init_type_def.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d_c_m_i___c_r_o_p_init_type_def.html">DCMI_CROPInitTypeDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">DCMI CROP Init structure definition. <a href="struct_d_c_m_i___c_r_o_p_init_type_def.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d_c_m_i___codes_init_type_def.html">DCMI_CodesInitTypeDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">DCMI Embedded Synchronisation CODE Init structure definition. <a href="struct_d_c_m_i___codes_init_type_def.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab8f501f117d5695017e1dc5a611a5015"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#gab8f501f117d5695017e1dc5a611a5015">DCMI_DeInit</a> (void)</td></tr>
<tr class="memdesc:gab8f501f117d5695017e1dc5a611a5015"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitializes the DCMI registers to their default reset values. <a href="#gab8f501f117d5695017e1dc5a611a5015">More...</a><br /></td></tr>
<tr class="separator:gab8f501f117d5695017e1dc5a611a5015"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1299076f1459525053ba4f2fa408ed2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga1299076f1459525053ba4f2fa408ed2a">DCMI_Init</a> (<a class="el" href="struct_d_c_m_i___init_type_def.html">DCMI_InitTypeDef</a> *DCMI_InitStruct)</td></tr>
<tr class="memdesc:ga1299076f1459525053ba4f2fa408ed2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the DCMI according to the specified parameters in the DCMI_InitStruct. <a href="#ga1299076f1459525053ba4f2fa408ed2a">More...</a><br /></td></tr>
<tr class="separator:ga1299076f1459525053ba4f2fa408ed2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga268eb4266fe7f294ee748e86f7b8add2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga268eb4266fe7f294ee748e86f7b8add2">DCMI_StructInit</a> (<a class="el" href="struct_d_c_m_i___init_type_def.html">DCMI_InitTypeDef</a> *DCMI_InitStruct)</td></tr>
<tr class="memdesc:ga268eb4266fe7f294ee748e86f7b8add2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each DCMI_InitStruct member with its default value. <a href="#ga268eb4266fe7f294ee748e86f7b8add2">More...</a><br /></td></tr>
<tr class="separator:ga268eb4266fe7f294ee748e86f7b8add2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3bd4eb06314ed06dcb71ee91391b7ec4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga3bd4eb06314ed06dcb71ee91391b7ec4">DCMI_CROPConfig</a> (<a class="el" href="struct_d_c_m_i___c_r_o_p_init_type_def.html">DCMI_CROPInitTypeDef</a> *DCMI_CROPInitStruct)</td></tr>
<tr class="memdesc:ga3bd4eb06314ed06dcb71ee91391b7ec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the DCMI peripheral CROP mode according to the specified parameters in the DCMI_CROPInitStruct. <a href="#ga3bd4eb06314ed06dcb71ee91391b7ec4">More...</a><br /></td></tr>
<tr class="separator:ga3bd4eb06314ed06dcb71ee91391b7ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7139eecdc0f7975b42cd2f9c5644d0a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga7139eecdc0f7975b42cd2f9c5644d0a5">DCMI_CROPCmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:ga7139eecdc0f7975b42cd2f9c5644d0a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DCMI Crop feature. <a href="#ga7139eecdc0f7975b42cd2f9c5644d0a5">More...</a><br /></td></tr>
<tr class="separator:ga7139eecdc0f7975b42cd2f9c5644d0a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8888b27bd5aca62d250642468ea6cd6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga8888b27bd5aca62d250642468ea6cd6d">DCMI_SetEmbeddedSynchroCodes</a> (<a class="el" href="struct_d_c_m_i___codes_init_type_def.html">DCMI_CodesInitTypeDef</a> *DCMI_CodesInitStruct)</td></tr>
<tr class="memdesc:ga8888b27bd5aca62d250642468ea6cd6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the embedded synchronization codes. <a href="#ga8888b27bd5aca62d250642468ea6cd6d">More...</a><br /></td></tr>
<tr class="separator:ga8888b27bd5aca62d250642468ea6cd6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30a38a4858273c05e8f1b4677d744c13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga30a38a4858273c05e8f1b4677d744c13">DCMI_JPEGCmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:ga30a38a4858273c05e8f1b4677d744c13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DCMI JPEG format. <a href="#ga30a38a4858273c05e8f1b4677d744c13">More...</a><br /></td></tr>
<tr class="separator:ga30a38a4858273c05e8f1b4677d744c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36bba54c40637b8071aea8ffea71fb84"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga36bba54c40637b8071aea8ffea71fb84">DCMI_Cmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:ga36bba54c40637b8071aea8ffea71fb84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DCMI interface. <a href="#ga36bba54c40637b8071aea8ffea71fb84">More...</a><br /></td></tr>
<tr class="separator:ga36bba54c40637b8071aea8ffea71fb84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad00fb33497ffa337a5b2b77fc6aa8d74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#gad00fb33497ffa337a5b2b77fc6aa8d74">DCMI_CaptureCmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:gad00fb33497ffa337a5b2b77fc6aa8d74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DCMI Capture. <a href="#gad00fb33497ffa337a5b2b77fc6aa8d74">More...</a><br /></td></tr>
<tr class="separator:gad00fb33497ffa337a5b2b77fc6aa8d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga475305bd8694e4cebefcb263c0a5b979"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga475305bd8694e4cebefcb263c0a5b979">DCMI_ReadData</a> (void)</td></tr>
<tr class="memdesc:ga475305bd8694e4cebefcb263c0a5b979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the data stored in the DR register. <a href="#ga475305bd8694e4cebefcb263c0a5b979">More...</a><br /></td></tr>
<tr class="separator:ga475305bd8694e4cebefcb263c0a5b979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3d89fb10384dff1dfd9197fbb6c6b2eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga3d89fb10384dff1dfd9197fbb6c6b2eb">DCMI_ITConfig</a> (uint16_t DCMI_IT, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga3d89fb10384dff1dfd9197fbb6c6b2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DCMI interface interrupts. <a href="#ga3d89fb10384dff1dfd9197fbb6c6b2eb">More...</a><br /></td></tr>
<tr class="separator:ga3d89fb10384dff1dfd9197fbb6c6b2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b66e1966fbea902a8e7015c56db7587"><td class="memItemLeft" align="right" valign="top">FlagStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga1b66e1966fbea902a8e7015c56db7587">DCMI_GetFlagStatus</a> (uint16_t DCMI_FLAG)</td></tr>
<tr class="memdesc:ga1b66e1966fbea902a8e7015c56db7587"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the DCMI interface flag is set or not. <a href="#ga1b66e1966fbea902a8e7015c56db7587">More...</a><br /></td></tr>
<tr class="separator:ga1b66e1966fbea902a8e7015c56db7587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c93caf3ccfecf07cec8e1e0f844ddaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga1c93caf3ccfecf07cec8e1e0f844ddaa">DCMI_ClearFlag</a> (uint16_t DCMI_FLAG)</td></tr>
<tr class="memdesc:ga1c93caf3ccfecf07cec8e1e0f844ddaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the DCMI's pending flags. <a href="#ga1c93caf3ccfecf07cec8e1e0f844ddaa">More...</a><br /></td></tr>
<tr class="separator:ga1c93caf3ccfecf07cec8e1e0f844ddaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0b27821aab3ee6b73ae8a6c6339fed5"><td class="memItemLeft" align="right" valign="top">ITStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#gac0b27821aab3ee6b73ae8a6c6339fed5">DCMI_GetITStatus</a> (uint16_t DCMI_IT)</td></tr>
<tr class="memdesc:gac0b27821aab3ee6b73ae8a6c6339fed5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the DCMI interrupt has occurred or not. <a href="#gac0b27821aab3ee6b73ae8a6c6339fed5">More...</a><br /></td></tr>
<tr class="separator:gac0b27821aab3ee6b73ae8a6c6339fed5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga908e6dad7bc5f4f4bbc512f679222c55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i.html#ga908e6dad7bc5f4f4bbc512f679222c55">DCMI_ClearITPendingBit</a> (uint16_t DCMI_IT)</td></tr>
<tr class="memdesc:ga908e6dad7bc5f4f4bbc512f679222c55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the DCMI's interrupt pending bits. <a href="#ga908e6dad7bc5f4f4bbc512f679222c55">More...</a><br /></td></tr>
<tr class="separator:ga908e6dad7bc5f4f4bbc512f679222c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>DCMI driver modules. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad00fb33497ffa337a5b2b77fc6aa8d74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_CaptureCmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the DCMI Capture. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of the DCMI capture. This parameter can be: ENABLE or DISABLE. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1c93caf3ccfecf07cec8e1e0f844ddaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_ClearFlag </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>DCMI_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the DCMI's pending flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_FLAG</td><td>specifies the flag to clear. This parameter can be any combination of the following values: <ul>
<li>DCMI_FLAG_FRAMERI: Frame capture complete Raw flag mask </li>
<li>DCMI_FLAG_OVFRI: Overflow Raw flag mask </li>
<li>DCMI_FLAG_ERRRI: Synchronization error Raw flag mask </li>
<li>DCMI_FLAG_VSYNCRI: VSYNC Raw flag mask </li>
<li>DCMI_FLAG_LINERI: <a class="el" href="struct_line.html">Line</a> Raw flag mask </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga908e6dad7bc5f4f4bbc512f679222c55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_ClearITPendingBit </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>DCMI_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the DCMI's interrupt pending bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_IT</td><td>specifies the DCMI interrupt pending bit to clear. This parameter can be any combination of the following values: <ul>
<li>DCMI_IT_FRAME: Frame capture complete interrupt mask </li>
<li>DCMI_IT_OVF: Overflow interrupt mask </li>
<li>DCMI_IT_ERR: Synchronization error interrupt mask </li>
<li>DCMI_IT_VSYNC: VSYNC interrupt mask </li>
<li>DCMI_IT_LINE: <a class="el" href="struct_line.html">Line</a> interrupt mask </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga36bba54c40637b8071aea8ffea71fb84"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_Cmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the DCMI interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of the DCMI interface. This parameter can be: ENABLE or DISABLE. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7139eecdc0f7975b42cd2f9c5644d0a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_CROPCmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the DCMI Crop feature. </p>
<dl class="section note"><dt>Note</dt><dd>This function should be called before to enable and start the DCMI interface. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of the DCMI Crop feature. This parameter can be: ENABLE or DISABLE. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3bd4eb06314ed06dcb71ee91391b7ec4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_CROPConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_d_c_m_i___c_r_o_p_init_type_def.html">DCMI_CROPInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>DCMI_CROPInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the DCMI peripheral CROP mode according to the specified parameters in the DCMI_CROPInitStruct. </p>
<dl class="section note"><dt>Note</dt><dd>This function should be called before to enable and start the DCMI interface. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_CROPInitStruct</td><td>pointer to a <a class="el" href="struct_d_c_m_i___c_r_o_p_init_type_def.html" title="DCMI CROP Init structure definition. ">DCMI_CROPInitTypeDef</a> structure that contains the configuration information for the DCMI peripheral CROP mode. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab8f501f117d5695017e1dc5a611a5015"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_DeInit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitializes the DCMI registers to their default reset values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1b66e1966fbea902a8e7015c56db7587"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FlagStatus DCMI_GetFlagStatus </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>DCMI_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the DCMI interface flag is set or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
<li>DCMI_FLAG_FRAMERI: Frame capture complete Raw flag mask </li>
<li>DCMI_FLAG_OVFRI: Overflow Raw flag mask </li>
<li>DCMI_FLAG_ERRRI: Synchronization error Raw flag mask </li>
<li>DCMI_FLAG_VSYNCRI: VSYNC Raw flag mask </li>
<li>DCMI_FLAG_LINERI: <a class="el" href="struct_line.html">Line</a> Raw flag mask </li>
<li>DCMI_FLAG_FRAMEMI: Frame capture complete Masked flag mask </li>
<li>DCMI_FLAG_OVFMI: Overflow Masked flag mask </li>
<li>DCMI_FLAG_ERRMI: Synchronization error Masked flag mask </li>
<li>DCMI_FLAG_VSYNCMI: VSYNC Masked flag mask </li>
<li>DCMI_FLAG_LINEMI: <a class="el" href="struct_line.html">Line</a> Masked flag mask </li>
<li>DCMI_FLAG_HSYNC: HSYNC flag mask </li>
<li>DCMI_FLAG_VSYNC: VSYNC flag mask </li>
<li>DCMI_FLAG_FNE: Fifo not empty flag mask </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">The</td><td>new state of DCMI_FLAG (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac0b27821aab3ee6b73ae8a6c6339fed5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ITStatus DCMI_GetITStatus </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>DCMI_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the DCMI interrupt has occurred or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_IT</td><td>specifies the DCMI interrupt source to check. This parameter can be one of the following values: <ul>
<li>DCMI_IT_FRAME: Frame capture complete interrupt mask </li>
<li>DCMI_IT_OVF: Overflow interrupt mask </li>
<li>DCMI_IT_ERR: Synchronization error interrupt mask </li>
<li>DCMI_IT_VSYNC: VSYNC interrupt mask </li>
<li>DCMI_IT_LINE: <a class="el" href="struct_line.html">Line</a> interrupt mask </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">The</td><td>new state of DCMI_IT (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1299076f1459525053ba4f2fa408ed2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_Init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_d_c_m_i___init_type_def.html">DCMI_InitTypeDef</a> *&#160;</td>
<td class="paramname"><em>DCMI_InitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the DCMI according to the specified parameters in the DCMI_InitStruct. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_InitStruct</td><td>pointer to a <a class="el" href="struct_d_c_m_i___init_type_def.html" title="DCMI Init structure definition. ">DCMI_InitTypeDef</a> structure that contains the configuration information for the DCMI. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3d89fb10384dff1dfd9197fbb6c6b2eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_ITConfig </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>DCMI_IT</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the DCMI interface interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_IT</td><td>specifies the DCMI interrupt sources to be enabled or disabled. This parameter can be any combination of the following values: <ul>
<li>DCMI_IT_FRAME: Frame capture complete interrupt mask </li>
<li>DCMI_IT_OVF: Overflow interrupt mask </li>
<li>DCMI_IT_ERR: Synchronization error interrupt mask </li>
<li>DCMI_IT_VSYNC: VSYNC interrupt mask </li>
<li>DCMI_IT_LINE: <a class="el" href="struct_line.html">Line</a> interrupt mask </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the specified DCMI interrupts. This parameter can be: ENABLE or DISABLE. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga30a38a4858273c05e8f1b4677d744c13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_JPEGCmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the DCMI JPEG format. </p>
<dl class="section note"><dt>Note</dt><dd>The Crop and Embedded Synchronization features cannot be used in this mode. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of the DCMI JPEG format. This parameter can be: ENABLE or DISABLE. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga475305bd8694e4cebefcb263c0a5b979"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DCMI_ReadData </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the data stored in the DR register. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">Data</td><td>register value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8888b27bd5aca62d250642468ea6cd6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_SetEmbeddedSynchroCodes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_d_c_m_i___codes_init_type_def.html">DCMI_CodesInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>DCMI_CodesInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the embedded synchronization codes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname"><a class="el" href="struct_d_c_m_i___codes_init_type_def.html" title="DCMI Embedded Synchronisation CODE Init structure definition. ">DCMI_CodesInitTypeDef</a></td><td>pointer to a <a class="el" href="struct_d_c_m_i___codes_init_type_def.html" title="DCMI Embedded Synchronisation CODE Init structure definition. ">DCMI_CodesInitTypeDef</a> structure that contains the embedded synchronization codes for the DCMI peripheral. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga268eb4266fe7f294ee748e86f7b8add2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DCMI_StructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_d_c_m_i___init_type_def.html">DCMI_InitTypeDef</a> *&#160;</td>
<td class="paramname"><em>DCMI_InitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each DCMI_InitStruct member with its default value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DCMI_InitStruct</td><td>: pointer to a <a class="el" href="struct_d_c_m_i___init_type_def.html" title="DCMI Init structure definition. ">DCMI_InitTypeDef</a> structure which will be initialized. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:19 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>