Depth Module

In this page will introduce the API and data you can use from Depth module.

Depth module API

int ViveSR::SRWork::Depth::GetDepthData(DepthData *data)

Gets the DepthData from SRWorks engine.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

int ViveSR::SRWork::Depth::SetDepthParameterBool(int parameter_name, bool value)

Sets the depth parameter boolean of module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::Depth::SetDepthParameterInt(int parameter_name, int value)

Sets the depth parameter integer of module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • parameter_name: ViveSR::SRWork::Depth::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::Depth::SetDepthParameterFloat(int parameter_name, float param_value)

Sets the depth parameter float of module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::Depth::GetDepthParameterBool(int parameter_name, bool *value)

Get the depth parameter boolean from module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [out] param_value: The parameter output value pointer.

int ViveSR::SRWork::Depth::GetDepthParameterInt(int parameter_name, int *value)

Get the depth parameter integer from module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [out] param_value: The parameter output value pointer.

int ViveSR::SRWork::Depth::GetDepthParameterFloat(int parameter_name, float *param_value)

Get the depth parameter float from module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [out] param_value: The parameter output value pointer.

int ViveSR::SRWork::Depth::GetDepthParameterDouble(int parameter_name, double *param_value)

Get the depth parameter double from module.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] parameter_name: ViveSR::SRWork::Depth::Param

  • [out] param_value: The parameter output value pointer.

int ViveSR::SRWork::Depth::SetDepthMaxFps(int max_fps)

Set the depth maximum update interval of SRWorks engine.

Return

Indicates the resulting ViveSR::Error status of this method.

Parameters

  • [in] max_fps: The maximum fps want to set.

Depth module data type

struct DepthData

A struct containing all data listed below.

Public Members

char *left_frame
float *depth_map
unsigned int frame_seq
unsigned int time_stp
float *pose
int lux_left
int color_temperature_left
int exposure_time_left
int analog_gain_left
int digital_gain_left
char *camera_params

Depth module enums type

enum ViveSR::Depth::Param

An enum type for depth parameters.

Values:

OUTPUT_WIDTH
OUTPUT_HEIGHT
OUTPUT_CHAANEL_0
OUTPUT_CHAANEL_1
TYPE
FOCULENS
BASELINE
COLLIDER_QUALITY
MESH_NEAR_DISTANCE
MESH_FAR_DISTANCE
DENOISE_MEDIAN_FILTER
CONFIDENCE_THRESHOLD
DENOISE_GUIDED_FILTER
DEPTH_USING_CASE
enum ViveSR::Depth::DepthCase

An enum type for depth type.

Values:

DEFAULT
CLOSE_RANGE
enum ViveSR::Depth::InputMask

An enum type for depth input data structure.

Values:

_DISTORTED_FRAME_LEFT = 0
_DISTORTED_FRAME_RIGHT = 1
_UNDISTORTED_FRAME_LEFT = 2
_UNDISTORTED_FRAME_RIGHT = 3
_FRAME_SEQ = 4
_TIME_STP = 5
_POSE_LEFT = 6
_POSE_RIGHT = 7
_LUX_LEFT = 8
_LUX_RIGHT = 9
_COLOR_TEMPERATURE_LEFT = 10
_COLOR_TEMPERATURE_RIGHT = 11
_EXPOSURE_TIME_LEFT = 12
_EXPOSURE_TIME_RIGHT = 13
_ANALOG_GAIN_LEFT = 14
_ANALOG_GAIN_RIGHT = 15
_DIGITAL_GAIN_LEFT = 16
_DIGITAL_GAIN_RIGHT = 17
_CAMERA_PARAMS = 18
_D3D11_TEXTURE2D_SHARED_HANDLE_LEFT = 19
_D3D11_TEXTURE2D_SHARED_HANDLE_RIGHT = 20
_D3D11_TEXTURE2D_BUFFER_INDEX = 21
_GAMMA = 22
INPUT_MASK_MAX
enum ViveSR::Depth::OutputMask

An enum type for depth output data structure.

Values:

LEFT_FRAME = 0
DEPTH_MAP = 1
FRAME_SEQ = 2
TIME_STP = 3
POSE = 4
LUX_LEFT = 5
COLOR_TEMPERATURE_LEFT = 6
EXPOSURE_TIME_LEFT = 7
ANALOG_GAIN_LEFT = 8
DIGITAL_GAIN_LEFT = 9
CAMERA_PARAMS = 10
OUTPUT_MASK_MAX
enum ViveSR::Depth::Cmd

An enum type for control signal to change depth module’s behavior.

Values:

EXTRACT_DEPTH_MESH = 100
ENABLE_REFINEMENT = 103
ENABLE_EDGE_ENHANCE
CHANGE_DEPTH_CASE
CHANGE_DEPTH_CASE_2_RECONSTRUCT_USED