jurjenwerk/mazegame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4c33bdb880980476ccb0a59901abcdbaba342025
mazegame/engine/doc/html/files/device/paddle-h.html
T

51 lines
6.3 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>paddle.h</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
<!-- Generated by Natural Docs, version 2.2 -->
<!-- saved from url=(0016)http://localhost -->
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
<a name="Functions"></a><a name="Topic63"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="Paddle_Update"></a><a name="Topic64"></a><div class="CTopic TFunction LC">
<div class="CTitle">Paddle_Update</div>
<div id="NDPrototype64" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> Paddle_Update()</div></div>
<div class="CBody"><p>Update both joystick port and store paddles information</p></div>
</div>
<a name="Paddle_IsConnected"></a><a name="Topic65"></a><div class="CTopic TFunction LC">
<div class="CTitle">Paddle_IsConnected</div>
<div id="NDPrototype65" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Paddle_IsConnected(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">port</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Check if a paddle is connected to the given port</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">port<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Index of the port to check (0: Port A, 1: Port B)</p></td></tr></table><div class="CHeading">Return</div><p>TRUE if a paddle is connected to that port</p></div>
</div>
<a name="Paddle_GetAngle"></a><a name="Topic66"></a><div class="CTopic TFunction LC">
<div class="CTitle">Paddle_GetAngle</div>
<div id="NDPrototype66" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u16 Paddle_GetAngle(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">port</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get the rotation angle of a paddle on the given port</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">port<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Index of the port to check (0: Port A, 1: Port B)</p></td></tr></table><div class="CHeading">Return</div><p>Paddle angle (theorical value goes from 0 to 510, but valid range is around 110 to 380)</p></div>
</div>
<a name="Paddle_IsButtonPressed"></a><a name="Topic67"></a><div class="CTopic TFunction LC">
<div class="CTitle">Paddle_IsButtonPressed</div>
<div id="NDPrototype67" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Paddle_IsButtonPressed(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">port</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Check if the given paddle's button is pressed</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">port<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Index of the port to check (0: Port A, 1: Port B)</p></td></tr></table><div class="CHeading">Return</div><p>TRUE if the given paddle's button is pressed</p></div>
</div>
<a name="Paddle_SetCalibration"></a><a name="Topic68"></a><div class="CTopic TFunction LC">
<div class="CTitle">Paddle_SetCalibration</div>
<div id="NDPrototype68" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Paddle_SetCalibration(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">port,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">min,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">max</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Calibrate the given paddle</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">port<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Index of the port to check (0: Port A, 1: Port B)</p></td></tr><tr><td class="CDLEntry">min<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Minimum recoreded value</p></td></tr><tr><td class="CDLEntry">max<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Maximum recoreded value</p></td></tr></table></div>
</div>
<a name="Paddle_GetCalibratedAngle"></a><a name="Topic69"></a><div class="CTopic TFunction LC last">
<div class="CTitle">Paddle_GetCalibratedAngle</div>
<div id="NDPrototype69" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 Paddle_GetCalibratedAngle(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">port</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get the callibrated rotation angle of a paddle on the given port</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">port<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Index of the port to check (0: Port A, 1: Port B)</p></td></tr></table><div class="CHeading">Return</div><p>Paddle angle (from 0 to 255)</p></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink