<!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.8"/>
<title>My Project: SDL_HapticEffect Union 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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> |
<a href="unionSDL__HapticEffect-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SDL_HapticEffect Union Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The generic template for any haptic effect.
<a href="unionSDL__HapticEffect.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SDL__haptic_8h_source.html">SDL_haptic.h</a>></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:a5ff6cfd8da91537091e9a6c2108cb179"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#a5ff6cfd8da91537091e9a6c2108cb179">type</a></td></tr>
<tr class="separator:a5ff6cfd8da91537091e9a6c2108cb179"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac435275e9683d6cc5d65b9c7cc2ec659"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticConstant.html">SDL_HapticConstant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#ac435275e9683d6cc5d65b9c7cc2ec659">constant</a></td></tr>
<tr class="separator:ac435275e9683d6cc5d65b9c7cc2ec659"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8320ec4db6ec1dc1d30feb62ee2a2f04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticPeriodic.html">SDL_HapticPeriodic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#a8320ec4db6ec1dc1d30feb62ee2a2f04">periodic</a></td></tr>
<tr class="separator:a8320ec4db6ec1dc1d30feb62ee2a2f04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8fdd1ba202ccd7e61f48ef9977080d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticCondition.html">SDL_HapticCondition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#aa8fdd1ba202ccd7e61f48ef9977080d2">condition</a></td></tr>
<tr class="separator:aa8fdd1ba202ccd7e61f48ef9977080d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d32ef4c2d1cc89dc938b392f6ad81bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticRamp.html">SDL_HapticRamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#a1d32ef4c2d1cc89dc938b392f6ad81bd">ramp</a></td></tr>
<tr class="separator:a1d32ef4c2d1cc89dc938b392f6ad81bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c254b81c1ff41c7888eee0cd0076a12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticLeftRight.html">SDL_HapticLeftRight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#a3c254b81c1ff41c7888eee0cd0076a12">leftright</a></td></tr>
<tr class="separator:a3c254b81c1ff41c7888eee0cd0076a12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b2d2af28c515cc39896b2b7c23019d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticCustom.html">SDL_HapticCustom</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__HapticEffect.html#a0b2d2af28c515cc39896b2b7c23019d2">custom</a></td></tr>
<tr class="separator:a0b2d2af28c515cc39896b2b7c23019d2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The generic template for any haptic effect. </p>
<p>All values max at 32767 (0x7FFF). Signed values also can be negative. Time values unless specified otherwise are in milliseconds.</p>
<p>You can also pass <a class="el" href="SDL__haptic_8h.html#a648896e9e14cb27fa8a4b6632d3f3882" title="Used to play a device an infinite number of times. ">SDL_HAPTIC_INFINITY</a> to length instead of a 0-32767 value. Neither delay, interval, attack_length nor fade_length support <a class="el" href="SDL__haptic_8h.html#a648896e9e14cb27fa8a4b6632d3f3882" title="Used to play a device an infinite number of times. ">SDL_HAPTIC_INFINITY</a>. Fade will also not be used since effect never ends.</p>
<p>Additionally, the <a class="el" href="SDL__haptic_8h.html#af10eb937a64a8f602e9c46682ac0d868" title="Ramp effect supported. ">SDL_HAPTIC_RAMP</a> effect does not support a duration of <a class="el" href="SDL__haptic_8h.html#a648896e9e14cb27fa8a4b6632d3f3882" title="Used to play a device an infinite number of times. ">SDL_HAPTIC_INFINITY</a>.</p>
<p>Button triggers may not be supported on all devices, it is advised to not use them if possible. Buttons start at index 1 instead of index 0 like the joystick.</p>
<p>If both attack_length and fade_level are 0, the envelope is not used, otherwise both values are used.</p>
<p>Common parts: </p><div class="fragment"><div class="line"><span class="comment">// Replay - All effects have this</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> length; <span class="comment">// Duration of effect (ms).</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> delay; <span class="comment">// Delay before starting effect.</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// Trigger - All effects have this</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> button; <span class="comment">// Button that triggers effect.</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> interval; <span class="comment">// How soon before effect can be triggered again.</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// Envelope - All effects except condition effects have this</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> attack_length; <span class="comment">// Duration of the attack (ms).</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> attack_level; <span class="comment">// Level at the start of the attack.</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> fade_length; <span class="comment">// Duration of the fade out (ms).</span></div>
<div class="line"><a class="code" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> fade_level; <span class="comment">// Level at the end of the fade.</span></div>
</div><!-- fragment --><p>Here we have an example of a constant effect evolution in time: </p><pre class="fragment">Strength
^
|
| effect level --> _________________
| / \
| / \
| / \
| / \
| attack_level --> | \
| | | <--- fade_level
|
+--------------------------------------------------> Time
[--] [---]
attack_length fade_length
[------------------][-----------------------]
delay length
</pre><p>Note either the attack_level or the fade_level may be above the actual effect level.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSDL__HapticConstant.html" title="A structure containing a template for a Constant effect. ">SDL_HapticConstant</a> </dd>
<dd>
<a class="el" href="structSDL__HapticPeriodic.html" title="A structure containing a template for a Periodic effect. ">SDL_HapticPeriodic</a> </dd>
<dd>
<a class="el" href="structSDL__HapticCondition.html" title="A structure containing a template for a Condition effect. ">SDL_HapticCondition</a> </dd>
<dd>
<a class="el" href="structSDL__HapticRamp.html" title="A structure containing a template for a Ramp effect. ">SDL_HapticRamp</a> </dd>
<dd>
<a class="el" href="structSDL__HapticLeftRight.html" title="A structure containing a template for a Left/Right effect. ">SDL_HapticLeftRight</a> </dd>
<dd>
<a class="el" href="structSDL__HapticCustom.html" title="A structure containing a template for the SDL_HAPTIC_CUSTOM effect. ">SDL_HapticCustom</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa8fdd1ba202ccd7e61f48ef9977080d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticCondition.html">SDL_HapticCondition</a> SDL_HapticEffect::condition</td>
</tr>
</table>
</div><div class="memdoc">
<p>Condition effect. </p>
</div>
</div>
<a class="anchor" id="ac435275e9683d6cc5d65b9c7cc2ec659"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticConstant.html">SDL_HapticConstant</a> SDL_HapticEffect::constant</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant effect. </p>
</div>
</div>
<a class="anchor" id="a0b2d2af28c515cc39896b2b7c23019d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticCustom.html">SDL_HapticCustom</a> SDL_HapticEffect::custom</td>
</tr>
</table>
</div><div class="memdoc">
<p>Custom effect. </p>
</div>
</div>
<a class="anchor" id="a3c254b81c1ff41c7888eee0cd0076a12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticLeftRight.html">SDL_HapticLeftRight</a> SDL_HapticEffect::leftright</td>
</tr>
</table>
</div><div class="memdoc">
<p>Left/Right effect. </p>
</div>
</div>
<a class="anchor" id="a8320ec4db6ec1dc1d30feb62ee2a2f04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticPeriodic.html">SDL_HapticPeriodic</a> SDL_HapticEffect::periodic</td>
</tr>
</table>
</div><div class="memdoc">
<p>Periodic effect. </p>
</div>
</div>
<a class="anchor" id="a1d32ef4c2d1cc89dc938b392f6ad81bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticRamp.html">SDL_HapticRamp</a> SDL_HapticEffect::ramp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ramp effect. </p>
</div>
</div>
<a class="anchor" id="a5ff6cfd8da91537091e9a6c2108cb179"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__stdinc_8h.html#a31fcc0a076c9068668173ee26d33e42b">Uint16</a> SDL_HapticEffect::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Effect type. </p>
</div>
</div>
<hr/>The documentation for this union 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 on Thu Oct 16 2014 16:33:09 for My Project by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
