Enum realsense_rust::kind::Rs2FrameMetadata

#[repr(i32)]
pub enum Rs2FrameMetadata {
    FrameCounter,
    FrameTimestamp,
    SensorTimestamp,
    ActualExposure,
    GainLevel,
    AutoExposure,
    WhiteBalance,
    TimeOfArrival,
    Temperature,
    BackendTimestamp,
    ActualFps,
    FrameLaserPower,
    FrameLaserPowerMode,
    ExposurePriority,
    ExposureRoiLeft,
    ExposureRoiRight,
    ExposureRoiTop,
    ExposureRoiBottom,
    Brightness,
    Contrast,
    Saturation,
    Sharpness,
    AutoWhiteBalanceTemperature,
    BacklightCompensation,
    Hue,
    Gamma,
    ManualWhiteBalance,
    PowerLineFrequency,
    LowLightCompensation,
    FrameEmitterMode,
    FrameLedPower,
    RawFrameSize,
    GpioInputData,
    SequenceName,
    SequenceIdentifier,
    SequenceSize,
}

A type describing the different metadata keys used to access frame metadata.

Each key corresponds to a particular type of frame metadata. The librealsense2 C-API refers to these as rs2_frame_metadata_value; however these are clearly keys to metadata values.

Variants

FrameCounter

A sequential index managed per-stream, counting up from the first frame at zero.

FrameTimestamp

Timestamp set by device clock when data is read out and transmission commences.

Units are microseconds (usec)

SensorTimestamp

Timestamp for the middle of the sensor’s exposure during frame capture.

This value is calculated by the device (not host). Units are microseconds (usec)

ActualExposure

The exposure duration used by the sensor when this frame was captured.

When auto-exposure (AE) is turned on, this value is controlled by the device’s firmware. Units are microseconds (usec).

GainLevel

The sensor’s gain level during frame capture.

This value is a relative integer value, and may not correspond to a physical quantity. When auto-exposure (AE) is turned on, this value is controlled by the device’s firmware.

AutoExposure

Indicates if auto-exposure (AE) was turned on during frame capture.

A value of zero corresponds to AE being off, otherwise it is on.

WhiteBalance

The white balance setting as a color temperature during frame capture.

Units are Kelvin degrees.

TimeOfArrival

The timestamp at which the frame arrived on the host machine.

This timestamp, unlike the others, is relative to the system clock on host.

Temperature

Temperature of the device during frame capture.

Units are Celsius degrees.

BackendTimestamp

Timestamp of the uvc driver.

Units are microseconds (usec)

ActualFps

The actual framerate of the stream at the point of frame capture.

This may be different than the framerate returned by the stream profile data (which is the framerate you configured). This may differ as a result of frame drops in the firmware, or measurement noise (e.g. you get 29.99 FPS when you asked for 30 FPS).

FrameLaserPower

Relative measure of laser power during frame capture.

Laser power is a relative measure between values of 0 and 360

FrameLaserPowerMode

The laser power mode used at time of frame capture.

Zero corresponds to laser power being switched off, and one for laser power being turned on.

This variant was deprecated by librealsense2, prefer using Rs2FrameMetadata::FrameEmitterMode instead.

ExposurePriority

Exposure priority

ExposureRoiLeft

Left region of interest for the auto-exposure algorithm.

ExposureRoiRight

Right region of interest for the auto-exposure algorithm.

ExposureRoiTop

Top region of interest for the auto-exposure algorithm.

ExposureRoiBottom

Bottom region of interest for the auto-exposure algorithm.

Brightness

Brightness of the color image at time of frame capture.

Contrast

Contrast of the color image at time of frame capture.

Saturation

Saturation of the color image at time of frame capture.

Sharpness

Sharpness of the color image at time of frame capture.

AutoWhiteBalanceTemperature

Indicator for whether auto-white-balance (AWB) was turned on during frame capture.

Zero corresponds to automatic mode being switched off, otherwise it is on.

BacklightCompensation

Indicator for whether backlight compensation was enabled on a color image.

Zero corresponds to backlight compensation being switched off, otherwise it is on.

Hue

Hue of the color image at time of frame capture.

Gamma

Gamma of the color image at time of frame capture.

ManualWhiteBalance

White balance of the color image at time of frame capture.

PowerLineFrequency

Power line frequency mode for anti-flickering.

Values can be Off, 50Hz, 60Hz, and Auto.

LowLightCompensation

Indicator for whether lowlight compensation was enabled on the color image.

Zero corresponds to lowlight compensation being switched off, otherwise it is on.

FrameEmitterMode

The frame emitter mode used at the time of frame capture.

Possible values are:

• 0 - all emitters disabled.
• 1 - laser enabled.
• 2 - auto laser enabled (opt).
• 3 - LED enabled (opt).

FrameLedPower

Relative power of the LED emitter during frame capture.

This is a relative measure between values of 0 and 360.

RawFrameSize

The number of transmitted payload bytes for the frame, not including metadata

GpioInputData

GPIO input data

SequenceName

Sub-preset identifier

SequenceIdentifier

Sub-preset sequence identifier

SequenceSize

Sub-preset sequence size

Trait Implementations

impl Clone for Rs2FrameMetadata

fn clone(&self) -> Rs2FrameMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rs2FrameMetadata

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

Formats the value using the given formatter.

impl FromPrimitive for Rs2FrameMetadata

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for Rs2FrameMetadata

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Rs2FrameMetadata> for Rs2FrameMetadata

fn eq(&self, other: &Rs2FrameMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl ToPrimitive for Rs2FrameMetadata

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for Rs2FrameMetadata

impl Eq for Rs2FrameMetadata

impl StructuralEq for Rs2FrameMetadata

impl StructuralPartialEq for Rs2FrameMetadata