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

69 lines
9.2 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>input_manager.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="Topic1073"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="IPM_Initialize"></a><a name="Topic1074"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_Initialize</div>
<div id="NDPrototype1074" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> IPM_Initialize(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">IPM_Config*&nbsp;</td><td class="PName last">config</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Initialize input manager</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">config<div class="CDLParameterType">IPM_Config*</div></td><td class="CDLDefinition"><p>Input manager configuration structure</p></td></tr></table></div>
</div>
<a name="IPM_SetTimer"></a><a name="Topic1075"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_SetTimer</div>
<div id="NDPrototype1075" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> IPM_SetTimer(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">doubleClk,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">hold</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Initialize input manager</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">doubleClk<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Double click timer</p></td></tr><tr><td class="CDLEntry">hold<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Hold timer</p></td></tr></table></div>
</div>
<a name="IPM_Update"></a><a name="Topic1076"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_Update</div>
<div id="NDPrototype1076" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> IPM_Update()</div></div>
<div class="CBody"><p>Update device manager</p></div>
</div>
<a name="IPM_RegisterEvent"></a><a name="Topic1077"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_RegisterEvent</div>
<div id="NDPrototype1077" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> IPM_RegisterEvent(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dev,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">input,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">event,</td></tr><tr><td class="PType first">IPM_cb&nbsp;</td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Register a callback to a given device manager's event</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Device ID</p></td></tr><tr><td class="CDLEntry">input<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Input ID</p></td></tr><tr><td class="CDLEntry">event<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Event ID</p></td></tr><tr><td class="CDLEntry">cb<div class="CDLParameterType">IPM_cb</div></td><td class="CDLDefinition"><p>Callback function</p></td></tr></table><div class="CHeading">Return</div><p>TRUE if the event was registered, FALSE otherwise</p></div>
</div>
<a name="IPM_GetStatus"></a><a name="Topic1078"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_GetStatus</div>
<div id="NDPrototype1078" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 IPM_GetStatus(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dev</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get current device status</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Device ID</p></td></tr></table><div class="CHeading">Return</div><p>Current device status</p></div>
</div>
<a name="IPM_GetStickDirection"></a><a name="Topic1079"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_GetStickDirection</div>
<div id="NDPrototype1079" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 IPM_GetStickDirection(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dev</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get current direction of the given device</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Device ID</p></td></tr></table><div class="CHeading">Return</div><p>Current device direction</p></div>
</div>
<a name="IPM_GetInputState"></a><a name="Topic1080"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_GetInputState</div>
<div id="NDPrototype1080" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 IPM_GetInputState(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dev,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">input</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get current device state</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Device ID</p></td></tr><tr><td class="CDLEntry">input<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Input ID</p></td></tr></table><div class="CHeading">Return</div><p>Current device's input state</p></div>
</div>
<a name="IPM_GetInputTimer"></a><a name="Topic1081"></a><div class="CTopic TFunction LC">
<div class="CTitle">IPM_GetInputTimer</div>
<div id="NDPrototype1081" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 IPM_GetInputTimer(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dev,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">input</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get current device state timer</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Device ID</p></td></tr><tr><td class="CDLEntry">input<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Input ID</p></td></tr></table><div class="CHeading">Return</div><p>Current device's input state timer</p></div>
</div>
<a name="IPM_GetEventName"></a><a name="Topic1082"></a><div class="CTopic TFunction LC last">
<div class="CTitle">IPM_GetEventName</div>
<div id="NDPrototype1082" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">const</span> c8* IPM_GetEventName(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">ev</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get event name</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">ev<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Event ID</p></td></tr></table><div class="CHeading">Return</div><p>Zero-terminated string containing the event name</p></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink