<!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_HapticRamp 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/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="structSDL__HapticRamp-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SDL_HapticRamp Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure containing a template for a Ramp effect.
<a href="structSDL__HapticRamp.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:aca1c2349372433822ab62f60976640aa"><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="structSDL__HapticRamp.html#aca1c2349372433822ab62f60976640aa">type</a></td></tr>
<tr class="separator:aca1c2349372433822ab62f60976640aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fb6c67ccf262b8f3ec08bcdf08f9965"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDL__HapticDirection.html">SDL_HapticDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticRamp.html#a6fb6c67ccf262b8f3ec08bcdf08f9965">direction</a></td></tr>
<tr class="separator:a6fb6c67ccf262b8f3ec08bcdf08f9965"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57e75237507701405af2a3caf34cdb5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticRamp.html#a57e75237507701405af2a3caf34cdb5a">length</a></td></tr>
<tr class="separator:a57e75237507701405af2a3caf34cdb5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9471016f41919b4a1c786bbd649a777"><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="structSDL__HapticRamp.html#ac9471016f41919b4a1c786bbd649a777">delay</a></td></tr>
<tr class="separator:ac9471016f41919b4a1c786bbd649a777"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2027c6fd88f1ebe652c90c71410ee0bf"><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="structSDL__HapticRamp.html#a2027c6fd88f1ebe652c90c71410ee0bf">button</a></td></tr>
<tr class="separator:a2027c6fd88f1ebe652c90c71410ee0bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b89d108cfa7e96ea58b58771334c33d"><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="structSDL__HapticRamp.html#a4b89d108cfa7e96ea58b58771334c33d">interval</a></td></tr>
<tr class="separator:a4b89d108cfa7e96ea58b58771334c33d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0e813ac6399290fd4a788d2471e8d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__stdinc_8h.html#a9d0257032c0e146ab6121bf0122712f5">Sint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticRamp.html#acc0e813ac6399290fd4a788d2471e8d4">start</a></td></tr>
<tr class="separator:acc0e813ac6399290fd4a788d2471e8d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16dd3ee307795248e21ee45ba8fb4c6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__stdinc_8h.html#a9d0257032c0e146ab6121bf0122712f5">Sint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticRamp.html#a16dd3ee307795248e21ee45ba8fb4c6c">end</a></td></tr>
<tr class="separator:a16dd3ee307795248e21ee45ba8fb4c6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbcd7ffb05016d442c73e81cc0fcbbd2"><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="structSDL__HapticRamp.html#adbcd7ffb05016d442c73e81cc0fcbbd2">attack_length</a></td></tr>
<tr class="separator:adbcd7ffb05016d442c73e81cc0fcbbd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a755933bbda14ae9b53c574b9fe6291a0"><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="structSDL__HapticRamp.html#a755933bbda14ae9b53c574b9fe6291a0">attack_level</a></td></tr>
<tr class="separator:a755933bbda14ae9b53c574b9fe6291a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad58a8f7cfdf659b45f0503fc56db7436"><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="structSDL__HapticRamp.html#ad58a8f7cfdf659b45f0503fc56db7436">fade_length</a></td></tr>
<tr class="separator:ad58a8f7cfdf659b45f0503fc56db7436"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66b586f2e6a23a085a7b2854f61752c5"><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="structSDL__HapticRamp.html#a66b586f2e6a23a085a7b2854f61752c5">fade_level</a></td></tr>
<tr class="separator:a66b586f2e6a23a085a7b2854f61752c5"><td class="memSeparator" colspan="2"> </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 Ramp effect. </p>
<p>This struct is exclusively for the <a class="el" href="SDL__haptic_8h.html#af10eb937a64a8f602e9c46682ac0d868" title="Ramp effect supported. ">SDL_HAPTIC_RAMP</a> effect.</p>
<p>The ramp effect starts at start strength and ends at end strength. It augments in linear fashion. If you use attack and fade with a ramp the effects get added to the ramp effect making the effect become quadratic instead of linear.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__haptic_8h.html#af10eb937a64a8f602e9c46682ac0d868" title="Ramp effect supported. ">SDL_HAPTIC_RAMP</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 class="anchor" id="adbcd7ffb05016d442c73e81cc0fcbbd2"></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_HapticRamp::attack_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration of the attack. </p>
</div>
</div>
<a class="anchor" id="a755933bbda14ae9b53c574b9fe6291a0"></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_HapticRamp::attack_level</td>
</tr>
</table>
</div><div class="memdoc">
<p>Level at the start of the attack. </p>
</div>
</div>
<a class="anchor" id="a2027c6fd88f1ebe652c90c71410ee0bf"></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_HapticRamp::button</td>
</tr>
</table>
</div><div class="memdoc">
<p>Button that triggers the effect. </p>
</div>
</div>
<a class="anchor" id="ac9471016f41919b4a1c786bbd649a777"></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_HapticRamp::delay</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay before starting the effect. </p>
</div>
</div>
<a class="anchor" id="a6fb6c67ccf262b8f3ec08bcdf08f9965"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSDL__HapticDirection.html">SDL_HapticDirection</a> SDL_HapticRamp::direction</td>
</tr>
</table>
</div><div class="memdoc">
<p>Direction of the effect. </p>
</div>
</div>
<a class="anchor" id="a16dd3ee307795248e21ee45ba8fb4c6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__stdinc_8h.html#a9d0257032c0e146ab6121bf0122712f5">Sint16</a> SDL_HapticRamp::end</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ending strength level. </p>
</div>
</div>
<a class="anchor" id="ad58a8f7cfdf659b45f0503fc56db7436"></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_HapticRamp::fade_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration of the fade. </p>
</div>
</div>
<a class="anchor" id="a66b586f2e6a23a085a7b2854f61752c5"></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_HapticRamp::fade_level</td>
</tr>
</table>
</div><div class="memdoc">
<p>Level at the end of the fade. </p>
</div>
</div>
<a class="anchor" id="a4b89d108cfa7e96ea58b58771334c33d"></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_HapticRamp::interval</td>
</tr>
</table>
</div><div class="memdoc">
<p>How soon it can be triggered again after button. </p>
</div>
</div>
<a class="anchor" id="a57e75237507701405af2a3caf34cdb5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> SDL_HapticRamp::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration of the effect. </p>
</div>
</div>
<a class="anchor" id="acc0e813ac6399290fd4a788d2471e8d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__stdinc_8h.html#a9d0257032c0e146ab6121bf0122712f5">Sint16</a> SDL_HapticRamp::start</td>
</tr>
</table>
</div><div class="memdoc">
<p>Beginning strength level. </p>
</div>
</div>
<a class="anchor" id="aca1c2349372433822ab62f60976640aa"></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_HapticRamp::type</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="SDL__haptic_8h.html#af10eb937a64a8f602e9c46682ac0d868" title="Ramp effect supported. ">SDL_HAPTIC_RAMP</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 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>
