Exposes RealSense frame functionality for C compilers.
Definition in file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_frame.h.
Go to the source code of this file.
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 is the set of read-only properties that might be exposed for each individual frame. More... | |
| typedef enum rs2_calib_target_type | rs2_calib_target_type |
| Calibration target type. More... | |
Functions | |
| const char * | rs2_timestamp_domain_to_string (rs2_timestamp_domain info) |
| 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) |
| const char * | rs2_calib_target_type_to_string (rs2_calib_target_type type) |
| 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 More... | |
| int | rs2_supports_frame_metadata (const rs2_frame *frame, rs2_frame_metadata_value frame_metadata, rs2_error **error) |
| determine device metadata More... | |
| rs2_timestamp_domain | rs2_get_frame_timestamp_domain (const rs2_frame *frameset, rs2_error **error) |
| retrieve timestamp domain from frame handle. More... | |
| rs2_time_t | rs2_get_frame_timestamp (const rs2_frame *frame, rs2_error **error) |
| retrieve timestamp from frame handle in milliseconds More... | |
| rs2_sensor * | rs2_get_frame_sensor (const rs2_frame *frame, rs2_error **error) |
| retrieve frame parent sensor from frame handle More... | |
| unsigned long long | rs2_get_frame_number (const rs2_frame *frame, rs2_error **error) |
| retrieve frame number from frame handle More... | |
| int | rs2_get_frame_data_size (const rs2_frame *frame, rs2_error **error) |
| retrieve data size from frame handle More... | |
| const void * | rs2_get_frame_data (const rs2_frame *frame, rs2_error **error) |
| retrieve data from frame handle More... | |
| int | rs2_get_frame_width (const rs2_frame *frame, rs2_error **error) |
| retrieve frame width in pixels More... | |
| int | rs2_get_frame_height (const rs2_frame *frame, rs2_error **error) |
| retrieve frame height in pixels More... | |
| float | rs2_depth_frame_get_units (const rs2_frame *frame, rs2_error **error) |
| retrieve the scaling factor to use when converting a depth frame's get_data() units to meters More... | |
| int | rs2_get_frame_stride_in_bytes (const rs2_frame *frame, rs2_error **error) |
| retrieve frame stride in bytes (number of bytes from start of line N to start of line N+1) More... | |
| int | rs2_get_frame_bits_per_pixel (const rs2_frame *frame, rs2_error **error) |
| retrieve bits per pixels in the frame image (note that bits per pixel is not necessarily divided by 8, as in 12bpp) More... | |
| void | rs2_frame_add_ref (rs2_frame *frame, rs2_error **error) |
| create additional reference to a frame without duplicating frame data More... | |
| void | rs2_release_frame (rs2_frame *frame) |
| relases the frame handle More... | |
| 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 More... | |
| 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. More... | |
| 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. More... | |
| rs2_pixel * | rs2_get_frame_texture_coordinates (const rs2_frame *frame, rs2_error **error) |
| 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. More... | |
| int | rs2_get_frame_points_count (const rs2_frame *frame, rs2_error **error) |
| When called on Points frame type, this method returns the number of vertices in the frame. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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) |
| Allocate new motion frame using a frame-source provided form a processing block. More... | |
| rs2_frame * | rs2_allocate_points (rs2_source *source, const rs2_stream_profile *new_stream, rs2_frame *original, rs2_error **error) |
| Allocate new points frame using a frame-source provided from a processing block. More... | |
| 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. More... | |
| rs2_frame * | rs2_extract_frame (rs2_frame *composite, int index, rs2_error **error) |
| Extract frame from within a composite frame. More... | |
| int | rs2_embedded_frames_count (rs2_frame *composite, rs2_error **error) |
| Get number of frames embedded within a composite frame. More... | |
| void | rs2_synthetic_frame_ready (rs2_source *source, rs2_frame *frame, rs2_error **error) |
| This method will dispatch frame callback on a frame. More... | |
| void | rs2_pose_frame_get_pose_data (const rs2_frame *frame, rs2_pose *pose, rs2_error **error) |
| When called on Pose frame type, this method returns the transformation represented by the pose data. More... | |
| 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) |
| Extract the target dimensions on the specific target. More... | |
| typedef enum rs2_calib_target_type rs2_calib_target_type |
Calibration target type.
| typedef enum rs2_frame_metadata_value rs2_frame_metadata_value |
Per-Frame-Metadata is the set of read-only properties that might be exposed for each individual frame.
| typedef enum rs2_timestamp_domain rs2_timestamp_domain |
Specifies the clock in relation to which the frame timestamp was measured.
Calibration target type.
Definition at line 74 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_frame.h.
Per-Frame-Metadata is the set of read-only properties that might be exposed for each individual frame.
| Enumerator | |
|---|---|
| RS2_FRAME_METADATA_FRAME_COUNTER | A sequential index managed per-stream. Integer value |
| RS2_FRAME_METADATA_FRAME_TIMESTAMP | Timestamp set by device clock when data readout and transmit commence. usec |
| RS2_FRAME_METADATA_SENSOR_TIMESTAMP | Timestamp of the middle of sensor's exposure calculated by device. usec |
| RS2_FRAME_METADATA_ACTUAL_EXPOSURE | Sensor's exposure width. When Auto Exposure (AE) is on the value is controlled by firmware. usec |
| RS2_FRAME_METADATA_GAIN_LEVEL | A relative value increasing which will increase the Sensor's gain factor. \ When AE is set On, the value is controlled by firmware. Integer value |
| RS2_FRAME_METADATA_AUTO_EXPOSURE | Auto Exposure Mode indicator. Zero corresponds to AE switched off. |
| RS2_FRAME_METADATA_WHITE_BALANCE | White Balance setting as a color temperature. Kelvin degrees |
| RS2_FRAME_METADATA_TIME_OF_ARRIVAL | Time of arrival in system clock. |
| RS2_FRAME_METADATA_TEMPERATURE | Temperature of the device, measured at the time of the frame capture. Celsius degrees |
| RS2_FRAME_METADATA_BACKEND_TIMESTAMP | Timestamp get from uvc driver. usec |
| RS2_FRAME_METADATA_ACTUAL_FPS | Actual fps. |
| RS2_FRAME_METADATA_FRAME_LASER_POWER | Laser power value 0-360. |
| RS2_FRAME_METADATA_FRAME_LASER_POWER_MODE | Laser power mode. Zero corresponds to Laser power switched off and one for switched on. deprecated, replaced by RS2_FRAME_METADATA_FRAME_EMITTER_MODE |
| RS2_FRAME_METADATA_EXPOSURE_PRIORITY | Exposure priority. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_LEFT | Left region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_RIGHT | Right region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_TOP | Top region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_BOTTOM | Bottom region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_BRIGHTNESS | Color image brightness. |
| RS2_FRAME_METADATA_CONTRAST | Color image contrast. |
| RS2_FRAME_METADATA_SATURATION | Color image saturation. |
| RS2_FRAME_METADATA_SHARPNESS | Color image sharpness. |
| RS2_FRAME_METADATA_AUTO_WHITE_BALANCE_TEMPERATURE | Auto white balance temperature Mode indicator. Zero corresponds to automatic mode switched off. |
| RS2_FRAME_METADATA_BACKLIGHT_COMPENSATION | Color backlight compensation. Zero corresponds to switched off. |
| RS2_FRAME_METADATA_HUE | Color image hue. |
| RS2_FRAME_METADATA_GAMMA | Color image gamma. |
| RS2_FRAME_METADATA_MANUAL_WHITE_BALANCE | Color image white balance. |
| RS2_FRAME_METADATA_POWER_LINE_FREQUENCY | Power Line Frequency for anti-flickering Off/50Hz/60Hz/Auto. |
| RS2_FRAME_METADATA_LOW_LIGHT_COMPENSATION | Color lowlight compensation. Zero corresponds to switched off. |
| RS2_FRAME_METADATA_FRAME_EMITTER_MODE | Emitter mode: 0 - all emitters disabled. 1 - laser enabled. 2 - auto laser enabled (opt). 3 - LED enabled (opt). |
| RS2_FRAME_METADATA_FRAME_LED_POWER | Led power value 0-360. |
| RS2_FRAME_METADATA_RAW_FRAME_SIZE | The number of transmitted payload bytes, not including metadata. |
| RS2_FRAME_METADATA_GPIO_INPUT_DATA | GPIO input data. |
| RS2_FRAME_METADATA_SEQUENCE_NAME | sub-preset id |
| RS2_FRAME_METADATA_SEQUENCE_ID | sub-preset sequence id |
| RS2_FRAME_METADATA_SEQUENCE_SIZE | sub-preset sequence size |
| RS2_FRAME_METADATA_COUNT | |
| RS2_FRAME_METADATA_FRAME_COUNTER | A sequential index managed per-stream. Integer value |
| RS2_FRAME_METADATA_FRAME_TIMESTAMP | Timestamp set by device clock when data readout and transmit commence. usec |
| RS2_FRAME_METADATA_SENSOR_TIMESTAMP | Timestamp of the middle of sensor's exposure calculated by device. usec |
| RS2_FRAME_METADATA_ACTUAL_EXPOSURE | Sensor's exposure width. When Auto Exposure (AE) is on the value is controlled by firmware. usec |
| RS2_FRAME_METADATA_GAIN_LEVEL | A relative value increasing which will increase the Sensor's gain factor. \ When AE is set On, the value is controlled by firmware. Integer value |
| RS2_FRAME_METADATA_AUTO_EXPOSURE | Auto Exposure Mode indicator. Zero corresponds to AE switched off. |
| RS2_FRAME_METADATA_WHITE_BALANCE | White Balance setting as a color temperature. Kelvin degrees |
| RS2_FRAME_METADATA_TIME_OF_ARRIVAL | Time of arrival in system clock. |
| RS2_FRAME_METADATA_TEMPERATURE | Temperature of the device, measured at the time of the frame capture. Celsius degrees |
| RS2_FRAME_METADATA_BACKEND_TIMESTAMP | Timestamp get from uvc driver. usec |
| RS2_FRAME_METADATA_ACTUAL_FPS | Actual fps. |
| RS2_FRAME_METADATA_FRAME_LASER_POWER | Laser power value 0-360. |
| RS2_FRAME_METADATA_FRAME_LASER_POWER_MODE | Laser power mode. Zero corresponds to Laser power switched off and one for switched on. deprecated, replaced by RS2_FRAME_METADATA_FRAME_EMITTER_MODE |
| RS2_FRAME_METADATA_EXPOSURE_PRIORITY | Exposure priority. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_LEFT | Left region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_RIGHT | Right region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_TOP | Top region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_EXPOSURE_ROI_BOTTOM | Bottom region of interest for the auto exposure Algorithm. |
| RS2_FRAME_METADATA_BRIGHTNESS | Color image brightness. |
| RS2_FRAME_METADATA_CONTRAST | Color image contrast. |
| RS2_FRAME_METADATA_SATURATION | Color image saturation. |
| RS2_FRAME_METADATA_SHARPNESS | Color image sharpness. |
| RS2_FRAME_METADATA_AUTO_WHITE_BALANCE_TEMPERATURE | Auto white balance temperature Mode indicator. Zero corresponds to automatic mode switched off. |
| RS2_FRAME_METADATA_BACKLIGHT_COMPENSATION | Color backlight compensation. Zero corresponds to switched off. |
| RS2_FRAME_METADATA_HUE | Color image hue. |
| RS2_FRAME_METADATA_GAMMA | Color image gamma. |
| RS2_FRAME_METADATA_MANUAL_WHITE_BALANCE | Color image white balance. |
| RS2_FRAME_METADATA_POWER_LINE_FREQUENCY | Power Line Frequency for anti-flickering Off/50Hz/60Hz/Auto. |
| RS2_FRAME_METADATA_LOW_LIGHT_COMPENSATION | Color lowlight compensation. Zero corresponds to switched off. |
| RS2_FRAME_METADATA_FRAME_EMITTER_MODE | Emitter mode: 0 - all emitters disabled. 1 - laser enabled. 2 - auto laser enabled (opt). 3 - LED enabled (opt). |
| RS2_FRAME_METADATA_FRAME_LED_POWER | Led power value 0-360. |
| RS2_FRAME_METADATA_RAW_FRAME_SIZE | The number of transmitted payload bytes, not including metadata. |
| RS2_FRAME_METADATA_GPIO_INPUT_DATA | GPIO input data. |
| RS2_FRAME_METADATA_SEQUENCE_NAME | sub-preset id |
| RS2_FRAME_METADATA_SEQUENCE_ID | sub-preset sequence id |
| RS2_FRAME_METADATA_SEQUENCE_SIZE | sub-preset sequence size |
| RS2_FRAME_METADATA_COUNT | |
Definition at line 29 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_frame.h.
| enum rs2_timestamp_domain |
Specifies the clock in relation to which the frame timestamp was measured.
Definition at line 19 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/h/rs_frame.h.
| 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 |
Referenced by rs2::frame_source::allocate_composite_frame().
| rs2_frame* rs2_allocate_points | ( | rs2_source * | source, |
| const rs2_stream_profile * | new_stream, | ||
| rs2_frame * | original, | ||
| rs2_error ** | error | ||
| ) |
Allocate new points frame using a frame-source provided from 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) |
| [out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
Referenced by rs2::frame_source::allocate_points().
| 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 | ||
| ) |
Allocate new motion 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] | 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 |
Referenced by rs2::frame_source::allocate_motion_frame().
| 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 |
Referenced by rs2::frame_source::allocate_video_frame().
| const char* rs2_calib_target_type_to_string | ( | rs2_calib_target_type | type | ) |
retrieve the scaling factor to use when converting a depth frame's get_data() units to meters
Referenced by rs2::depth_frame::get_units().
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 |
Referenced by rs2::frameset::frameset().
| 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 |
Referenced by rs2::points::export_to_ply().
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 |
Referenced by rs2::frameset::foreach_rs(), and rs2::frameset::operator[]().
| 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 | ||
| ) |
Extract the target dimensions on the specific target.
| [in] | frame | Left or right camera frame of specified size based on the target type |
| [in] | calib_type | Calibration target type |
| [in] | target_dims_size | Target dimension array size |
| [out] | target_dims | The array to hold the result target dimensions calculated. For type RS2_CALIB_TARGET_RECT_GAUSSIAN_DOT_VERTICES, the four rectangle side sizes in pixels with the order of top, bottom, left, and right |
| [out] | error | If non-null, receives any error that occurs during this call, otherwise, errors are ignored |
Referenced by rs2::video_frame::extract_target_dimensions().
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 |
Referenced by rs2::frame::add_ref().
| const char* rs2_frame_metadata_to_string | ( | rs2_frame_metadata_value | metadata | ) |
Referenced by operator<<().
| 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 |
Referenced by rs2::video_frame::get_bits_per_pixel().
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 |
Referenced by rs2::frame::get_data().
retrieve data size 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 |
Referenced by rs2::frame::get_data_size().
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 |
Referenced by rs2::video_frame::get_height().
| 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 |
Referenced by rs2::frame::get_frame_metadata().
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 |
Referenced by rs2::frame::frame(), and rs2::frame::get_frame_number().
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 |
Referenced by rs2::points::points().
| rs2_sensor* rs2_get_frame_sensor | ( | const rs2_frame * | frame, |
| rs2_error ** | error | ||
| ) |
retrieve frame parent sensor 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 |
Referenced by rs2::frame::get_sensor().
| 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 |
Referenced by rs2::frame::frame(), and rs2::frame::get_profile().
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 |
Referenced by rs2::video_frame::get_stride_in_bytes().
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 |
Referenced by rs2::points::get_texture_coordinates().
| 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 |
Referenced by rs2::frame::get_timestamp().
| 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 |
Referenced by rs2::frame::get_frame_timestamp_domain().
| 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 |
Referenced by rs2::points::get_vertices().
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 |
Referenced by rs2::video_frame::get_width().
| 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 |
Referenced by rs2::depth_frame::depth_frame(), rs2::disparity_frame::disparity_frame(), rs2::frameset::frameset(), rs2::motion_frame::motion_frame(), rs2::points::points(), rs2::pose_frame::pose_frame(), and rs2::video_frame::video_frame().
| 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 |
Referenced by rs2::frame::keep().
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 |
Referenced by rs2::pose_frame::get_pose_data().
| void rs2_release_frame | ( | rs2_frame * | frame | ) |
relases the frame handle
| [in] | frame | handle returned from a callback |
Referenced by rs2::frame::reset(), and rs2::frame::~frame().
| 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 |
Referenced by rs2::frame::supports_frame_metadata().
| 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 |
Referenced by rs2::frame_source::frame_ready().
| const char* rs2_timestamp_domain_to_string | ( | rs2_timestamp_domain | info | ) |
Referenced by operator<<().