Skip to content

Commit 767cab8

Browse files
authored
Update README.md
1 parent b6bc2a7 commit 767cab8

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# XMapLib
22
A closer to the metal library for Xbox controller to keyboard and mouse input.
33

4+
<p>XMapLibSharp is a C# .NET GUI project using the C++ project code through a DLL via managed/native interop. With this approach,
5+
the project has access to the entire .NET framework for GUI work while keeping the native performance and power of the C++ XMapLib code.
6+
7+
<a href="https://ibb.co/x28d2WX"><img src="https://i.ibb.co/0nVvnTm/XMap-Lib-gui1.jpg" alt="XMap-Lib-gui1" border="0"></a>
8+
9+
<b><p>A high level code diagram of the XMapLib project code (native C++)</b>
410
<a href="https://ibb.co/vmjctWD"><img src="https://i.ibb.co/ZKMfZrN/XMap-Lib-uml.jpg" alt="XMap-Lib-uml" border="0"></a>
511

6-
The main classes for use are :
12+
<b>The main classes for use in the native C++ XMapLib project are :</b>
713
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MouseMapper.h">MouseMapper</a></p></b>
814
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardMapper.h">KeyboardMapper</a></p></b>
915
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MousePlayerInfo.h">MousePlayerInfo</a></p></b>
1016
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardPlayerInfo.h">KeyboardPlayerInfo</a></p></b>
1117
To set the mapping details <b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardKeyMap.h">KeyboardKeyMap</a></b> encapsulates the information comprising a controller key to keyboard/mouse key mapping.
1218
<p>Also, please see the <b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/XMapLib.cpp">Example</a></b></p>
19+
20+
<b><p>The DLL API exposed from XMapLibDLL is described totally in apifuncs.h in the DLL project.</b>

0 commit comments

Comments
 (0)