Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
rs_frame.h
Go to the documentation of this file.
1 /* License: Apache 2.0. See LICENSE file in root directory.
2  Copyright(c) 2017 Intel Corporation. All Rights Reserved. */
3 
10 #ifndef LIBREALSENSE_RS2_FRAME_H
11 #define LIBREALSENSE_RS2_FRAME_H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 #include "rs_types.h"
17 
20 {
27 
30 {
72 
75 {
82 
91 
99 int rs2_supports_frame_metadata(const rs2_frame* frame, rs2_frame_metadata_value frame_metadata, rs2_error** error);
100 
110 
118 
125 rs2_sensor* rs2_get_frame_sensor(const rs2_frame* frame, rs2_error** error);
126 
133 unsigned long long rs2_get_frame_number(const rs2_frame* frame, rs2_error** error);
134 
141 int rs2_get_frame_data_size(const rs2_frame* frame, rs2_error** error);
142 
149 const void* rs2_get_frame_data(const rs2_frame* frame, rs2_error** error);
150 
157 int rs2_get_frame_width(const rs2_frame* frame, rs2_error** error);
158 
165 int rs2_get_frame_height(const rs2_frame* frame, rs2_error** error);
166 
171 float rs2_depth_frame_get_units( const rs2_frame* frame, rs2_error** error );
172 
179 int rs2_get_frame_stride_in_bytes(const rs2_frame* frame, rs2_error** error);
180 
188 int rs2_get_frame_bits_per_pixel(const rs2_frame* frame, rs2_error** error);
189 
196 void rs2_frame_add_ref(rs2_frame* frame, rs2_error ** error);
197 
202 void rs2_release_frame(rs2_frame* frame);
203 
210 void rs2_keep_frame(rs2_frame* frame);
211 
219 rs2_vertex* rs2_get_frame_vertices(const rs2_frame* frame, rs2_error** error);
220 
228 void rs2_export_to_ply(const rs2_frame* frame, const char* fname, rs2_frame* texture, rs2_error** error);
229 
238 
245 int rs2_get_frame_points_count(const rs2_frame* frame, rs2_error** error);
246 
254 
262 int rs2_is_frame_extendable_to(const rs2_frame* frame, rs2_extension extension_type, rs2_error ** error);
263 
279  int new_bpp, int new_width, int new_height, int new_stride, rs2_extension frame_type, rs2_error** error);
280 
292  rs2_extension frame_type, rs2_error** error);
293 
303 rs2_frame* rs2_allocate_points(rs2_source* source, const rs2_stream_profile* new_stream, rs2_frame* original, rs2_error** error);
304 
314 rs2_frame* rs2_allocate_composite_frame(rs2_source* source, rs2_frame** frames, int count, rs2_error** error);
315 
325 rs2_frame* rs2_extract_frame(rs2_frame* composite, int index, rs2_error** error);
326 
333 int rs2_embedded_frames_count(rs2_frame* composite, rs2_error** error);
334 
341 void rs2_synthetic_frame_ready(rs2_source* source, rs2_frame* frame, rs2_error** error);
342 
343 
350 void rs2_pose_frame_get_pose_data(const rs2_frame* frame, rs2_pose* pose, rs2_error** error);
351 
362 void rs2_extract_target_dimensions(const rs2_frame* frame, rs2_calib_target_type calib_type, float * target_dims, unsigned int target_dims_size, rs2_error** error);
363 
364 #ifdef __cplusplus
365 }
366 #endif
367 #endif
Definition: rs_frame.h:67
void rs2_export_to_ply(const rs2_frame *frame, const char *fname, rs2_frame *texture, rs2_error **error)
float rs2_depth_frame_get_units(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:34
Definition: rs_frame.h:33
int rs2_get_frame_points_count(const rs2_frame *frame, rs2_error **error)
const rs2_stream_profile * rs2_get_frame_stream_profile(const rs2_frame *frame, rs2_error **error)
rs2_frame * rs2_allocate_composite_frame(rs2_source *source, rs2_frame **frames, int count, rs2_error **error)
rs2_sensor * rs2_get_frame_sensor(const rs2_frame *frame, rs2_error **error)
const char * rs2_timestamp_domain_to_string(rs2_timestamp_domain info)
const char * rs2_frame_metadata_to_string(rs2_frame_metadata_value metadata)
Definition: rs_frame.h:21
int rs2_is_frame_extendable_to(const rs2_frame *frame, rs2_extension extension_type, rs2_error **error)
rs2_frame * rs2_allocate_points(rs2_source *source, const rs2_stream_profile *new_stream, rs2_frame *original, rs2_error **error)
Definition: rs_frame.h:41
Definition: rs_frame.h:57
void rs2_keep_frame(rs2_frame *frame)
rs2_calib_target_type
Calibration target type.
Definition: rs_frame.h:74
rs2_time_t rs2_get_frame_timestamp(const rs2_frame *frame, rs2_error **error)
rs2_pixel * rs2_get_frame_texture_coordinates(const rs2_frame *frame, rs2_error **error)
3D coordinates with origin at topmost left corner of the lense, with positive Z pointing away from th...
Definition: rs_types.h:117
Definition: rs_frame.h:51
const char * rs2_frame_metadata_value_to_string(rs2_frame_metadata_value metadata)
int rs2_supports_frame_metadata(const rs2_frame *frame, rs2_frame_metadata_value frame_metadata, rs2_error **error)
Definition: rs_frame.h:52
struct rs2_sensor rs2_sensor
Definition: rs_types.h:283
int rs2_get_frame_height(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:66
Definition: rs_frame.h:24
Definition: rs_frame.h:45
int rs2_get_frame_stride_in_bytes(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:37
rs2_frame * rs2_allocate_synthetic_video_frame(rs2_source *source, const rs2_stream_profile *new_stream, rs2_frame *original, int new_bpp, int new_width, int new_height, int new_stride, rs2_extension frame_type, rs2_error **error)
Definition: rs_frame.h:62
int rs2_embedded_frames_count(rs2_frame *composite, rs2_error **error)
Definition: rs_frame.h:31
Exposes RealSense structs.
int rs2_get_frame_width(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:46
Definition: rs_frame.h:68
rs2_timestamp_domain rs2_get_frame_timestamp_domain(const rs2_frame *frameset, rs2_error **error)
Definition: rs_types.h:140
void rs2_synthetic_frame_ready(rs2_source *source, rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:48
struct rs2_stream_profile rs2_stream_profile
Definition: rs_types.h:270
Definition: rs_frame.h:38
const char * rs2_calib_target_type_to_string(rs2_calib_target_type type)
Definition: rs_frame.h:79
unsigned long long rs2_get_frame_number(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:35
Definition: rs_frame.h:56
struct rs2_source rs2_source
Definition: rs_types.h:275
Definition: rs_frame.h:47
int rs2_get_frame_data_size(const rs2_frame *frame, rs2_error **error)
void rs2_extract_target_dimensions(const rs2_frame *frame, rs2_calib_target_type calib_type, float *target_dims, unsigned int target_dims_size, rs2_error **error)
Definition: rs_frame.h:42
Definition: rs_frame.h:63
Definition: rs_frame.h:40
Definition: rs_frame.h:32
rs2_frame * rs2_allocate_synthetic_motion_frame(rs2_source *source, const rs2_stream_profile *new_stream, rs2_frame *original, rs2_extension frame_type, rs2_error **error)
Definition: rs_frame.h:53
rs2_extension
Specifies advanced interfaces (capabilities) objects may implement.
Definition: rs_types.h:166
long long rs2_metadata_type
Definition: rs_types.h:302
Definition: rs_frame.h:50
rs2_vertex * rs2_get_frame_vertices(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:23
void rs2_frame_add_ref(rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:61
Definition: rs_frame.h:65
void rs2_release_frame(rs2_frame *frame)
Definition: rs_frame.h:64
rs2_frame * rs2_extract_frame(rs2_frame *composite, int index, rs2_error **error)
rs2_metadata_type rs2_get_frame_metadata(const rs2_frame *frame, rs2_frame_metadata_value frame_metadata, rs2_error **error)
struct rs2_error rs2_error
Definition: rs_types.h:259
double rs2_time_t
Definition: rs_types.h:301
Definition: rs_frame.h:43
Definition: rs_frame.h:39
void rs2_pose_frame_get_pose_data(const rs2_frame *frame, rs2_pose *pose, rs2_error **error)
Definition: rs_frame.h:22
int rs2_get_frame_bits_per_pixel(const rs2_frame *frame, rs2_error **error)
rs2_frame_metadata_value
Per-Frame-Metadata is the set of read-only properties that might be exposed for each individual frame...
Definition: rs_frame.h:29
struct rs2_frame rs2_frame
Definition: rs_types.h:262
const void * rs2_get_frame_data(const rs2_frame *frame, rs2_error **error)
Pixel location within 2D image. (0,0) is the topmost, left corner. Positive X is right, positive Y is down.
Definition: rs_types.h:123
rs2_timestamp_domain
Specifies the clock in relation to which the frame timestamp was measured.
Definition: rs_frame.h:19