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 {
26 
29 {
64 
73 
81 int rs2_supports_frame_metadata(const rs2_frame* frame, rs2_frame_metadata_value frame_metadata, rs2_error** error);
82 
92 
100 
107 unsigned long long rs2_get_frame_number(const rs2_frame* frame, rs2_error** error);
108 
115 const void* rs2_get_frame_data(const rs2_frame* frame, rs2_error** error);
116 
123 int rs2_get_frame_width(const rs2_frame* frame, rs2_error** error);
124 
131 int rs2_get_frame_height(const rs2_frame* frame, rs2_error** error);
132 
139 int rs2_get_frame_stride_in_bytes(const rs2_frame* frame, rs2_error** error);
140 
148 int rs2_get_frame_bits_per_pixel(const rs2_frame* frame, rs2_error** error);
149 
156 void rs2_frame_add_ref(rs2_frame* frame, rs2_error ** error);
157 
162 void rs2_release_frame(rs2_frame* frame);
163 
170 void rs2_keep_frame(rs2_frame* frame);
171 
179 rs2_vertex* rs2_get_frame_vertices(const rs2_frame* frame, rs2_error** error);
180 
188 void rs2_export_to_ply(const rs2_frame* frame, const char* fname, rs2_frame* texture, rs2_error** error);
189 
198 
205 int rs2_get_frame_points_count(const rs2_frame* frame, rs2_error** error);
206 
214 
222 int rs2_is_frame_extendable_to(const rs2_frame* frame, rs2_extension extension_type, rs2_error ** error);
223 
239  int new_bpp, int new_width, int new_height, int new_stride, rs2_extension frame_type, rs2_error** error);
240 
250 rs2_frame* rs2_allocate_points(rs2_source* source, const rs2_stream_profile* new_stream, rs2_frame* original, rs2_error** error);
251 
261 rs2_frame* rs2_allocate_composite_frame(rs2_source* source, rs2_frame** frames, int count, rs2_error** error);
262 
272 rs2_frame* rs2_extract_frame(rs2_frame* composite, int index, rs2_error** error);
273 
280 int rs2_embedded_frames_count(rs2_frame* composite, rs2_error** error);
281 
288 void rs2_synthetic_frame_ready(rs2_source* source, rs2_frame* frame, rs2_error** error);
289 
290 
297 void rs2_pose_frame_get_pose_data(const rs2_frame* frame, rs2_pose* pose, rs2_error** error);
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 #endif
void rs2_export_to_ply(const rs2_frame *frame, const char *fname, rs2_frame *texture, rs2_error **error)
Definition: rs_frame.h:33
Definition: rs_frame.h:32
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)
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:40
Definition: rs_frame.h:56
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:83
Definition: rs_frame.h:50
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:51
int rs2_get_frame_height(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:23
Definition: rs_frame.h:44
int rs2_get_frame_stride_in_bytes(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:36
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:30
Exposes RealSense structs.
int rs2_get_frame_width(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:45
Definition: rs_frame.h:60
rs2_timestamp_domain rs2_get_frame_timestamp_domain(const rs2_frame *frameset, rs2_error **error)
Definition: rs_types.h:106
void rs2_synthetic_frame_ready(rs2_source *source, rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:47
struct rs2_stream_profile rs2_stream_profile
Definition: rs_types.h:207
Definition: rs_frame.h:37
unsigned long long rs2_get_frame_number(const rs2_frame *frame, rs2_error **error)
Definition: rs_frame.h:34
Definition: rs_frame.h:55
struct rs2_source rs2_source
Definition: rs_types.h:212
Definition: rs_frame.h:46
Definition: rs_frame.h:41
Definition: rs_frame.h:39
Definition: rs_frame.h:31
Definition: rs_frame.h:52
rs2_extension
Specifies advanced interfaces (capabilities) objects may implement.
Definition: rs_types.h:131
long long rs2_metadata_type
Definition: rs_types.h:231
Definition: rs_frame.h:49
rs2_vertex * rs2_get_frame_vertices(const rs2_frame *frame, rs2_error **error)
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:197
double rs2_time_t
Definition: rs_types.h:230
Definition: rs_frame.h:42
Definition: rs_frame.h:38
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 are set of read-only properties that might be exposed for each individual frame.
Definition: rs_frame.h:28
struct rs2_frame rs2_frame
Definition: rs_types.h:199
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:89
rs2_timestamp_domain
Specifies the clock in relation to which the frame timestamp was measured.
Definition: rs_frame.h:19