Struct realsense_rust::frame::Frame

pub struct Frame<Kind> where
    Kind: FrameKind,  { /* fields omitted */ }

Represents a collection of sensor data.

Implementations

impl Frame<Any>

pub fn is_extendable_to<Kind>(&self) -> Result<bool> where
    Kind: NonAnyFrameKind, 

pub fn try_extend_to<Kind>(self) -> Result<Result<Frame<Kind>, Self>> where
    Kind: NonAnyFrameKind, 

pub fn try_extend(self) -> Result<ExtendedFrame>

impl Frame<Composite>

pub fn len(&self) -> Result<usize>

Gets the number of frames included in the composite frame.

pub fn is_empty(&self) -> Result<bool>

Checks if the composite-frame contains no sub-frames.

pub fn get(&self, index: usize) -> Result<Option<AnyFrame>>

Gets the frame in frameset by index.

The method throws error if index is out of bound given by Frame::len.

pub fn try_into_iter(self) -> Result<CompositeFrameIntoIter>

Unpacks the set of frames and turns into iterable CompositeFrameIntoIter instance.

pub fn try_iter(&self) -> Result<CompositeFrameIter>

pub fn first_of<Kind>(&self, stream: StreamKind) -> Result<Option<Frame<Kind>>> where
    Kind: NonAnyFrameKind, 

pub fn color_frame(&self) -> Result<Option<VideoFrame>>

pub fn depth_frame(&self) -> Result<Option<DepthFrame>>

pub fn pose_frame(&self) -> Result<Option<PoseFrame>>

impl Frame<Pose>

pub fn pose(&self) -> Result<PoseData>

Gets the pose data.

impl Frame<Points>

pub fn vertices<'a>(&'a self) -> Result<&'a [rs2_vertex]>

Gets vertices of point cloud.

pub fn texture_coordinates<'a>(&'a self) -> Result<&'a [TextureCoordinate]>

Gets texture coordinates of each point of point cloud.

pub fn points_count(&self) -> Result<usize>

Gets number of points in frame.

impl Frame<Motion>

pub fn motion(&self) -> Result<[f32; 3]>

Gets motion data.

Trait Implementations

impl<Kind> Clone for Frame<Kind> where
    Kind: FrameKind, 

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Kind: Debug> Debug for Frame<Kind> where
    Kind: FrameKind, 

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

Formats the value using the given formatter.

impl<Kind> Drop for Frame<Kind> where
    Kind: FrameKind, 

fn drop(&mut self)

Executes the destructor for this type.

impl<Kind> GenericFrameEx for Frame<Kind> where
    Kind: FrameKind, 

fn ptr(&self) -> NonNull<rs2_frame>

fn into_raw(self) -> *mut rs2_frame

Destruct and return the raw pointer. It is intended for internal use only.

unsafe fn from_raw(ptr: *mut rs2_frame) -> Self

Construct from a raw pointer. It is intended for internal use only.

fn metadata(&self, kind: FrameMetaDataValue) -> Result<u64>

Obtains the metadata of frame.

fn number(&self) -> Result<u64>

Gets frame number.

fn data_size(&self) -> Result<usize>

Gets raw data size in bytes.

fn timestamp(&self) -> Result<f64>

Gets the timestamp.

fn timestamp_domain(&self) -> Result<TimestampDomain>

Gets the domain of timestamp.

fn data(&self) -> Result<&[u8]>

Gets raw data bytes in frame.

fn sensor(&self) -> Result<AnySensor>

Gets the relating sensor instance.

fn stream_profile(&self) -> Result<AnyStreamProfile>

Gets the relating stream profile.

fn try_clone(&self) -> Result<Self>

impl<Kind> Send for Frame<Kind> where
    Kind: FrameKind, 

impl<Kind> Sync for Frame<Kind> where
    Kind: FrameKind,