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 {
65 
74 
82 int rs2_supports_frame_metadata(const rs2_frame* frame, rs2_frame_metadata_value frame_metadata, rs2_error** error);
83 
93 
101 
108 rs2_sensor* rs2_get_frame_sensor(const rs2_frame* frame, rs2_error** error);
109 
116 unsigned long long rs2_get_frame_number(const rs2_frame* frame, rs2_error** error);
117 
124 int rs2_get_frame_data_size(const rs2_frame* frame, rs2_error** error);
125 
132 const void* rs2_get_frame_data(const rs2_frame* frame, rs2_error** error);
133 
140 int rs2_get_frame_width(const rs2_frame* frame, rs2_error** error);
141 
148 int rs2_get_frame_height(const rs2_frame* frame, rs2_error** error);
149 
156 int rs2_get_frame_stride_in_bytes(const rs2_frame* frame, rs2_error** error);
157 
165 int rs2_get_frame_bits_per_pixel(const rs2_frame* frame, rs2_error** error);
166 
173 void rs2_frame_add_ref(rs2_frame* frame, rs2_error ** error);
174 
179 void rs2_release_frame(rs2_frame* frame);
180 
187 void rs2_keep_frame(rs2_frame* frame);
188 
196 rs2_vertex* rs2_get_frame_vertices(const rs2_frame* frame, rs2_error** error);
197 
205 void rs2_export_to_ply(const rs2_frame* frame, const char* fname, rs2_frame* texture, rs2_error** error);
206 
215 
222 int rs2_get_frame_points_count(const rs2_frame* frame, rs2_error** error);
223 
231 
239 int rs2_is_frame_extendable_to(const rs2_frame* frame, rs2_extension extension_type, rs2_error ** error);
240 
256  int new_bpp, int new_width, int new_height, int new_stride, rs2_extension frame_type, rs2_error** error);
257 
267 rs2_frame* rs2_allocate_points(rs2_source* source, const rs2_stream_profile* new_stream, rs2_frame* original, rs2_error** error);
268 
278 rs2_frame* rs2_allocate_composite_frame(rs2_source* source, rs2_frame** frames, int count, rs2_error** error);
279 
289 rs2_frame* rs2_extract_frame(rs2_frame* composite, int index, rs2_error** error);
290 
297 int rs2_embedded_frames_count(rs2_frame* composite, rs2_error** error);
298 
305 void rs2_synthetic_frame_ready(rs2_source* source, rs2_frame* frame, rs2_error** error);
306 
307 
314 void rs2_pose_frame_get_pose_data(const rs2_frame* frame, rs2_pose* pose, rs2_error** error);
315 
316 #ifdef __cplusplus
317 }
318 #endif
319 #endif
void rs2_export_to_ply(const rs2_frame *frame, const char *fname, rs2_frame *texture, 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_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:85
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:233
int rs2_get_frame_height(const rs2_frame *frame, rs2_error **error)
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)
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:61
rs2_timestamp_domain rs2_get_frame_timestamp_domain(const rs2_frame *frameset, rs2_error **error)
Definition: rs_types.h:108
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:220
Definition: rs_frame.h:38
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:225
Definition: rs_frame.h:47
int rs2_get_frame_data_size(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:42
Definition: rs_frame.h:40
Definition: rs_frame.h:32
Definition: rs_frame.h:53
rs2_extension
Specifies advanced interfaces (capabilities) objects may implement.
Definition: rs_types.h:133
long long rs2_metadata_type
Definition: rs_types.h:246
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)
void rs2_release_frame(rs2_frame *frame)
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:210
double rs2_time_t
Definition: rs_types.h:245
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:212
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,...
Definition: rs_types.h:91
rs2_timestamp_domain
Specifies the clock in relation to which the frame timestamp was measured.
Definition: rs_frame.h:19