Intel® RealSense™ Cross Platform API
2.13.0
Intel Realsense Cross-platform API
|
Exposes RealSense frame functionality for C compilers. More...
#include "rs_types.h"
Go to the source code of this file.
Classes | |
struct | rs2_vertex |
3D coordinates with origin at topmost left corner of the lense, with positive Z pointing away from the camera, positive X pointing camera right and positive Y pointing camera down More... | |
struct | rs2_pixel |
Pixel location within 2D image. (0,0) is the topmost, left corner. Positive X is right, positive Y is down. More... | |
struct | rs2_vector |
3D vector in Euclidean coordinate space More... | |
struct | rs2_quaternion |
Quaternion used to represent rotation. More... | |
struct | rs2_pose |
Typedefs | |
typedef enum rs2_timestamp_domain | rs2_timestamp_domain |
Specifies the clock in relation to which the frame timestamp was measured. More... | |
typedef enum rs2_frame_metadata_value | rs2_frame_metadata_value |
Per-Frame-Metadata are set of read-only properties that might be exposed for each individual frame. More... | |
typedef struct rs2_vertex | rs2_vertex |
3D coordinates with origin at topmost left corner of the lense, with positive Z pointing away from the camera, positive X pointing camera right and positive Y pointing camera down More... | |
typedef struct rs2_pixel | rs2_pixel |
Pixel location within 2D image. (0,0) is the topmost, left corner. Positive X is right, positive Y is down. More... | |
typedef struct rs2_vector | rs2_vector |
3D vector in Euclidean coordinate space More... | |
typedef struct rs2_quaternion | rs2_quaternion |
Quaternion used to represent rotation. More... | |
typedef struct rs2_pose | rs2_pose |
Exposes RealSense frame functionality for C compilers.
typedef enum rs2_frame_metadata_value rs2_frame_metadata_value |
Per-Frame-Metadata are set of read-only properties that might be exposed for each individual frame.
Pixel location within 2D image. (0,0) is the topmost, left corner. Positive X is right, positive Y is down.
typedef struct rs2_quaternion rs2_quaternion |
Quaternion used to represent rotation.
typedef enum rs2_timestamp_domain rs2_timestamp_domain |
Specifies the clock in relation to which the frame timestamp was measured.
typedef struct rs2_vector rs2_vector |
3D vector in Euclidean coordinate space
typedef struct rs2_vertex rs2_vertex |
3D coordinates with origin at topmost left corner of the lense, with positive Z pointing away from the camera, positive X pointing camera right and positive Y pointing camera down
Per-Frame-Metadata are set of read-only properties that might be exposed for each individual frame.
enum rs2_timestamp_domain |
Specifies the clock in relation to which the frame timestamp was measured.
rs2_frame* rs2_allocate_composite_frame | ( | rs2_source * | source, |
rs2_frame ** | frames, | ||
int | count, | ||
rs2_error ** | error | ||
) |
Allocate new composite frame, aggregating a set of existing frames
[in] | source | Frame pool to allocate the frame from |
[in] | frames | Array of existing frames |
[in] | count | Number of input frames |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
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 | ||
) |
Allocate new video frame using a frame-source provided form a processing block
[in] | source | Frame pool to allocate the frame from |
[in] | new_stream | New stream profile to assign to newly created frame |
[in] | original | A reference frame that can be used to fill in auxilary information like format, width, height, bpp, stride (if applicable) |
[in] | new_bpp | New value for bits per pixel for the allocated frame |
[in] | new_width | New value for width for the allocated frame |
[in] | new_height | New value for height for the allocated frame |
[in] | new_stride | New value for stride in bytes for the allocated frame |
[in] | frame_type | New value for frame type for the allocated frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
Get number of frames embedded within a composite frame
[in] | composite | Composite input frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
void rs2_export_to_ply | ( | const rs2_frame * | frame, |
const char * | fname, | ||
rs2_frame * | texture, | ||
rs2_error ** | error | ||
) |
When called on Points frame type, this method creates a ply file of the model with the given file name.
[in] | frame | Points frame |
[in] | fname | The name for the ply file |
[in] | texture | Texture frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
Extract frame from within a composite frame
[in] | composite | Composite frame |
[in] | index | Index of the frame to extract within the composite frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
create additional reference to a frame without duplicating frame data
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
const char* rs2_frame_metadata_to_string | ( | rs2_frame_metadata_value | metadata | ) |
const char* rs2_frame_metadata_value_to_string | ( | rs2_frame_metadata_value | metadata | ) |
retrieve bits per pixels in the frame image (note that bits per pixel is not necessarily divided by 8, as in 12bpp)
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
retrieve data from frame handle
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
retrieve frame height in pixels
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
rs2_metadata_type rs2_get_frame_metadata | ( | const rs2_frame * | frame, |
rs2_frame_metadata_value | frame_metadata, | ||
rs2_error ** | error | ||
) |
retrieve metadata from frame handle
[in] | frame | handle returned from a callback |
[in] | frame_metadata | the rs2_frame_metadata whose latest frame we are interested in |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
retrieve frame number from frame handle
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
When called on Points frame type, this method returns the number of vertices in the frame
[in] | frame | Points frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
const rs2_stream_profile* rs2_get_frame_stream_profile | ( | const rs2_frame * | frame, |
rs2_error ** | error | ||
) |
Returns the stream profile that was used to start the stream of this frame
[in] | frame | frame reference, owned by the user |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
retrieve frame stride in bytes (number of bytes from start of line N to start of line N+1)
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
When called on Points frame type, this method returns a pointer to an array of texture coordinates per vertex Each coordinate represent a (u,v) pair within [0,1] range, to be mapped to texture image
[in] | frame | Points frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
rs2_time_t rs2_get_frame_timestamp | ( | const rs2_frame * | frame, |
rs2_error ** | error | ||
) |
retrieve timestamp from frame handle in milliseconds
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
rs2_timestamp_domain rs2_get_frame_timestamp_domain | ( | const rs2_frame * | frameset, |
rs2_error ** | error | ||
) |
retrieve timestamp domain from frame handle. timestamps can only be comparable if they are in common domain (for example, depth timestamp might come from system time while color timestamp might come from the device) this method is used to check if two timestamp values are comparable (generated from the same clock)
[in] | frameset | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
rs2_vertex* rs2_get_frame_vertices | ( | const rs2_frame * | frame, |
rs2_error ** | error | ||
) |
When called on Points frame type, this method returns a pointer to an array of 3D vertices of the model The coordinate system is: X right, Y up, Z away from the camera. Units: Meters
[in] | frame | Points frame |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
retrieve frame width in pixels
[in] | frame | handle returned from a callback |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
int rs2_is_frame_extendable_to | ( | const rs2_frame * | frame, |
rs2_extension | extension_type, | ||
rs2_error ** | error | ||
) |
Test if the given frame can be extended to the requested extension
[in] | frame | Realsense frame |
[in] | extension_type | The extension to which the frame should be tested if it is extendable |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
void rs2_keep_frame | ( | rs2_frame * | frame | ) |
communicate to the library you intend to keep the frame alive for a while this will remove the frame from the regular count of the frame pool once this function is called, the SDK can no longer guarantee 0-allocations during frame cycling
[in] | frame | handle returned from a callback |
When called on Pose frame type, this method returns the transformation represented by the pose data
[in] | frame | Pose frame |
[out] | pose | Pointer to a user allocated struct, which contains the pose info after a successful return |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
void rs2_release_frame | ( | rs2_frame * | frame | ) |
relases the frame handle
[in] | frame | handle returned from a callback |
int rs2_supports_frame_metadata | ( | const rs2_frame * | frame, |
rs2_frame_metadata_value | frame_metadata, | ||
rs2_error ** | error | ||
) |
determine device metadata
[in] | frame | handle returned from a callback |
[in] | frame_metadata | the metadata to check for support |
[out] | error | if non-null, receives any error that occurs during this call, otherwise, errors are ignored |
void rs2_synthetic_frame_ready | ( | rs2_source * | source, |
rs2_frame * | frame, | ||
rs2_error ** | error | ||
) |
This method will dispatch frame callback on a frame
[in] | source | Frame pool provided by the processing block |
[in] | frame | Frame to dispatch, frame ownership is passed to this function, so you don't have to call release_frame after it |
[out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
const char* rs2_timestamp_domain_to_string | ( | rs2_timestamp_domain | info | ) |