Enum Rs2Option

#[repr(i32)]
pub enum Rs2Option {
    BacklightCompensation = 0,
    Brightness = 1,
    Contrast = 2,
    Exposure = 3,
    Gain = 4,
    Gamma = 5,
    Hue = 6,
    Saturation = 7,
    Sharpness = 8,
    WhiteBalance = 9,
    EnableAutoExposure = 10,
    EnableAutoWhiteBalance = 11,
    VisualPreset = 12,
    LaserPower = 13,
    Accuracy = 14,
    MotionRange = 15,
    FilterOption = 16,
    ConfidenceThreshold = 17,
    EmitterEnabled = 18,
    FramesQueueSize = 19,
    TotalFrameDrops = 20,
    AutoExposureMode = 21,
    PowerLineFrequency = 22,
    AsicTemperature = 23,
    ErrorPollingEnabled = 24,
    ProjectorTemperature = 25,
    OutputTriggerEnabled = 26,
    MotionModuleTemperature = 27,
    DepthUnits = 28,
    EnableMotionCorrection = 29,
    AutoExposurePriority = 30,
    ColorScheme = 31,
    HistogramEqualizationEnabled = 32,
    MinDistance = 33,
    MaxDistance = 34,
    TextureSource = 35,
    FilterMagnitude = 36,
    FilterSmoothAlpha = 37,
    FilterSmoothDelta = 38,
    HolesFill = 39,
    StereoBaseline = 40,
    AutoExposureConvergeStep = 41,
    InterCamSyncMode = 42,
    StreamFilter = 43,
    StreamFormatFilter = 44,
    StreamIndexFilter = 45,
    EmitterOnOff = 46,
    LldTemperature = 49,
    McTemperature = 50,
    MaTemperature = 51,
    HardwarePreset = 52,
    GlobalTimeEnabled = 53,
    ApdTemperature = 54,
    EnableMapping = 55,
    EnableRelocalization = 56,
    EnablePoseJumping = 57,
    EnableDynamicCalibration = 58,
    DepthOffset = 59,
    LedPower = 60,
    EnableMapPreservation = 62,
    FreefallDetectionEnabled = 63,
    AvalanchePhotoDiode = 64,
    PostProcessingSharpening = 65,
    PreProcessingSharpening = 66,
    NoiseFiltering = 67,
    InvalidationBypass = 68,
    DigitalGain = 69,
    SensoeMode = 70,
    EmitterAlwaysOn = 71,
    ThermalCompensation = 72,
    HostPerformance = 75,
    HdrEnabled = 76,
    SequenceName = 77,
    SequenceSize = 78,
    SequenceId = 79,
    HumidityTemperature = 80,
    EnableMaxUsableRange = 81,
    AlternateIr = 82,
    NoiseEstimation = 83,
    EnableIrReflectivity = 84,
    AutoExposureLimit = 85,
    AutoGainLimit = 86,
    AutoReceiverSensitivity = 87,
    TransmitterFrequency = 88,
    VerticalBinning = 89,
    ReceiverSensitivity = 90,
    AutoExposureLimitToggle = 91,
    AutoGainLimitToggle = 92,
    EmitterFrequency = 93,
    DepthAutoExposureMode = 94,
}

The enumeration of options available in the RealSense SDK.

The majority of the options presented have a specific range of valid values. Run sensor.get_option_range(Rs2Option::_) to retrieve possible values of an Option type for your sensor. Setting a bad value will lead to a no-op at best, and a malfunction at worst.

Deprecated Options

AmbientLight

• Equivalent to RS2_OPTION_AMBIENT_LIGHT
• Replacement: Rs2Option::DigitalGain.
• Old Description: “Change the depth ambient light see rs2_ambient_light for values”.

ZeroOrderEnabled

• Equivalent to RS2_OPTION_ZERO_ORDER_ENABLED
• Replacement: N/A.
• Old Description: “Toggle Zero-Order mode.”

ZeroOrderPointX

• Equivalent to RS2_OPTION_ZERO_ORDER_POINT_X
• Replacement: N/A.
• Old Description: “Get the Zero order point x.”

ZeroOrderPointY

• Equivalent to RS2_OPTION_ZERO_ORDER_POINT_Y
• Replacement: N/A.
• Old Description: “Get the Zero order point y.”

Trigger camera accuracy health

• Deprecated as of 2.46 (not officially released, so technically 2.47)
• Old Description: “Enable Depth & color frame sync with periodic calibration for proper alignment”

Reset camera accuracy health

• Deprecated as of 2.46 (not officially released, so technically 2.47)
• Old Description: “Reset Camera Accuracy metric (if affected by TriggerCameraAccuracyHealth option).”

Variants

BacklightCompensation = 0

Enable/disable color backlight compensation.

Brightness = 1

Set color image brightness.

Contrast = 2

Set color image contrast.

Exposure = 3

Set exposure time of color camera. Setting any value will disable auto exposure.

Gain = 4

Set color image gain.

Gamma = 5

Set color image gamma setting.

Hue = 6

Set color image hue.

Saturation = 7

Set color image saturation.

Sharpness = 8

Set color image sharpness.

WhiteBalance = 9

Set white balance of color image. Setting any value will disable auto white balance.

EnableAutoExposure = 10

Enable/disable color image auto-exposure.

EnableAutoWhiteBalance = 11

Enable/disable color image auto-white-balance

VisualPreset = 12

Set the visual preset on the sensor. sensor.get_option_range() provides access to several recommend sets of option presets for a depth camera. The preset selection varies between devices and sensors.

LaserPower = 13

Set the power of the laser emitter, with 0 meaning projector off.

Accuracy = 14

Set the number of patterns projected per frame. The higher the accuracy value, the more patterns projected. Increasing the number of patterns helps to achieve better accuracy. Note that this control affects Depth FPS.

MotionRange = 15

Set the motion vs. range trade-off. Lower values allow for better motion sensitivity. Higher values allow for better depth range.

FilterOption = 16

Set the filter to apply to each depth frame. Each one of the filter is optimized per the application requirements.

ConfidenceThreshold = 17

Set the confidence level threshold used by the Depth algorithm pipe. This determines whether a pixel will get a valid range or will be marked as invalid.

EmitterEnabled = 18

Enable/disable emitters. Emitter selection:

• 0: disable all emitters
• 1: enable laser
• 2: enable auto laser
• 3: enable LED

FramesQueueSize = 19

Set the number of frames the user is allowed to keep per stream. Trying to hold on to more frames will cause frame drops.

TotalFrameDrops = 20

Get the total number of detected frame drops from all streams.

AutoExposureMode = 21

Set the auto-exposure mode:

• Static
• Anti-Flicker
• Hybrid

PowerLineFrequency = 22

Set the power line frequency control for anti-flickering:

• Off
• 50Hz
• 60Hz
• Auto

AsicTemperature = 23

Get the current Temperature of the ASIC.

ErrorPollingEnabled = 24

Enable/disable error handling.

ProjectorTemperature = 25

Get the Current Temperature of the projector.

OutputTriggerEnabled = 26

Enable/disable trigger to be outputed from the camera to any external device on every depth frame.

MotionModuleTemperature = 27

Get the current Motion-Module Temperature.

DepthUnits = 28

Set the number of meters represented by a single depth unit.

EnableMotionCorrection = 29

Enable/Disable automatic correction of the motion data.

AutoExposurePriority = 30

Allows sensor to dynamically ajust the frame rate depending on lighting conditions.

ColorScheme = 31

Set the color scheme for data visualization.

HistogramEqualizationEnabled = 32

Enable/disable histogram equalization post-processing on the depth data.

MinDistance = 33

Set the Minimal distance to the target.

MaxDistance = 34

Set the Maximum distance to the target.

TextureSource = 35

Get the texture mapping stream unique ID.

FilterMagnitude = 36

Set the 2D-filter effect. The specific interpretation is given within the context of the filter.

FilterSmoothAlpha = 37

Set the 2D-filter parameter that controls the weight/radius for smoothing.

FilterSmoothDelta = 38

Set the 2D-filter range/validity threshold.

HolesFill = 39

Enhance depth data post-processing with holes filling where appropriate.

StereoBaseline = 40

Get the distance in mm between the first and the second imagers in stereo-based depth cameras.

AutoExposureConvergeStep = 41

Allows dynamically ajust the converge step value of the target exposure in the Auto-Exposure algorithm.

InterCamSyncMode = 42

Impose Inter-camera HW synchronization mode. Applicable for D400/L500/Rolling Shutter SKUs.

StreamFilter = 43

Select a stream to process.

StreamFormatFilter = 44

Select a stream format to process.

StreamIndexFilter = 45

Select a stream index to process.

EmitterOnOff = 46

When supported, this option make the camera to switch the emitter state every frame. 0 for disabled, 1 for enabled.

LldTemperature = 49

Get the LDD temperature.

McTemperature = 50

Get the MC temperature.

MaTemperature = 51

Get the MA temperature.

HardwarePreset = 52

Hardware stream configuration.

GlobalTimeEnabled = 53

Enable/disable global time.

ApdTemperature = 54

Get the APD temperature.

EnableMapping = 55

Enable/disable an internal map.

EnableRelocalization = 56

Enable/disable appearance-based relocalization.

EnablePoseJumping = 57

Enable/disable position jumping.

EnableDynamicCalibration = 58

Enable/disable dynamic calibration.

DepthOffset = 59

Get the offset from sensor to depth origin in millimeters.

LedPower = 60

Set the power of the LED (light emitting diode), with 0 meaning off

EnableMapPreservation = 62

Preserve the previous map when starting.

FreefallDetectionEnabled = 63

Enable/disable sensor shutdown when a free-fall is detected (on by default).

AvalanchePhotoDiode = 64

Changes the exposure time of Avalanche Photo Diode in the receiver.

PostProcessingSharpening = 65

Changes the amount of sharpening in the post-processed image.

PreProcessingSharpening = 66

Changes the amount of sharpening in the pre-processed image.

NoiseFiltering = 67

Control edges and background noise.

InvalidationBypass = 68

Enable/disable pixel invalidation.

DigitalGain = 69

Change the depth digital gain see rs2_digital_gain for values.

SensoeMode = 70

The resolution mode: see rs2_sensor_mode for values.

EmitterAlwaysOn = 71

Enable/disable Laser On constantly (GS SKU Only).

ThermalCompensation = 72

Depth Thermal Compensation for selected D400 SKUs.

HostPerformance = 75

Set host performance mode to optimize device settings so host can keep up with workload. Take USB transaction granularity as an example. Setting option to low performance host leads to larger USB transaction sizes and a reduced number of transactions. This improves performance and stability if the host machine is relatively weak compared to the workload.

HdrEnabled = 76

Enable/disable HDR.

SequenceName = 77

Get HDR Sequence name.

SequenceSize = 78

Get HDR Sequence size.

SequenceId = 79

Get HDR Sequence ID - 0 is not HDR; sequence ID for HDR configuration starts from 1.

HumidityTemperature = 80

Get Humidity temperature [in Celsius].

EnableMaxUsableRange = 81

Enable/disable the maximum usable depth sensor range given the amount of ambient light in the scene.

AlternateIr = 82

Enable/disable the alternate IR, When enabling alternate IR, the IR image is holding the amplitude of the depth correlation.

NoiseEstimation = 83

Get an estimation of the noise on the IR image.

EnableIrReflectivity = 84

Enable/disable data collection for calculating IR pixel reflectivity.

AutoExposureLimit = 85

Auto exposure limit in microseconds.

Default is 0 which means full exposure range. If the requested exposure limit is greater than frame time, it will be set to frame time at runtime. Setting will not take effect until next streaming session.

AutoGainLimit = 86

Auto gain limits ranging from 16 to 248.

Default is 0 which means full gain. If the requested gain limit is less than 16, it will be set to 16. If the requested gain limit is greater than 248, it will be set to 248. Setting will not take effect until next streaming session.

AutoReceiverSensitivity = 87

Enable receiver sensitivity according to ambient light, bounded by the Receiver GAin control.

TransmitterFrequency = 88

Changes the transmistter frequency frequencies increasing effective range over sharpness.

VerticalBinning = 89

Enables vertical binning which increases the maximal sensed distance.

ReceiverSensitivity = 90

Control receiver sensitivity to incoming light, both projected and ambient (same as APD on L515).

AutoExposureLimitToggle = 91

Enable / disable color image auto-exposure

AutoGainLimitToggle = 92

Enable / disable color image auto-gain

EmitterFrequency = 93

Select emitter (laser projector) frequency, see rs2_emitter_frequency for values

DepthAutoExposureMode = 94

Select depth sensor auto exposure mode see rs2_depth_auto_exposure_mode for values

Implementations

impl Rs2Option

pub fn to_cstr(self) -> &'static CStr

Get the option as a CStr.

pub fn to_str(self) -> &'static str

Get the option as a str.

Trait Implementations

impl Clone for Rs2Option

fn clone(&self) -> Rs2Option

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rs2Option

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

Formats the value using the given formatter.

impl FromPrimitive for Rs2Option

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 Rs2Option

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Rs2Option

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToPrimitive for Rs2Option

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 ToString for Rs2Option

fn to_string(&self) -> String

Converts the given value to a String.

impl Copy for Rs2Option

impl Eq for Rs2Option

impl StructuralPartialEq for Rs2Option