Depth Mesh Module

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

Depth Mesh module API

int ViveSR::SRWork::DepthMesh::GetDepthMeshData(DepthMeshData *data)

Gets the DepthMeshData from SRWorks engine.

Return

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

Parameters

int ViveSR::SRWork::DepthMesh::SetDepthMeshIsEnable(bool value)

Enable or disable depth mesh of module.

Return

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

Parameters
  • [in] value: Is the boolean to set enable or disable depth mesh.

int ViveSR::SRWork::DepthMesh::SetDepthMeshParameterBool(int parameter_name, bool param_value)

Sets the depth parameter boolean of module.

Return

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

Parameters
  • [in] parameter_name: ViveSR::SRWork::DepthMesh::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::DepthMesh::SetDepthMeshParameterInt(int parameter_name, int param_value)

Sets the depth parameter integer of module.

Return

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

Parameters
  • [in] parameter_name: ViveSR::SRWork::DepthMesh::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::DepthMesh::SetDepthMeshParameterDouble(int parameter_name, double param_value)

Sets the depth parameter double of module.

Return

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

Parameters
  • [in] parameter_name: ViveSR::SRWork::DepthMesh::Param

  • [in] param_value: The parameter input value.

int ViveSR::SRWork::DepthMesh::GetDepthMeshParameterInt(int parameter_name, int *param_value)

Get the depth parameter integer from module.

Return

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

Parameters
  • [in] parameter_name: ViveSR::SRWork::DepthMesh::Param

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

int ViveSR::SRWork::DepthMesh::SetDepthMeshMaxFps(int max_fps)

Set the depth mesh 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 Mesh module data type

struct DepthMeshData

A struct containing all data listed below.

Public Members

unsigned int time_stp
float *pose
unsigned int num_vertices
unsigned int bytepervert
float *vertices
unsigned int num_indices
int *indices
int lux_left
int color_temperature_left
int exposure_time_left
int analog_gain_left
int digital_gain_left
char *camera_params

Depth Mesh module enums type

enum ViveSR::DepthMesh::Param

An enum type for DepthMesh 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::DepthMesh::DepthCase

An enum type for depth mesh type.

Values:

DEFAULT
CLOSE_RANGE
enum ViveSR::DepthMesh::InputMask

An enum type for depth mesh input 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
INPUT_MASK_MAX
enum ViveSR::DepthMesh::OutputMask

An enum type for depth mesh output data structure.

Values:

TIME_STP = 0
POSE = 1
NUM_VERTICES = 2
BYTEPERVERT = 3
VERTICES = 4
NUM_INDICES = 5
INDICES = 6
LUX_LEFT = 7
COLOR_TEMPERATURE_LEFT = 8
EXPOSURE_TIME_LEFT = 9
ANALOG_GAIN_LEFT = 10
DIGITAL_GAIN_LEFT = 11
CAMERA_PARAMS = 12
OUTPUT_MASK_MAX
enum ViveSR::DepthMesh::Cmd

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

Values:

EXTRACT_DEPTH_MESH = 100
ENABLE_SELECT_MESH_DISTANCE_RANGE
ENABLE_DEPTH_MESH_HOLE_FILLING