Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > bf9e3bc1aec7873c087fb2ccd927873f > files > 426

sdl2-docs-2.0.10-1.mga7.noarch.rpm

<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: SDL_HapticPeriodic Struct 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" />
</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">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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');
/* @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="#pub-attribs">Public Attributes</a> &#124;
<a href="structSDL__HapticPeriodic-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SDL_HapticPeriodic Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A structure containing a template for a Periodic effect.  
 <a href="structSDL__HapticPeriodic.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="SDL__haptic_8h_source.html">SDL_haptic.h</a>&gt;</code></p>
<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:ac53c5725e8cff012e9b90e01b7110869"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#ac53c5725e8cff012e9b90e01b7110869">type</a></td></tr>
<tr class="separator:ac53c5725e8cff012e9b90e01b7110869"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c4f27d4583187a7a994e79ad49083d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticDirection.html">SDL_HapticDirection</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a2c4f27d4583187a7a994e79ad49083d3">direction</a></td></tr>
<tr class="separator:a2c4f27d4583187a7a994e79ad49083d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ef0b17c54aaa5c99886c2a618444026"><td class="memItemLeft" align="right" valign="top">Uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a0ef0b17c54aaa5c99886c2a618444026">length</a></td></tr>
<tr class="separator:a0ef0b17c54aaa5c99886c2a618444026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8688d1c7ee6270ed290f6b474aef5ec9"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a8688d1c7ee6270ed290f6b474aef5ec9">delay</a></td></tr>
<tr class="separator:a8688d1c7ee6270ed290f6b474aef5ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0177354f4a285b8c98e4a31cd31752"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a9e0177354f4a285b8c98e4a31cd31752">button</a></td></tr>
<tr class="separator:a9e0177354f4a285b8c98e4a31cd31752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a076d266e917098d89b2385b631629162"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a076d266e917098d89b2385b631629162">interval</a></td></tr>
<tr class="separator:a076d266e917098d89b2385b631629162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e7e105b96308129b248d52b56a2a839"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a0e7e105b96308129b248d52b56a2a839">period</a></td></tr>
<tr class="separator:a0e7e105b96308129b248d52b56a2a839"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad0ad2b00c7e6959da627663d91f7b94"><td class="memItemLeft" align="right" valign="top">Sint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#aad0ad2b00c7e6959da627663d91f7b94">magnitude</a></td></tr>
<tr class="separator:aad0ad2b00c7e6959da627663d91f7b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc7aa9e9c0d546cb54189a7812fbe554"><td class="memItemLeft" align="right" valign="top">Sint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#abc7aa9e9c0d546cb54189a7812fbe554">offset</a></td></tr>
<tr class="separator:abc7aa9e9c0d546cb54189a7812fbe554"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25e8c6aebc78bd74b9343fa228d25d8f"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a25e8c6aebc78bd74b9343fa228d25d8f">phase</a></td></tr>
<tr class="separator:a25e8c6aebc78bd74b9343fa228d25d8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab35eedce7107edc75640586159fe75bb"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#ab35eedce7107edc75640586159fe75bb">attack_length</a></td></tr>
<tr class="separator:ab35eedce7107edc75640586159fe75bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79fc2217fea6db6ab3d89ad905d52ccb"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#a79fc2217fea6db6ab3d89ad905d52ccb">attack_level</a></td></tr>
<tr class="separator:a79fc2217fea6db6ab3d89ad905d52ccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c186d02304eae142a62dca72f50fa8"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#ae1c186d02304eae142a62dca72f50fa8">fade_length</a></td></tr>
<tr class="separator:ae1c186d02304eae142a62dca72f50fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa7713fc264959873f2a852fca4174fd"><td class="memItemLeft" align="right" valign="top">Uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticPeriodic.html#afa7713fc264959873f2a852fca4174fd">fade_level</a></td></tr>
<tr class="separator:afa7713fc264959873f2a852fca4174fd"><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>A structure containing a template for a Periodic effect. </p>
<p>The struct handles the following effects:</p><ul>
<li><a class="el" href="SDL__haptic_8h.html#aa6d75adbfcdda5075078e7a2849da5c0" title="Sine wave effect supported.">SDL_HAPTIC_SINE</a></li>
<li><a class="el" href="SDL__haptic_8h.html#ae047624d8458ff6400887c37a36f86d3" title="Left/Right effect supported.">SDL_HAPTIC_LEFTRIGHT</a></li>
<li><a class="el" href="SDL__haptic_8h.html#ae8123eaa51511507375ba6ef9220fa46" title="Triangle wave effect supported.">SDL_HAPTIC_TRIANGLE</a></li>
<li><a class="el" href="SDL__haptic_8h.html#ab8e3f40f3c2bcee8905d13b634363c3f" title="Sawtoothup wave effect supported.">SDL_HAPTIC_SAWTOOTHUP</a></li>
<li><a class="el" href="SDL__haptic_8h.html#afd64aa747034a7ccf4b55f6246525701" title="Sawtoothdown wave effect supported.">SDL_HAPTIC_SAWTOOTHDOWN</a></li>
</ul>
<p>A periodic effect consists in a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the parameters determine the dimensions of the wave.</p>
<p>Phase is given by hundredth of a degree meaning that giving the phase a value of 9000 will displace it 25% of its period. Here are sample values:</p><ul>
<li>0: No phase displacement.</li>
<li>9000: Displaced 25% of its period.</li>
<li>18000: Displaced 50% of its period.</li>
<li>27000: Displaced 75% of its period.</li>
<li>36000: Displaced 100% of its period, same as 0, but 0 is preferred.</li>
</ul>
<p>Examples: </p><pre class="fragment">SDL_HAPTIC_SINE
  __      __      __      __
 /  \    /  \    /  \    /
/    \__/    \__/    \__/

SDL_HAPTIC_SQUARE
 __    __    __    __    __
|  |  |  |  |  |  |  |  |  |
|  |__|  |__|  |__|  |__|  |

SDL_HAPTIC_TRIANGLE
  /\    /\    /\    /\    /\
 /  \  /  \  /  \  /  \  /
/    \/    \/    \/    \/

SDL_HAPTIC_SAWTOOTHUP
  /|  /|  /|  /|  /|  /|  /|
 / | / | / | / | / | / | / |
/  |/  |/  |/  |/  |/  |/  |

SDL_HAPTIC_SAWTOOTHDOWN
\  |\  |\  |\  |\  |\  |\  |
 \ | \ | \ | \ | \ | \ | \ |
  \|  \|  \|  \|  \|  \|  \|
</pre><dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__haptic_8h.html#aa6d75adbfcdda5075078e7a2849da5c0" title="Sine wave effect supported.">SDL_HAPTIC_SINE</a> </dd>
<dd>
<a class="el" href="SDL__haptic_8h.html#ae047624d8458ff6400887c37a36f86d3" title="Left/Right effect supported.">SDL_HAPTIC_LEFTRIGHT</a> </dd>
<dd>
<a class="el" href="SDL__haptic_8h.html#ae8123eaa51511507375ba6ef9220fa46" title="Triangle wave effect supported.">SDL_HAPTIC_TRIANGLE</a> </dd>
<dd>
<a class="el" href="SDL__haptic_8h.html#ab8e3f40f3c2bcee8905d13b634363c3f" title="Sawtoothup wave effect supported.">SDL_HAPTIC_SAWTOOTHUP</a> </dd>
<dd>
<a class="el" href="SDL__haptic_8h.html#afd64aa747034a7ccf4b55f6246525701" title="Sawtoothdown wave effect supported.">SDL_HAPTIC_SAWTOOTHDOWN</a> </dd>
<dd>
<a class="el" href="unionSDL__HapticEffect.html" title="The generic template for any haptic effect.">SDL_HapticEffect</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ab35eedce7107edc75640586159fe75bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab35eedce7107edc75640586159fe75bb">&#9670;&nbsp;</a></span>attack_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::attack_length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Duration of the attack. </p>

</div>
</div>
<a id="a79fc2217fea6db6ab3d89ad905d52ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79fc2217fea6db6ab3d89ad905d52ccb">&#9670;&nbsp;</a></span>attack_level</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::attack_level</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Level at the start of the attack. </p>

</div>
</div>
<a id="a9e0177354f4a285b8c98e4a31cd31752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e0177354f4a285b8c98e4a31cd31752">&#9670;&nbsp;</a></span>button</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::button</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Button that triggers the effect. </p>

</div>
</div>
<a id="a8688d1c7ee6270ed290f6b474aef5ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8688d1c7ee6270ed290f6b474aef5ec9">&#9670;&nbsp;</a></span>delay</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::delay</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Delay before starting the effect. </p>

</div>
</div>
<a id="a2c4f27d4583187a7a994e79ad49083d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c4f27d4583187a7a994e79ad49083d3">&#9670;&nbsp;</a></span>direction</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structSDL__HapticDirection.html">SDL_HapticDirection</a> SDL_HapticPeriodic::direction</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Direction of the effect. </p>

</div>
</div>
<a id="ae1c186d02304eae142a62dca72f50fa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1c186d02304eae142a62dca72f50fa8">&#9670;&nbsp;</a></span>fade_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::fade_length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Duration of the fade. </p>

</div>
</div>
<a id="afa7713fc264959873f2a852fca4174fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa7713fc264959873f2a852fca4174fd">&#9670;&nbsp;</a></span>fade_level</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::fade_level</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Level at the end of the fade. </p>

</div>
</div>
<a id="a076d266e917098d89b2385b631629162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a076d266e917098d89b2385b631629162">&#9670;&nbsp;</a></span>interval</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::interval</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>How soon it can be triggered again after button. </p>

</div>
</div>
<a id="a0ef0b17c54aaa5c99886c2a618444026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ef0b17c54aaa5c99886c2a618444026">&#9670;&nbsp;</a></span>length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint32 SDL_HapticPeriodic::length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Duration of the effect. </p>

</div>
</div>
<a id="aad0ad2b00c7e6959da627663d91f7b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad0ad2b00c7e6959da627663d91f7b94">&#9670;&nbsp;</a></span>magnitude</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Sint16 SDL_HapticPeriodic::magnitude</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Peak value; if negative, equivalent to 180 degrees extra phase shift. </p>

</div>
</div>
<a id="abc7aa9e9c0d546cb54189a7812fbe554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc7aa9e9c0d546cb54189a7812fbe554">&#9670;&nbsp;</a></span>offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Sint16 SDL_HapticPeriodic::offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Mean value of the wave. </p>

</div>
</div>
<a id="a0e7e105b96308129b248d52b56a2a839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e7e105b96308129b248d52b56a2a839">&#9670;&nbsp;</a></span>period</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::period</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Period of the wave. </p>

</div>
</div>
<a id="a25e8c6aebc78bd74b9343fa228d25d8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25e8c6aebc78bd74b9343fa228d25d8f">&#9670;&nbsp;</a></span>phase</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::phase</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Positive phase shift given by hundredth of a degree. </p>

</div>
</div>
<a id="ac53c5725e8cff012e9b90e01b7110869"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac53c5725e8cff012e9b90e01b7110869">&#9670;&nbsp;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint16 SDL_HapticPeriodic::type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="SDL__haptic_8h.html#aa6d75adbfcdda5075078e7a2849da5c0" title="Sine wave effect supported.">SDL_HAPTIC_SINE</a>, <a class="el" href="SDL__haptic_8h.html#ae047624d8458ff6400887c37a36f86d3" title="Left/Right effect supported.">SDL_HAPTIC_LEFTRIGHT</a>, <a class="el" href="SDL__haptic_8h.html#ae8123eaa51511507375ba6ef9220fa46" title="Triangle wave effect supported.">SDL_HAPTIC_TRIANGLE</a>, <a class="el" href="SDL__haptic_8h.html#ab8e3f40f3c2bcee8905d13b634363c3f" title="Sawtoothup wave effect supported.">SDL_HAPTIC_SAWTOOTHUP</a> or <a class="el" href="SDL__haptic_8h.html#afd64aa747034a7ccf4b55f6246525701" title="Sawtoothdown wave effect supported.">SDL_HAPTIC_SAWTOOTHDOWN</a> </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="SDL__haptic_8h_source.html">SDL_haptic.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional