org.bytedeco.librealsense

Class frame

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.librealsense.frame

All Implemented Interfaces:

AutoCloseable

@Namespace(value="rs")
 @NoOffset
 @Properties(inherit=RealSense.class)
public class frame
extends Pointer

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
frame()
frame(frame other)
frame(long size) Native array allocator.
frame(Pointer p) Pointer cast constructor.
frame(rs_device device, rs_frame_ref frame_ref)

Method Summary

Modifier and Type	Method and Description
int	get_bpp() retrieve bits per pixel
Pointer	get_data()
int	get_format()
double	get_frame_metadata(int frame_metadata) retrieve the current value of a single frame_metadata
long	get_frame_number()
int	get_frame_timestamp_domain() retrieve the timestamp domain
int	get_framerate()
int	get_height()
int	get_stream_type()
int	get_stride()
double	get_timestamp() retrieve the time at which the frame was captured
int	get_width()
frame	position(long position)
frame	put(frame other)
boolean	supports_frame_metadata(int frame_metadata) determine if the device allows a specific metadata to be queried
void	swap(frame other)

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, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

frame

public frame(Pointer p)

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

frame

public frame(long size)

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

frame

public frame()

frame

public frame(@Const @ByRef
             frame other)

frame

public frame(rs_device device,
             rs_frame_ref frame_ref)

Method Detail

position

public frame position(long position)

Overrides:

position in class Pointer

put

@ByRef
 @Name(value="operator =")
public frame put(@ByVal
                                                   frame other)

swap

public void swap(@ByRef
                 frame other)

get_timestamp

public double get_timestamp()

retrieve the time at which the frame was captured

Returns:

the timestamp of the frame, in milliseconds since the device was started

get_frame_timestamp_domain

@Cast(value="rs::timestamp_domain")
public int get_frame_timestamp_domain()

retrieve the timestamp domain

Returns:

timestamp domain (clock name) for timestamp values

get_frame_metadata

public double get_frame_metadata(@Cast(value="rs_frame_metadata")
                                 int frame_metadata)

retrieve the current value of a single frame_metadata

Parameters:

frame_metadata - [in] the frame_metadata whose value should be retrieved

Returns:

the value of the frame_metadata

supports_frame_metadata

@Cast(value="bool")
public boolean supports_frame_metadata(@Cast(value="rs_frame_metadata")
                                                           int frame_metadata)

determine if the device allows a specific metadata to be queried

Parameters:

frame_metadata - [in] the frame_metadata to check for support

Returns:

true if the frame_metadata can be queried

get_frame_number

@Cast(value="unsigned long long")
public long get_frame_number()

get_data

@Const
public Pointer get_data()

get_width

public int get_width()

get_height

public int get_height()

get_framerate

public int get_framerate()

get_stride

public int get_stride()

get_bpp

public int get_bpp()

retrieve bits per pixel

Returns:

number of bits per one pixel

get_format

@Cast(value="rs::format")
public int get_format()

get_stream_type

@Cast(value="rs::stream")
public int get_stream_type()