org.bytedeco.javacpp

Class freenect2.Frame

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.freenect2.Frame

All Implemented Interfaces:

AutoCloseable

Enclosing class:

freenect2

@Namespace(value="libfreenect2")
 @NoOffset
public static class freenect2.Frame
extends org.bytedeco.javacpp.Pointer

Frame format and metadata. \ingroup frame

Nested Class Summary

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

org.bytedeco.javacpp.Pointer.CustomDeallocator, org.bytedeco.javacpp.Pointer.Deallocator, org.bytedeco.javacpp.Pointer.NativeDeallocator

Field Summary

Fields

Modifier and Type	Field and Description
static int	BGRX enum libfreenect2::Frame::Format
static int	Color enum libfreenect2::Frame::Type
static int	Depth enum libfreenect2::Frame::Type
static int	Float enum libfreenect2::Frame::Format
static int	Gray enum libfreenect2::Frame::Format
static int	Invalid enum libfreenect2::Frame::Format
static int	Ir enum libfreenect2::Frame::Type
static int	Raw enum libfreenect2::Frame::Format
static int	RGBX enum libfreenect2::Frame::Format

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Frame(long width, long height, long bytes_per_pixel)
Frame(long width, long height, long bytes_per_pixel, byte[] data_)
Frame(long width, long height, long bytes_per_pixel, ByteBuffer data_)
Frame(long width, long height, long bytes_per_pixel, org.bytedeco.javacpp.BytePointer data_) Construct a new frame.
Frame(org.bytedeco.javacpp.Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
long	bytes_per_pixel() Number of bytes in a pixel.
freenect2.Frame	bytes_per_pixel(long bytes_per_pixel)
org.bytedeco.javacpp.BytePointer	data() Data of the frame (aligned).
freenect2.Frame	data(org.bytedeco.javacpp.BytePointer data)
float	exposure() From 0.5 (very bright) to ~60.0 (fully covered)
freenect2.Frame	exposure(float exposure)
int	format() Byte format.
freenect2.Frame	format(int format)
float	gain() From 1.0 (bright) to 1.5 (covered)
freenect2.Frame	gain(float gain)
float	gamma() From 1.0 (bright) to 6.4 (covered)
freenect2.Frame	gamma(float gamma)
long	height() Number of lines in the frame.
freenect2.Frame	height(long height)
int	sequence() Increasing frame sequence number
freenect2.Frame	sequence(int sequence)
int	status() zero if ok; non-zero for errors.
freenect2.Frame	status(int status)
int	timestamp() Unit: roughly or exactly 0.1 millisecond
freenect2.Frame	timestamp(int timestamp)
long	width() Length of a line (in pixels).
freenect2.Frame	width(long width)

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, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Field Detail

Color

public static final int Color

enum libfreenect2::Frame::Type

See Also:

Constant Field Values

Ir

public static final int Ir

enum libfreenect2::Frame::Type

See Also:

Constant Field Values

Depth

public static final int Depth

enum libfreenect2::Frame::Type

See Also:

Constant Field Values

Invalid

public static final int Invalid

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

Raw

public static final int Raw

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

Float

public static final int Float

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

BGRX

public static final int BGRX

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

RGBX

public static final int RGBX

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

Gray

public static final int Gray

enum libfreenect2::Frame::Format

See Also:

Constant Field Values

Constructor Detail

Frame

public Frame(org.bytedeco.javacpp.Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Frame

public Frame(@Cast(value="size_t")
             long width,
             @Cast(value="size_t")
             long height,
             @Cast(value="size_t")
             long bytes_per_pixel,
             @Cast(value="unsigned char*")
             org.bytedeco.javacpp.BytePointer data_)

Construct a new frame.

Parameters:

width - Width in pixel

height - Height in pixel

bytes_per_pixel - Bytes per pixel

data_ - Memory to store frame data. If NULL, new memory is allocated.

Frame

public Frame(@Cast(value="size_t")
             long width,
             @Cast(value="size_t")
             long height,
             @Cast(value="size_t")
             long bytes_per_pixel)

Frame

public Frame(@Cast(value="size_t")
             long width,
             @Cast(value="size_t")
             long height,
             @Cast(value="size_t")
             long bytes_per_pixel,
             @Cast(value="unsigned char*")
             ByteBuffer data_)

Frame

public Frame(@Cast(value="size_t")
             long width,
             @Cast(value="size_t")
             long height,
             @Cast(value="size_t")
             long bytes_per_pixel,
             @Cast(value="unsigned char*")
             byte[] data_)

Method Detail

width

@Cast(value="size_t")
public long width()

Length of a line (in pixels).

width

public freenect2.Frame width(long width)

height

@Cast(value="size_t")
public long height()

Number of lines in the frame.

height

public freenect2.Frame height(long height)

bytes_per_pixel

@Cast(value="size_t")
public long bytes_per_pixel()

Number of bytes in a pixel. If frame format is 'Raw' this is the buffer size.

bytes_per_pixel

public freenect2.Frame bytes_per_pixel(long bytes_per_pixel)

data

@Cast(value="unsigned char*")
public org.bytedeco.javacpp.BytePointer data()

Data of the frame (aligned). @see See Frame::Type for pixel format.

data

public freenect2.Frame data(org.bytedeco.javacpp.BytePointer data)

timestamp

@Cast(value="uint32_t")
public int timestamp()

Unit: roughly or exactly 0.1 millisecond

timestamp

public freenect2.Frame timestamp(int timestamp)

sequence

@Cast(value="uint32_t")
public int sequence()

Increasing frame sequence number

sequence

public freenect2.Frame sequence(int sequence)

exposure

public float exposure()

From 0.5 (very bright) to ~60.0 (fully covered)

exposure

public freenect2.Frame exposure(float exposure)

gain

public float gain()

From 1.0 (bright) to 1.5 (covered)

gain

public freenect2.Frame gain(float gain)

gamma

public float gamma()

From 1.0 (bright) to 6.4 (covered)

gamma

public freenect2.Frame gamma(float gamma)

status

@Cast(value="uint32_t")
public int status()

zero if ok; non-zero for errors.

status

public freenect2.Frame status(int status)

format

@Cast(value="libfreenect2::Frame::Format")
public int format()

Byte format. Informative only, doesn't indicate errors.

format

public freenect2.Frame format(int format)