rs_option.h

Go to the documentation of this file.

/* License: Apache 2.0. See LICENSE file in root directory.
   Copyright(c) 2017 Intel Corporation. All Rights Reserved. */

#ifndef LIBREALSENSE_RS2_OPTION_H
#define LIBREALSENSE_RS2_OPTION_H

#ifdef __cplusplus
extern "C" {
#endif

#include "rs_types.h"

typedef enum rs2_option
{
    RS2_OPTION_BACKLIGHT_COMPENSATION                     , 
    RS2_OPTION_BRIGHTNESS                                 , 
    RS2_OPTION_CONTRAST                                   , 
    RS2_OPTION_EXPOSURE                                   , 
    RS2_OPTION_GAIN                                       , 
    RS2_OPTION_GAMMA                                      , 
    RS2_OPTION_HUE                                        , 
    RS2_OPTION_SATURATION                                 , 
    RS2_OPTION_SHARPNESS                                  , 
    RS2_OPTION_WHITE_BALANCE                              , 
    RS2_OPTION_ENABLE_AUTO_EXPOSURE                       , 
    RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE                  , 
    RS2_OPTION_VISUAL_PRESET                              , 
    RS2_OPTION_LASER_POWER                                , 
    RS2_OPTION_ACCURACY                                   , 
    RS2_OPTION_MOTION_RANGE                               , 
    RS2_OPTION_FILTER_OPTION                              , 
    RS2_OPTION_CONFIDENCE_THRESHOLD                       , 
    RS2_OPTION_EMITTER_ENABLED                            , 
    RS2_OPTION_FRAMES_QUEUE_SIZE                          , 
    RS2_OPTION_TOTAL_FRAME_DROPS                          , 
    RS2_OPTION_AUTO_EXPOSURE_MODE                         , 
    RS2_OPTION_POWER_LINE_FREQUENCY                       , 
    RS2_OPTION_ASIC_TEMPERATURE                           , 
    RS2_OPTION_ERROR_POLLING_ENABLED                      , 
    RS2_OPTION_PROJECTOR_TEMPERATURE                      , 
    RS2_OPTION_OUTPUT_TRIGGER_ENABLED                     , 
    RS2_OPTION_MOTION_MODULE_TEMPERATURE                  , 
    RS2_OPTION_DEPTH_UNITS                                , 
    RS2_OPTION_ENABLE_MOTION_CORRECTION                   , 
    RS2_OPTION_AUTO_EXPOSURE_PRIORITY                     , 
    RS2_OPTION_COLOR_SCHEME                               , 
    RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED             , 
    RS2_OPTION_MIN_DISTANCE                               , 
    RS2_OPTION_MAX_DISTANCE                               , 
    RS2_OPTION_TEXTURE_SOURCE                             , 
    RS2_OPTION_FILTER_MAGNITUDE                           , 
    RS2_OPTION_FILTER_SMOOTH_ALPHA                        , 
    RS2_OPTION_FILTER_SMOOTH_DELTA                        , 
    RS2_OPTION_HOLES_FILL                                 , 
    RS2_OPTION_STEREO_BASELINE                            , 
    RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP                , 
    RS2_OPTION_INTER_CAM_SYNC_MODE                        , 
    RS2_OPTION_COUNT                                        
} rs2_option;
const char* rs2_option_to_string(rs2_option option);

typedef enum rs2_sr300_visual_preset
{
    RS2_SR300_VISUAL_PRESET_SHORT_RANGE                   , 
    RS2_SR300_VISUAL_PRESET_LONG_RANGE                    , 
    RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION       , 
    RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION           , 
    RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING               , 
    RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS                , 
    RS2_SR300_VISUAL_PRESET_FACE_LOGIN                    , 
    RS2_SR300_VISUAL_PRESET_GR_CURSOR                     , 
    RS2_SR300_VISUAL_PRESET_DEFAULT                       , 
    RS2_SR300_VISUAL_PRESET_MID_RANGE                     , 
    RS2_SR300_VISUAL_PRESET_IR_ONLY                       , 
    RS2_SR300_VISUAL_PRESET_COUNT                           
} rs2_sr300_visual_preset;
const char* rs2_sr300_visual_preset_to_string(rs2_sr300_visual_preset preset);

typedef enum rs2_rs400_visual_preset
{
    RS2_RS400_VISUAL_PRESET_CUSTOM,
    RS2_RS400_VISUAL_PRESET_DEFAULT,
    RS2_RS400_VISUAL_PRESET_HAND,
    RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY,
    RS2_RS400_VISUAL_PRESET_HIGH_DENSITY,
    RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY,
    RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN,
    RS2_RS400_VISUAL_PRESET_COUNT
} rs2_rs400_visual_preset;
const char* rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset);

int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);

float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);

void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);

int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);

void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);

const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);

const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);

#ifdef __cplusplus
}
#endif
#endif