Function leap_sys::LeapSetPrimaryDevice

source · [−]
pub unsafe extern "C" fn LeapSetPrimaryDevice(
    hConnection: LEAP_CONNECTION,
    hDevice: LEAP_DEVICE,
    unsubscribeOthers: bool
) -> eLeapRS
Expand description

\ingroup Functions For a multi-device aware client, sets the device to use in the context of non-“Ex” API functions which are logically device-specific but don’t provide a device parameter.

Automatically subscribes to the specified device (see LeapSubscribeEvents()), and if \p unsubscribeOthers is \c true, then unsubscribes from all other devices as well (see LeapUnsubscribeEvents()).

Affects future invocations of the following functions:

  • LeapCameraMatrix()
  • LeapDistortionCoeffs()
  • LeapGetFrameSize()
  • LeapInterpolateFrame()
  • LeapInterpolateFrameFromTime()
  • LeapPixelToRectilinear()
  • LeapRectilinearToPixel()

It is not necessary to call this function from a client that does not claim to be multi-device-aware (see ::eLeapConnectionConfig and ::LeapCreateConnection).

@param hConnection The connection handle created by LeapCreateConnection(). @param hDevice A device handle returned by LeapOpenDevice(). @param unsubscribeOthers If \c true, unsubscribe from all other devices. @returns The operation result code, a member of the eLeapRS enumeration. @since 5.4.0