specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Projects Releases Packages Wiki Activity
USB_Host_Shield_2.0/class_p_s5_trigger.html
Lauszus f6fa1c03f9 deploy: 59cc3d287d
2022-12-15 10:52:18 +00:00

376 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: PS5Trigger Class Reference</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_p_s5_trigger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PS5Trigger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5cf79bb95535c3c540ef698921989691"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#a5cf79bb95535c3c540ef698921989691">processTrigger</a> (uint8_t *buffer)</td></tr>
<tr class="memdesc:a5cf79bb95535c3c540ef698921989691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply the trigger data to a PS5 update buffer. <a href="class_p_s5_trigger.html#a5cf79bb95535c3c540ef698921989691">More...</a><br /></td></tr>
<tr class="separator:a5cf79bb95535c3c540ef698921989691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad537a2d55a7d131e89e4257f015b741e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#ad537a2d55a7d131e89e4257f015b741e">Reset</a> ()</td></tr>
<tr class="separator:ad537a2d55a7d131e89e4257f015b741e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d5e773112d91bdae5163fc23fef53d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#a4d5e773112d91bdae5163fc23fef53d9">clearTriggerForce</a> ()</td></tr>
<tr class="separator:a4d5e773112d91bdae5163fc23fef53d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba3108980ad8e51c687f8b46f25d804"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#a2ba3108980ad8e51c687f8b46f25d804">setTriggerForce</a> (uint8_t start, uint8_t force)</td></tr>
<tr class="separator:a2ba3108980ad8e51c687f8b46f25d804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac9c57a1560f1b21cba5ec5dff1e7109"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#aac9c57a1560f1b21cba5ec5dff1e7109">setTriggerForceSection</a> (uint8_t start, uint8_t end)</td></tr>
<tr class="separator:aac9c57a1560f1b21cba5ec5dff1e7109"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf4dc1168b3a32da011813251dfa26da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#aaf4dc1168b3a32da011813251dfa26da">setTriggerForceEffect</a> (uint8_t start, bool keep, uint8_t begin_force, uint8_t mid_force, uint8_t end_force, uint8_t frequency)</td></tr>
<tr class="separator:aaf4dc1168b3a32da011813251dfa26da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae0267c7b60ebb176c54a42072647a866"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = false</td></tr>
<tr class="separator:ae0267c7b60ebb176c54a42072647a866"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00038">38</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5cf79bb95535c3c540ef698921989691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cf79bb95535c3c540ef698921989691">&#9670;&nbsp;</a></span>processTrigger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::processTrigger </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply the trigger data to a PS5 update buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>The buffer at the start offset for this trigger data </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8cpp_source.html#l00034">34</a> of file <a class="el" href="_p_s5_trigger_8cpp_source.html">PS5Trigger.cpp</a>.</p>
</div>
</div>
<a id="ad537a2d55a7d131e89e4257f015b741e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad537a2d55a7d131e89e4257f015b741e">&#9670;&nbsp;</a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear force feedback on trigger without report changed </p>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00100">100</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<a id="a4d5e773112d91bdae5163fc23fef53d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d5e773112d91bdae5163fc23fef53d9">&#9670;&nbsp;</a></span>clearTriggerForce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::clearTriggerForce </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear force feedback on trigger </p>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00109">109</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<a id="a2ba3108980ad8e51c687f8b46f25d804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ba3108980ad8e51c687f8b46f25d804">&#9670;&nbsp;</a></span>setTriggerForce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::setTriggerForce </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>force</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set continuous force feedback on trigger </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>0-255 trigger pull to start resisting </td></tr>
<tr><td class="paramname">force</td><td>The force amount </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00120">120</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<a id="aac9c57a1560f1b21cba5ec5dff1e7109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac9c57a1560f1b21cba5ec5dff1e7109">&#9670;&nbsp;</a></span>setTriggerForceSection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::setTriggerForceSection </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set section force feedback on trigger </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>trigger pull to start resisting </td></tr>
<tr><td class="paramname">end</td><td>trigger pull to stop resisting </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00137">137</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<a id="aaf4dc1168b3a32da011813251dfa26da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf4dc1168b3a32da011813251dfa26da">&#9670;&nbsp;</a></span>setTriggerForceEffect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PS5Trigger::setTriggerForceEffect </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>keep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>begin_force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mid_force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>end_force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>frequency</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set effect force feedback on trigger </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>trigger pull to start resisting </td></tr>
<tr><td class="paramname">keep</td><td>Keep effect active after max trigger pull </td></tr>
<tr><td class="paramname">begin_force</td><td>0-255 force at start position </td></tr>
<tr><td class="paramname">mid_force</td><td>0-255 force half way between start and max pull </td></tr>
<tr><td class="paramname">end_force</td><td>0-255 force at max pull </td></tr>
<tr><td class="paramname">frequency</td><td>Vibration frequency of the trigger </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00154">154</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0267c7b60ebb176c54a42072647a866"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0267c7b60ebb176c54a42072647a866">&#9670;&nbsp;</a></span>reportChanged</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PS5Trigger::reportChanged = false</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_p_s5_trigger_8h_source.html#l00088">88</a> of file <a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_p_s5_trigger_8h_source.html">PS5Trigger.h</a></li>
<li><a class="el" href="_p_s5_trigger_8cpp_source.html">PS5Trigger.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink