diff --git a/readme.md b/readme.md index 87b064a..283e5d9 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,17 @@ # PB-RawInput +A module to access and use Windows' RawInput API. -TODO +## Usage +Simply include "*[RawInput.pbi](Includes/RawInput.pbi)*" and use the structures, functions and datatypes documented on the [MSDN page](https://docs.microsoft.com/en-us/windows/win32/inputdev/raw-input.) with the `RawInput::` prefix. + +## Considerations +* The module has not been tested on x86 platforms +* Some structure fields may not be available on Windows XP, see Microsoft's documentation. +* `GetRawInputDeviceInfoA` and `GetRawInputDeviceInfoW` are available under `GetRawInputDeviceInfo`. + +## Useful Links +* MSDN page - https://docs.microsoft.com/en-us/windows/win32/inputdev/raw-input +* MSDN page - https://docs.microsoft.com/en-us/windows/win32/inputdev/raw-input ## License [Unlicense](LICENSE)