/usr/share/SuperCollider/HelpSource/Classes/HIDUsage.schelp is in supercollider-common 1:3.8.0~repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | TITLE:: HIDUsage
summary:: Helper class to read usage information from HID usage tables
categories:: External Control>HID
related:: Classes/HID, Classes/HIDElement, Classes/HIDCollection, Guides/Working_with_HID
DESCRIPTION::
HID functionality is described by the USB HID standard usage tables. Each element and collection has a usage page and index, describing the type of control that it provides. This class allows to query the name of a usage and page based on the indices read from the device. This class is primarily used internally by other HID classes.
CLASSMETHODS::
PRIVATE:: initClass
METHOD:: getUsageDescription
Retrieve the standard usage name and pagename of an HID usage element or collection.
ARGUMENT:: usagePage
usage page number
ARGUMENT:: usage
usage index
returns:: an Array with the pageName and usageName
METHOD:: hutDirectory
Directory where the yaml files with the HID usage tables are stored.
METHOD:: readHUTFile
Reads and parses the HID usage table file. Called from getUsageDescription to read in the usage table.
ARGUMENT:: yamlfile
the filename of the yamlfile with a particular usage table, relative to the hutDirectory.
returns:: an IdentityDictionary representing the table
METHOD:: getUsageIds
Retrieve usage id and page id from the usageName.
ARGUMENT:: usageName
the usage name
returns:: an Array with the page id and the usage id
METHOD:: idsToName
Retrieve the standard usage name and pagename of an HID usage element or collection.
ARGUMENT:: page
the usage page id
ARGUMENT:: usage
the usage id
returns:: the usage name
METHOD:: usageIDsToName
MultiLevelIdentityDictionary containing a map of page ids, usage ids to usage names.
METHOD:: usageNameToIDs
IdentityDictionary containing a map of usageNames to page ids and usage ids.
EXAMPLES::
Get the usage description for a collection or element with usage page 1 and usage index 5
code::
HIDUsage.getUsageDescription( 1, 5 );
::
|