Gorgon
Show / Hide Table of Contents

Interface IGorgonRawHID

Provides state for human interface data returned from Raw Input.

Inherited Members
IGorgonRawInputDevice.Handle
IGorgonRawInputDevice.DeviceType
IGorgonRawInputDevice.DeviceUsage
IGorgonRawInputDeviceData<GorgonRawHIDData>.ProcessData(in GorgonRawHIDData)
IDisposable.Dispose()
Namespace: Gorgon.Input
Assembly: Gorgon.Input.dll
Syntax
public interface IGorgonRawHID : IGorgonRawInputDevice, IGorgonRawInputDeviceData<GorgonRawHIDData>, IDisposable
Remarks

This allows a user to read, and parse human interface device data from an aribtrary device. It is recommended that this object be wrapped by an actual object that will be used to present the data in an easy to manipulate format.

This object implements IDisposable because it manipulates native memory. It is necessary to call the Dispose() method in order to ensure there is no memory leak when finished with this object.

Properties

| Edit this page View Source

Count

Property to return the number of inputs in the Data.

Declaration
int Count { get; }
Property Value
Type Description
int
| Edit this page View Source

Data

Property to return a pointer to the block of memory that stores the HID data.

Declaration
GorgonPtr<byte> Data { get; }
Property Value
Type Description
GorgonPtr<byte>
| Edit this page View Source

HIDSize

Property to return the size of an individual HID input, in bytes.

Declaration
int HIDSize { get; }
Property Value
Type Description
int
| Edit this page View Source

Info

Property to return information about the Raw Input Human Interface Device.

Declaration
IGorgonRawHIDInfo Info { get; }
Property Value
Type Description
IGorgonRawHIDInfo
| Edit this page View Source

PreParsedData

Property to return the pre-parsed data for this HID.

Declaration
GorgonPtr<byte> PreParsedData { get; }
Property Value
Type Description
GorgonPtr<byte>

Events

| Edit this page View Source

DataReceived

Event triggered when Raw Input receives data from the device.

Declaration
event EventHandler<GorgonHIDEventArgs> DataReceived
Event Type
Type Description
EventHandler<GorgonHIDEventArgs>

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author