<!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_HapticCustom 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__HapticCustom-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">SDL_HapticCustom Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>A structure containing a template for the <a class="el" href="SDL__haptic_8h.html#a8a18c4de1076ac9bebd718329d16db29" title="Custom effect is supported. ">SDL_HAPTIC_CUSTOM</a> effect. <a href="structSDL__HapticCustom.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:a98a8995c94492069dc007502ed97eed2"><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__HapticCustom.html#a98a8995c94492069dc007502ed97eed2">type</a></td></tr> <tr class="separator:a98a8995c94492069dc007502ed97eed2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad7eb84f59404d9e0da07570b4b57dd43"><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__HapticCustom.html#ad7eb84f59404d9e0da07570b4b57dd43">direction</a></td></tr> <tr class="separator:ad7eb84f59404d9e0da07570b4b57dd43"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad70e8bc2cff74b99d704a757c16b363f"><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__HapticCustom.html#ad70e8bc2cff74b99d704a757c16b363f">length</a></td></tr> <tr class="separator:ad70e8bc2cff74b99d704a757c16b363f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a094229466ff4cf695860db664100a2b0"><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__HapticCustom.html#a094229466ff4cf695860db664100a2b0">delay</a></td></tr> <tr class="separator:a094229466ff4cf695860db664100a2b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa4fbaf7220f3197aa6631b3e64ad6562"><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__HapticCustom.html#aa4fbaf7220f3197aa6631b3e64ad6562">button</a></td></tr> <tr class="separator:aa4fbaf7220f3197aa6631b3e64ad6562"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afdeb26b1709254545e00a59a0a6c360c"><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__HapticCustom.html#afdeb26b1709254545e00a59a0a6c360c">interval</a></td></tr> <tr class="separator:afdeb26b1709254545e00a59a0a6c360c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a560215762e9096d583d75867d9227cf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__stdinc_8h.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__HapticCustom.html#a560215762e9096d583d75867d9227cf5">channels</a></td></tr> <tr class="separator:a560215762e9096d583d75867d9227cf5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aba7fafa808e90baddef25f009b8f4817"><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__HapticCustom.html#aba7fafa808e90baddef25f009b8f4817">period</a></td></tr> <tr class="separator:aba7fafa808e90baddef25f009b8f4817"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5905ea1b6182da846535ca8c80b4fa33"><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__HapticCustom.html#a5905ea1b6182da846535ca8c80b4fa33">samples</a></td></tr> <tr class="separator:a5905ea1b6182da846535ca8c80b4fa33"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad5a034f97e1699eacbe3f478538537c5"><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__HapticCustom.html#ad5a034f97e1699eacbe3f478538537c5">data</a></td></tr> <tr class="separator:ad5a034f97e1699eacbe3f478538537c5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a018b35d89398c26e10d1fb4315d1dda1"><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__HapticCustom.html#a018b35d89398c26e10d1fb4315d1dda1">attack_length</a></td></tr> <tr class="separator:a018b35d89398c26e10d1fb4315d1dda1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad6e394e3775372af3eb9e02823987405"><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__HapticCustom.html#ad6e394e3775372af3eb9e02823987405">attack_level</a></td></tr> <tr class="separator:ad6e394e3775372af3eb9e02823987405"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab47fac94baeba28a3acd6c706e0b6a5c"><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__HapticCustom.html#ab47fac94baeba28a3acd6c706e0b6a5c">fade_length</a></td></tr> <tr class="separator:ab47fac94baeba28a3acd6c706e0b6a5c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73a522581eb514d032e500ec6294fe50"><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__HapticCustom.html#a73a522581eb514d032e500ec6294fe50">fade_level</a></td></tr> <tr class="separator:a73a522581eb514d032e500ec6294fe50"><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 the <a class="el" href="SDL__haptic_8h.html#a8a18c4de1076ac9bebd718329d16db29" title="Custom effect is supported. ">SDL_HAPTIC_CUSTOM</a> effect. </p> <p>A custom force feedback effect is much like a periodic effect, where the application can define its exact shape. You will have to allocate the data yourself. Data should consist of channels * samples Uint16 samples.</p> <p>If channels is one, the effect is rotated using the defined direction. Otherwise it uses the samples in data for the different axes.</p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__haptic_8h.html#a8a18c4de1076ac9bebd718329d16db29" title="Custom effect is supported. ">SDL_HAPTIC_CUSTOM</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="a018b35d89398c26e10d1fb4315d1dda1"></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_HapticCustom::attack_length</td> </tr> </table> </div><div class="memdoc"> <p>Duration of the attack. </p> </div> </div> <a class="anchor" id="ad6e394e3775372af3eb9e02823987405"></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_HapticCustom::attack_level</td> </tr> </table> </div><div class="memdoc"> <p>Level at the start of the attack. </p> </div> </div> <a class="anchor" id="aa4fbaf7220f3197aa6631b3e64ad6562"></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_HapticCustom::button</td> </tr> </table> </div><div class="memdoc"> <p>Button that triggers the effect. </p> </div> </div> <a class="anchor" id="a560215762e9096d583d75867d9227cf5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="SDL__stdinc_8h.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> SDL_HapticCustom::channels</td> </tr> </table> </div><div class="memdoc"> <p>Axes to use, minimum of one. </p> </div> </div> <a class="anchor" id="ad5a034f97e1699eacbe3f478538537c5"></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_HapticCustom::data</td> </tr> </table> </div><div class="memdoc"> <p>Should contain channels*samples items. </p> </div> </div> <a class="anchor" id="a094229466ff4cf695860db664100a2b0"></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_HapticCustom::delay</td> </tr> </table> </div><div class="memdoc"> <p>Delay before starting the effect. </p> </div> </div> <a class="anchor" id="ad7eb84f59404d9e0da07570b4b57dd43"></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_HapticCustom::direction</td> </tr> </table> </div><div class="memdoc"> <p>Direction of the effect. </p> </div> </div> <a class="anchor" id="ab47fac94baeba28a3acd6c706e0b6a5c"></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_HapticCustom::fade_length</td> </tr> </table> </div><div class="memdoc"> <p>Duration of the fade. </p> </div> </div> <a class="anchor" id="a73a522581eb514d032e500ec6294fe50"></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_HapticCustom::fade_level</td> </tr> </table> </div><div class="memdoc"> <p>Level at the end of the fade. </p> </div> </div> <a class="anchor" id="afdeb26b1709254545e00a59a0a6c360c"></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_HapticCustom::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="ad70e8bc2cff74b99d704a757c16b363f"></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_HapticCustom::length</td> </tr> </table> </div><div class="memdoc"> <p>Duration of the effect. </p> </div> </div> <a class="anchor" id="aba7fafa808e90baddef25f009b8f4817"></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_HapticCustom::period</td> </tr> </table> </div><div class="memdoc"> <p>Sample periods. </p> </div> </div> <a class="anchor" id="a5905ea1b6182da846535ca8c80b4fa33"></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_HapticCustom::samples</td> </tr> </table> </div><div class="memdoc"> <p>Amount of samples. </p> </div> </div> <a class="anchor" id="a98a8995c94492069dc007502ed97eed2"></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_HapticCustom::type</td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="SDL__haptic_8h.html#a8a18c4de1076ac9bebd718329d16db29" title="Custom effect is supported. ">SDL_HAPTIC_CUSTOM</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>