Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
347
group___d_c_m_i___group1.html
Normal file
347
group___d_c_m_i___group1.html
Normal file
@@ -0,0 +1,347 @@
|
||||
<!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: Initialization and Configuration functions</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 Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related 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="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Initialization and Configuration functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> » <a class="el" href="group___d_c_m_i.html">DCMI</a> » <a class="el" href="group___d_c_m_i___private___functions.html">DCMI_Private_Functions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Initialization and Configuration functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Initialization and Configuration functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___d_c_m_i___group1.png" border="0" alt="" usemap="#group______d__c__m__i______group1"/>
|
||||
<map name="group______d__c__m__i______group1" id="group______d__c__m__i______group1">
|
||||
<area shape="rect" id="node2" href="group___d_c_m_i___private___functions.html" title="DCMI_Private_Functions" alt="" coords="5,13,169,39"/></map>
|
||||
</td></tr></table></center>
|
||||
</div>
|
||||
<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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.html#gab8f501f117d5695017e1dc5a611a5015">DCMI_DeInit</a> (void)</td></tr>
|
||||
<tr class="memdesc:gab8f501f117d5695017e1dc5a611a5015"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:ga1299076f1459525053ba4f2fa408ed2a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.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"> </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"> </td></tr>
|
||||
<tr class="memitem:ga268eb4266fe7f294ee748e86f7b8add2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.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"> </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"> </td></tr>
|
||||
<tr class="memitem:ga3bd4eb06314ed06dcb71ee91391b7ec4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.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"> </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"> </td></tr>
|
||||
<tr class="memitem:ga7139eecdc0f7975b42cd2f9c5644d0a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.html#ga7139eecdc0f7975b42cd2f9c5644d0a5">DCMI_CROPCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga7139eecdc0f7975b42cd2f9c5644d0a5"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:ga8888b27bd5aca62d250642468ea6cd6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.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"> </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"> </td></tr>
|
||||
<tr class="memitem:ga30a38a4858273c05e8f1b4677d744c13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_c_m_i___group1.html#ga30a38a4858273c05e8f1b4677d744c13">DCMI_JPEGCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga30a38a4858273c05e8f1b4677d744c13"><td class="mdescLeft"> </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"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Initialization and Configuration functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### Initialization and Configuration functions #####
|
||||
=============================================================================== </pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<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 </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> * </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 </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="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> * </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="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 </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="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> * </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> * </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  <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>
|
||||
Reference in New Issue
Block a user