org.bytedeco.libfreenect2

Class Freenect2

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.libfreenect2.Freenect2

All Implemented Interfaces:

AutoCloseable

@Namespace(value="libfreenect2")
 @NoOffset
 @Properties(inherit=freenect2.class)
public class Freenect2
extends Pointer

Library context to find and open devices. You will first find existing devices by calling enumerateDevices(). Then you can openDevice() and control the devices with returned Freenect2Device object. You may open devices with custom PacketPipeline. After passing a PacketPipeline object to libfreenect2 do not use or free the object, libfreenect2 will take care. If openDevice() fails the PacketPipeline object will get deleted. A new PacketPipeline object has to be created each time a device is opened.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Freenect2()
Freenect2(long size) Native array allocator.
Freenect2(Pointer usb_context)

Method Summary

Modifier and Type	Method and Description
int	enumerateDevices() Must be called before doing anything else.
BytePointer	getDefaultDeviceSerialNumber()
BytePointer	getDeviceSerialNumber(int idx)
Freenect2	getPointer(long i)
Freenect2Device	openDefaultDevice() Open the first device with default pipeline.
Freenect2Device	openDefaultDevice(PacketPipeline factory) Open the first device.
Freenect2Device	openDevice(BytePointer serial) Open device by serial number with default pipeline.
Freenect2Device	openDevice(BytePointer serial, PacketPipeline factory) Open device by serial number.
Freenect2Device	openDevice(int idx) Open device by index with default pipeline.
Freenect2Device	openDevice(int idx, PacketPipeline factory) Open device by index.
Freenect2Device	openDevice(String serial)
Freenect2Device	openDevice(String serial, PacketPipeline factory)
Freenect2	position(long position)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Freenect2

public Freenect2(long size)

Native array allocator. Access with Pointer.position(long).

Freenect2

public Freenect2(Pointer usb_context)

Parameters:

usb_context - If the libusb context is provided, Freenect2 will use it instead of creating one.

Freenect2

public Freenect2()

Method Detail

position

public Freenect2 position(long position)

Overrides:

position in class Pointer

getPointer

public Freenect2 getPointer(long i)

Overrides:

getPointer in class Pointer

enumerateDevices

public int enumerateDevices()

Must be called before doing anything else.

Returns:

Number of devices, 0 if none

getDeviceSerialNumber

@StdString
public BytePointer getDeviceSerialNumber(int idx)

Parameters:

idx - Device index

Returns:

Device serial number, or empty if the index is invalid.

getDefaultDeviceSerialNumber

@StdString
public BytePointer getDefaultDeviceSerialNumber()

Returns:

Device serial number, or empty if no device exists.

openDevice

public Freenect2Device openDevice(int idx)

Open device by index with default pipeline.

Parameters:

idx - Index number. Index numbers are not determinstic during enumeration.

Returns:

New device object, or NULL on failure

openDevice

public Freenect2Device openDevice(int idx,
                                  @Const
                                  PacketPipeline factory)

Open device by index.

Parameters:

idx - Index number. Index numbers are not determinstic during enumeration.

factory - New PacketPipeline instance. This is always automatically freed.

Returns:

New device object, or NULL on failure

openDevice

public Freenect2Device openDevice(@StdString
                                  BytePointer serial)

Open device by serial number with default pipeline.

Parameters:

serial - Serial number

Returns:

New device object, or NULL on failure

openDevice

public Freenect2Device openDevice(@StdString
                                  String serial)

openDevice

public Freenect2Device openDevice(@StdString
                                  BytePointer serial,
                                  @Const
                                  PacketPipeline factory)

Open device by serial number.

Parameters:

serial - Serial number

factory - New PacketPipeline instance. This is always automatically freed.

Returns:

New device object, or NULL on failure

openDevice

public Freenect2Device openDevice(@StdString
                                  String serial,
                                  @Const
                                  PacketPipeline factory)

openDefaultDevice

public Freenect2Device openDefaultDevice()

Open the first device with default pipeline.

Returns:

New device object, or NULL on failure

openDefaultDevice

public Freenect2Device openDefaultDevice(@Const
                                         PacketPipeline factory)

Open the first device.

Parameters:

factory - New PacketPipeline instance. This is always automatically freed.

Returns:

New device object, or NULL on failure