Unity Modules
Leap Motion's Unity SDK
4.5.0
LeapInternal Namespace Reference

Classes

class  CircularObjectBuffer
 
class  Connection
 
class  ImageData
 
struct  LEAP_ALLOCATOR
 
struct  LEAP_BONE
 
struct  LEAP_CONFIG_CHANGE_EVENT
 
struct  LEAP_CONFIG_RESPONSE_EVENT
 
struct  LEAP_CONFIG_RESPONSE_EVENT_WITH_REF_TYPE
 
struct  LEAP_CONNECTION_CONFIG
 
struct  LEAP_CONNECTION_EVENT
 
struct  LEAP_CONNECTION_INFO
 
struct  LEAP_CONNECTION_LOST_EVENT
 
struct  LEAP_CONNECTION_MESSAGE
 
struct  LEAP_DEVICE_EVENT
 
struct  LEAP_DEVICE_FAILURE_EVENT
 
struct  LEAP_DEVICE_INFO
 
struct  LEAP_DEVICE_REF
 
struct  LEAP_DIGIT
 
struct  LEAP_DISCONNECTION_EVENT
 
struct  LEAP_DROPPED_FRAME_EVENT
 
struct  LEAP_FRAME_HEADER
 
struct  LEAP_HAND
 
struct  LEAP_HEAD_POSE_EVENT
 
struct  LEAP_IMAGE
 
struct  LEAP_IMAGE_EVENT
 
struct  LEAP_IMAGE_PROPERTIES
 
struct  LEAP_LOG_EVENT
 
struct  LEAP_MATRIX_3x3
 
struct  LEAP_PALM
 
struct  LEAP_POINT_MAPPING
 
struct  LEAP_POINT_MAPPING_CHANGE_EVENT
 
struct  LEAP_POLICY_EVENT
 
struct  LEAP_QUATERNION
 
struct  LEAP_TELEMETRY_DATA
 
struct  LEAP_TIP
 
struct  LEAP_TRACKING_EVENT
 
struct  LEAP_VARIANT_REF_TYPE
 
struct  LEAP_VARIANT_VALUE_TYPE
 
struct  LEAP_VECTOR
 
class  LeapC
 

Enumerations

Functions

delegate IntPtr Allocate (UInt32 size, eLeapAllocatorType typeHint, IntPtr state)
 
delegate void Deallocate (IntPtr buffer, IntPtr state)
 

Enumeration Type Documentation

enum eDistortionMatrixType
strong
Enumerator
eDistortionMatrixType_64x64 

A 64x64 matrix of pairs of points.

enum eLeapAllocatorType : uint
strong
Enumerator
eLeapAllocatorType_Int8 
eLeapAllocatorType_Uint8 
eLeapAllocatorType_Int16 
eLeapAllocatorType_UInt16 
eLeapAllocatorType_Int32 
eLeapAllocatorType_UInt32 
eLeapAllocatorType_Float 
eLeapAllocatorType_Int64 
eLeapAllocatorType_UInt64 
eLeapAllocatorType_Double 
enum eLeapConnectionStatus : uint
strong
Enumerator
eLeapConnectionStatus_NotConnected 

A connection has been established.

eLeapConnectionStatus_Connected 

The connection has not been completed. Call OpenConnection.

eLeapConnectionStatus_HandshakeIncomplete 

The connection handshake has not completed.

eLeapConnectionStatus_NotRunning 

A connection could not be established because the server does not appear to be running.

enum eLeapDeviceCaps : uint
strong
Enumerator
eLeapDeviceCaps_Color 

The device can send color images.

enum eLeapDeviceFlag : uint
strong
Enumerator
eLeapDeviceFlag_Stream 

Flag set if the device is presently streaming frames

This flag is updated when the user pauses or resumes tracking on the device from the Leap control panel. Modification of this flag will fail if the AllowPauseResume policy is not set on this device object.

enum eLeapDeviceStatus : uint
strong
Enumerator
eLeapDeviceStatus_Streaming 

Presently sending frames to all clients that have requested them.

eLeapDeviceStatus_Paused 

Device streaming has been paused.

eLeapDeviceStatus_Robust 

There are known sources of infrared interference. Device has transitioned to robust mode in order to compensate.

eLeapDeviceStatus_Smudged 

The device's window is smudged, tracking may be degraded.

eLeapDeviceStatus_LowResource 

The device has entered low-resource mode.

eLeapDeviceStatus_UnknownFailure 

The device has failed, but the failure reason is not known.

eLeapDeviceStatus_BadCalibration 

Bad calibration, cannot send frames.

eLeapDeviceStatus_BadFirmware 

Corrupt firmware and/or cannot receive a required firmware update.

eLeapDeviceStatus_BadTransport 

Exhibiting USB communications issues.

eLeapDeviceStatus_BadControl 

Missing critical control interfaces needed for communication.

enum eLeapDeviceType : uint
strong
Enumerator
eLeapDeviceType_Peripheral 

The Leap Motion consumer peripheral

eLeapDeviceType_Dragonfly 

Internal research product codename "Dragonfly".

eLeapDeviceType_Nightcrawler 

Internal research product codename "Nightcrawler".

eLeapDevicePID_Rigel 

Research product codename "Rigel".

enum eLeapDroppedFrameType
strong
Enumerator
eLeapDroppedFrameType_PreprocessingQueue 
eLeapDroppedFrameType_TrackingQueue 
eLeapDroppedFrameType_Other 
enum eLeapEventType
strong
Enumerator
eLeapEventType_None 

No event has occurred within the timeout period specified when calling LeapPollConnection().

eLeapEventType_Connection 

A connection to the Leap Motion service has been established.

eLeapEventType_ConnectionLost 

The connection to the Leap Motion service has been lost.

eLeapEventType_Device 

A device has been detected or plugged-in. A device event is dispatched after a connection is established for any devices already plugged in. (The system currently only supports one streaming device at a time.)

eLeapEventType_DeviceFailure 

Note that unplugging a device generates an eLeapEventType_DeviceLost event message, not a failure message.

eLeapEventType_Policy 

A policy change has occurred. This can be due to setting a policy with LeapSetPolicyFlags() or due to changing or policy-related config settings, including images_mode. (A user can also change these policies using the Leap Motion Control Panel.)

eLeapEventType_Tracking 

A tracking frame. The message contains the tracking data for the frame.

eLeapEventType_ImageRequestError 

The request for an image has failed. The message contains information about the failure. The client application will not receive the requested image set.

eLeapEventType_ImageComplete 

The request for an image is complete. The image data has been completely written to the application-provided buffer.

eLeapEventType_LogEvent 

A system message.

eLeapEventType_DeviceLost 

The device connection has been lost.

This event is generally asserted when the device has been detached from the system, when the connection to the service has been lost, or if the device is closed while streaming. Generally, any event where the system can conclude no further frames will be received will result in this message. The DeviceEvent field will be filled with the id of the formerly attached device.

eLeapEventType_ConfigResponse 

The asynchronous response to a call to LeapRequestConfigValue(). Contains the value of requested configuration item.

eLeapEventType_ConfigChange 

The asynchronous response to a call to LeapSaveConfigValue(). Reports whether the change succeeded or failed.

eLeapEventType_DeviceStatusChange 

Notification that a status change has been detected on an attached device.

eLeapEventType_DroppedFrame 

A tracking frame has been dropped by the service.

eLeapEventType_Image 

Notification that an unrequested stereo image pair is available.

eLeapEventType_PointMappingChange 

Notification that point mapping has changed.

eLeapEventType_LogEvents 

An array of system messages.

eLeapEventType_HeadPose 

A new head pose is available.

enum eLeapHandType
strong
Enumerator
eLeapHandType_Left 
eLeapHandType_Right 
enum eLeapImageFormat : uint
strong
Enumerator
eLeapImageFormat_UNKNOWN 

An invalid or unknown format.

eLeapImageType_IR 

An infrared image.

eLeapImageType_RGBIr_Bayer 

A Bayer RGBIr image with uncorrected RGB channels

enum eLeapImageType
strong
Enumerator
eLeapImageType_Unknown 
eLeapImageType_Default 

Default processed IR image

eLeapImageType_Raw 

Image from raw sensor values

enum eLeapLogSeverity
strong
Enumerator
eLeapLogSeverity_Unknown 

The message severity is not known or was not specified.

eLeapLogSeverity_Critical 

A message about a fault that could render the software or device non-functional.

eLeapLogSeverity_Warning 

A message warning about a condition that could degrade device capabilities.

eLeapLogSeverity_Information 

A system status message.

enum eLeapPerspectiveType
strong
Enumerator
eLeapPerspectiveType_invalid 

An unknown or invalid type.

eLeapPerspectiveType_stereo_left 

A canonically left image.

eLeapPerspectiveType_stereo_right 

A canonically right image.

eLeapPerspectiveType_mono 

Reserved for future use.

enum eLeapPolicyFlag : uint
strong
Enumerator
eLeapPolicyFlag_BackgroundFrames 

Allows frame receipt even when this application is not the foreground application.

eLeapPolicyFlag_Images 

Allow streaming images

eLeapPolicyFlag_OptimizeHMD 

Optimize HMD Policy Flag.

eLeapPolicyFlag_AllowPauseResume 

Modifies the security token to allow calls to LeapPauseDevice to succeed

eLeapPolicyFlag_MapPoints 

Allows streaming map points.

enum eLeapRS : uint
strong
Enumerator
eLeapRS_Success 

The operation completed successfully.

eLeapRS_UnknownError 

An undetermined error has occurred. This is usually the result of an abnormal operating condition in LeapC, the Leap Motion service, or the host computer itself.

eLeapRS_InvalidArgument 

An invalid argument was specified.

eLeapRS_InsufficientResources 

Insufficient resources existed to complete the request.

eLeapRS_InsufficientBuffer 

The specified buffer was not large enough to complete the request.

eLeapRS_Timeout 

The requested operation has timed out.

eLeapRS_NotConnected 

The operation is invalid because there is no current connection.

eLeapRS_HandshakeIncomplete 

The operation is invalid because the connection is not complete.

eLeapRS_BufferSizeOverflow 

The specified buffer size is too large.

eLeapRS_ProtocolError 

A communications protocol error occurred.

eLeapRS_InvalidClientID 

The server incorrectly specified zero as a client ID.

eLeapRS_UnexpectedClosed 

The connection to the service was unexpectedly closed while reading or writing a message. The server may have terminated.

eLeapRS_UnknownImageFrameRequest 

The specified request token does not appear to be valid

Provided that the token value which identifies the request itself was, at one point, valid, this error condition occurs when the request to which the token refers has already been satisfied or is currently being satisfied.

eLeapRS_UnknownTrackingFrameID 

The specified frame ID is not valid or is no longer valid

Provided that frame ID was, at one point, valid, this error condition occurs when the identifier refers to a frame that occurred further in the past than is currently recorded in the rolling frame window.

eLeapRS_RoutineIsNotSeer 

The specified timestamp references a future point in time

The related routine can only operate on time points having occurred in the past, and the provided timestamp occurs in the future.

eLeapRS_TimestampTooEarly 

The specified timestamp references a point too far in the past

The related routine can only operate on time points occurring within its immediate record of the past.

eLeapRS_ConcurrentPoll 

LeapPollConnection is called concurrently.

eLeapRS_NotAvailable 

A connection to the Leap Motion service could not be established.

eLeapRS_NotStreaming 

The requested operation can only be performed while the device is sending data.

eLeapRS_CannotOpenDevice 

The specified device could not be opened. It is possible that the device identifier is invalid, or that the device has been disconnected since being enumerated.

enum eLeapServiceDisposition : uint
strong
Enumerator
eLeapServiceState_LowFpsDetected 

The service cannot receive frames fast enough from the underlying hardware.

Since
3.1.3
eLeapServiceState_PoorPerformancePause 

The service has paused itself due to an insufficient frame rate from the hardware.

Since
3.1.3
enum eLeapValueType : int
strong
Enumerator
eLeapValueType_Unknown 

The type is unknown (which is an abnormal condition).

eLeapValueType_Boolean 
eLeapValueType_Int32 
eLeapValueType_Float 
eLeapValueType_String 

Function Documentation

delegate IntPtr LeapInternal.Allocate ( UInt32  size,
eLeapAllocatorType  typeHint,
IntPtr  state 
)
delegate void LeapInternal.Deallocate ( IntPtr  buffer,
IntPtr  state 
)