Description

Copyright: Copyright © 2012–2023 Kosada Incorporated. This code may be modified and distributed under the terms of the GNU Lesser General Public License (LGPL) version 2 or later. For more information, see https://vuo.org/license.

Macros
#define	RETURN_SUMMARY(type)
	If the port's data type is equal to the specified `type`, creates an object from the port's current value, then returns the output of `VuoType_getSummary()`.

#define	RETURN_SHORT_SUMMARY(type)
	If the port's data type is equal to the specified `type`, creates an object from the port's current value, then returns the output of `VuoType_getShortSummary()`.

Functions
char *	VuoHid_getUsageText (uint32_t usagePage, uint32_t usage)
	Returns a string containing a verbal description of the specified USB HID usage.

Macro Definition Documentation

◆ RETURN_SHORT_SUMMARY

#define RETURN_SHORT_SUMMARY ( type )

Value:

    if (getDataType()->getModuleKey() == #type)                                      \
    {                                                                                \
        type value = VuoMakeRetainedFromString(getConstantAsString().c_str(), type); \
        string s = stringAndFree(type ## _getShortSummary(value));                   \
        type ## _release(value);                                                     \
        return s;                                                                    \
    }

If the port's data type is equal to the specified type, creates an object from the port's current value, then returns the output of VuoType_getShortSummary().

Definition at line 75 of file VuoRendererPort.cc.

◆ RETURN_SUMMARY

#define RETURN_SUMMARY ( type )

Value:

    if (getDataType()->getModuleKey() == #type)                                      \
    {                                                                                \
        type value = VuoMakeRetainedFromString(getConstantAsString().c_str(), type); \
        string s = stringAndFree(type ## _getSummary(value));                        \
        type ## _release(value);                                                     \
        return s;                                                                    \
    }

If the port's data type is equal to the specified type, creates an object from the port's current value, then returns the output of VuoType_getSummary().

Definition at line 61 of file VuoRendererPort.cc.

Function Documentation

◆ VuoHid_getUsageText()

char * VuoHid_getUsageText	(	uint32_t	usagePage,
		uint32_t	usage
	)

Returns a string containing a verbal description of the specified USB HID usage.

The caller is responsible for freeing the returned string.

Based on "HID Usage Tables 10/28/2004 Version 1.12" (with a few spelling errors corrected), plus changes from Review Requests 28 through 57. Exceptions:

Implementation of RR39 is incomplete.
RR43 is not published and is thus not implemented.
The conflicting assignments between RR33 and RR47 are resolved by RR57.
Includes usage 0x01:0xffffffff (Apple Mikey keycode).
Includes usage 0x07:0xffffffff (the 8-bit USB HID keycodes of up to 8 simultanouely-pressed keys).
Includes usage pages 0x84 and 0x85 from "Universal Serial Bus Usage Tables for HID Power Devices Release 1.0 November 1, 1997".
Includes usage page 0xff (Fn key on Apple Keyboards).

Definition at line 39 of file VuoHidUsage.c.