Struct CompositeFrame 

pub struct CompositeFrame { /* private fields */ }

Holds the raw data pointer from an RS2 Composite frame type.

Implementations

impl CompositeFrame

pub fn count(&self) -> usize

Gets the number of individual frames included in the composite frame.

pub fn is_empty(&self) -> bool

Checks if the Composite frame collection is empty.

pub fn frames_of_type<F>(&self) -> Vec<F>

where F: TryFrom<NonNull<rs2_frame>> + FrameCategory,

Retrieves all frames in the Composite frame collection of a given type.

Generic Arguments

F must implement FrameCategory. Some examples of good types to use for this are:

• ColorFrame
• DepthFrame
• DisparityFrame
• PoseFrame
• PointsFrame

pub unsafe fn get_owned_raw(self) -> NonNull<rs2_frame>

Get (and own) the underlying frame pointer for this frame.

This is primarily useful for passing this frame forward to a processing block or blocks (either via frame queue, directly, callback, etc).

Safety

This does not destroy the underlying frame pointer once self goes out of scope. Instead, the program expects that whatever object was assigned to by this function now manages the lifetime.

Trait Implementations

impl Debug for CompositeFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for CompositeFrame

fn drop(&mut self)

Drop the raw pointer stored with this struct whenever it goes out of scope.

impl From<NonNull<rs2_frame>> for CompositeFrame

fn from(frame: NonNull<rs2_frame>) -> Self

Converts to this type from the input type.

impl Send for CompositeFrame