Leap Motion C API  4.1.0
The API to the LeapC library.
Enumerations

Enumerations used by the LeapC functions and data structures. More...

Enumerations

Detailed Description

Enumerations used by the LeapC functions and data structures.

Enumeration Type Documentation

Defines the various types of data that may be allocated using the allocator.

Since
4.0.0
Enumerator
eLeapAllocatorType_Int8 

Signed 8-bit integer (char)

Since
4.0.0
eLeapAllocatorType_Uint8 

Unsigned 8-bit integer (byte)

Since
4.0.0
eLeapAllocatorType_Int16 

Signed 16-bit integer.

Since
4.0.0
eLeapAllocatorType_UInt16 

Unsigned 16-bit integer.

Since
4.0.0
eLeapAllocatorType_Int32 

Signed 32-bit integer.

Since
4.0.0
eLeapAllocatorType_UInt32 

Unsigned 32-bit integer.

Since
4.0.0
eLeapAllocatorType_Float 

Single-precision 32-bit floating-point.

Since
4.0.0
eLeapAllocatorType_Int64 

Signed 64-bit integer.

Since
4.0.0
eLeapAllocatorType_UInt64 

Unsigned 64-bit integer.

Since
4.0.0
eLeapAllocatorType_Double 

Double-precision 64-bit floating-point.

Since
4.0.0

Flags enumerating Leap device capabilities.

Since
3.0.0
Enumerator
eLeapDeviceCaps_Color 

The device can send color images.

Since
3.0.0

Device hardware types.

Since
3.0.0
Enumerator
eLeapDevicePID_Unknown 

An unknown device.

Since
3.1.3
eLeapDevicePID_Peripheral 

The Leap Motion consumer peripheral.

Since
3.0.0
eLeapDevicePID_Dragonfly 

Internal research product codename "Dragonfly".

Since
3.0.0
eLeapDevicePID_Nightcrawler 

Internal research product codename "Nightcrawler".

Since
3.0.0
eLeapDevicePID_Rigel 

Research product codename "Rigel".

Since
4.0.0
eLeapDevicePID_Invalid 

An invalid device type value.

Since
3.1.3

Enumerates the device status codes.

Since
3.0.0
Enumerator
eLeapDeviceStatus_Streaming 

The device is sending out frames.

Since
3.0.0
eLeapDeviceStatus_Paused 

Device streaming has been paused.

Since
3.0.0
eLeapDeviceStatus_Robust 

There are known sources of infrared interference.

Device has transitioned to robust mode in order to compensate.

Since
3.1.3
eLeapDeviceStatus_Smudged 

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

Since
3.1.3
eLeapDeviceStatus_LowResource 

The device has entered low-resource mode.

Since
4.0.0
eLeapDeviceStatus_UnknownFailure 

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

Since
3.0.0
eLeapDeviceStatus_BadCalibration 

The device has a bad calibration record and cannot send frames.

Since
3.0.0
eLeapDeviceStatus_BadFirmware 

The device reports corrupt firmware or cannot install a required firmware update.

Since
3.0.0
eLeapDeviceStatus_BadTransport 

The device USB connection is faulty.

Since
3.0.0
eLeapDeviceStatus_BadControl 

The device USB control interfaces failed to initialize.

Since
3.0.0

The types of event messages resulting from calling LeapPollConnection().

Since
3.0.0
Enumerator
eLeapEventType_None 

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

Since
3.0.0
eLeapEventType_Connection 

A connection to the Leap Motion service has been established.

Since
3.0.0
eLeapEventType_ConnectionLost 

The connection to the Leap Motion service has been lost.

Since
3.0.0
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.)

Since
3.0.0
eLeapEventType_DeviceFailure 

A device has failed.

Device failure could be caused by hardware failure, USB controller issues, or other system instability. Note that unplugging a device generates an eLeapEventType_DeviceLost event message, not a failure message.

Since
3.0.0
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.)

Since
3.0.0
eLeapEventType_Tracking 

A tracking frame.

The message contains the tracking data for the frame.

Since
3.0.0
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.

Since
3.0.0
eLeapEventType_ImageComplete 

The request for an image is complete.

The image data has been completely written to the application-provided buffer.

Since
3.0.0
eLeapEventType_LogEvent 

A system message.

Since
3.0.0
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.

Since
3.0.0
eLeapEventType_ConfigResponse 

The asynchronous response to a call to LeapRequestConfigValue().

Contains the value of requested configuration item.

Since
3.0.0
eLeapEventType_ConfigChange 

The asynchronous response to a call to LeapSaveConfigValue().

Reports whether the change succeeded or failed.

Since
3.0.0
eLeapEventType_DeviceStatusChange 

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

Since
3.1.3
eLeapEventType_Image 

Notification that an unrequested stereo image pair is available.

Since
4.0.0
eLeapEventType_PointMappingChange 

Notification that point mapping has changed.

Since
4.0.0
eLeapEventType_LogEvents 

An array of system messages.

Since
4.0.0

The Hand chirality types.

Used in the LEAP_HAND struct.

Since
3.0.0
Enumerator
eLeapHandType_Left 

A left hand.

Since
3.0.0
eLeapHandType_Right 

A right hand.

Since
3.0.0

Image formats.

Since
3.0.0
Enumerator
eLeapImageFormat_UNKNOWN 

An invalid or unknown format.

Since
3.0.0
eLeapImageFormat_IR 

An infrared image.

Since
3.0.0
eLeapImageFormat_RGBIr_Bayer 

A Bayer RGBIr image with uncorrected RGB channels.

Since
3.0.0

Functional image types (not data formats).

Enumerator
eLeapImageType_UNKNOWN 

An invalid or unknown type.

Since
3.0.0
eLeapImageType_Default 

Default, processed IR images.

Since
3.0.0
eLeapImageType_Raw 

Raw images from the device.

Since
3.0.0

System message severity types.

Since
3.0.0
Enumerator
eLeapLogSeverity_Unknown 

The message severity is not known or was not specified.

Since
3.0.0
eLeapLogSeverity_Critical 

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

Since
3.0.0
eLeapLogSeverity_Warning 

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

Since
3.0.0
eLeapLogSeverity_Information 

A system status message.

Since
3.0.0

Camera perspective types.

Since
3.0.0
Enumerator
eLeapPerspectiveType_invalid 

An unknown or invalid type.

Since
3.0.0
eLeapPerspectiveType_stereo_left 

A canonically left image.

Since
3.0.0
eLeapPerspectiveType_stereo_right 

A canonically right image.

Since
3.0.0
eLeapPerspectiveType_mono 

Reserved for future use.

Since
3.0.0

Enumerates flags for the service policies.

Enumerator
eLeapPolicyFlag_BackgroundFrames 

The policy allowing an application to receive frames in the background.

Since
3.0.0
eLeapPolicyFlag_Images 

The policy specifying whether to automatically stream images from the device.

Since
4.0.0
eLeapPolicyFlag_OptimizeHMD 

The policy specifying whether to optimize tracking for head-mounted device.

Since
3.0.0
eLeapPolicyFlag_AllowPauseResume 

The policy allowing an application to pause or resume service tracking.

Since
3.0.0
eLeapPolicyFlag_MapPoints 

The policy allowing an application to receive per-frame map points.

Since
4.0.0

Defines the recording mode provided to the LeapRecordingOpen() function.

Also used in members of LEAP_RECORDING_PARAMETERS and LEAP_RECORDING_STATUS.

Since
3.2.0
enum eLeapRS

Defines the codes returned by all LeapC functions.

Since
3.0.0
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.

Since
3.0.0
eLeapRS_InvalidArgument 

An invalid argument was specified.

Since
3.0.0
eLeapRS_InsufficientResources 

Insufficient resources existed to complete the request.

Since
3.0.0
eLeapRS_InsufficientBuffer 

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

Since
3.0.0
eLeapRS_Timeout 

The requested operation has timed out.

Since
3.0.0
eLeapRS_NotConnected 

The operation is invalid because there is no current connection.

Since
3.0.0
eLeapRS_HandshakeIncomplete 

The operation is invalid because the connection is not complete.

Since
3.0.0
eLeapRS_BufferSizeOverflow 

The specified buffer size is too large.

Since
3.0.0
eLeapRS_ProtocolError 

A communications protocol error occurred.

Since
3.0.0
eLeapRS_InvalidClientID 

The server incorrectly specified zero as a client ID.

Since
3.0.0
eLeapRS_UnexpectedClosed 

The connection to the service was unexpectedly closed while reading or writing a message.

The server may have terminated.

Since
3.0.0
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.

Since
3.0.0
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.

Since
3.0.0
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.

Since
3.1.2
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.

Since
3.1.2
eLeapRS_ConcurrentPoll 

LeapPollConnection is called concurrently.

Since
3.1.2
eLeapRS_NotAvailable 

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

Since
3.0.0
eLeapRS_NotStreaming 

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

Since
3.0.0
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.

Since
3.0.0

Identifies the operative data type of a LEAP_VARIANT struct instance.

Since
3.0.0
Enumerator
eLeapValueType_Unknown 

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

Since
3.0.0
eLeapValueType_Boolean 

A boolean value.

Since
3.0.0
eLeapValueType_Int32 

An integer value.

Since
3.0.0
eLeapValueType_Float 

A floating point value.

Since
3.0.0
eLeapValueType_String 

A string value.

Since
3.0.0