[][src]Crate k4a_sys_temp

Structs

_k4a_calibration_camera_t

Camera calibration contains intrinsic and extrinsic calibration information for a camera.

_k4a_calibration_extrinsics_t

Extrinsic calibration data.

_k4a_calibration_intrinsics_t

Camera sensor intrinsic calibration data.

_k4a_calibration_t

Calibration type representing device calibration.

_k4a_capture_t
_k4a_device_configuration_t

Configuration parameters for an Azure Kinect device.

_k4a_device_t
_k4a_hardware_version_t

Structure to define hardware version.

_k4a_image_t
_k4a_imu_sample_t

IMU sample.

_k4a_transformation_t
_k4a_version_t

Version information.

k4a_calibration_intrinsic_parameters_t__param

individual parameter or array representation of intrinsic model.

k4a_float2_t__xy

XY or array representation of vector

k4a_float3_t__xyz

XYZ or array representation of vector.

Constants

K4A_DEVICE_DEFAULT
K4A_VERSION_BUILD_METADATA
K4A_VERSION_MAJOR
K4A_VERSION_MINOR
K4A_VERSION_PATCH
K4A_VERSION_PRERELEASE
K4A_VERSION_STR
K4A_WAIT_INFINITE
k4a_buffer_result_t_K4A_BUFFER_RESULT_FAILED

< The result was a failure

k4a_buffer_result_t_K4A_BUFFER_RESULT_SUCCEEDED

< The result was successful

k4a_buffer_result_t_K4A_BUFFER_RESULT_TOO_SMALL

< The input buffer was too small

k4a_calibration_model_type_t_K4A_CALIBRATION_LENS_DISTORTION_MODEL_BROWN_CONRADY

< Calibration model is Brown Conrady (compatible with OpenCV)

k4a_calibration_model_type_t_K4A_CALIBRATION_LENS_DISTORTION_MODEL_POLYNOMIAL_3K

< Deprecated (not supported). Calibration model is Polynomial 3K.

k4a_calibration_model_type_t_K4A_CALIBRATION_LENS_DISTORTION_MODEL_RATIONAL_6KT

< Deprecated (only supported early internal devices). Calibration model is Rational 6KT.

k4a_calibration_model_type_t_K4A_CALIBRATION_LENS_DISTORTION_MODEL_THETA

< Deprecated (not supported). Calibration model is Theta (arctan).

k4a_calibration_model_type_t_K4A_CALIBRATION_LENS_DISTORTION_MODEL_UNKNOWN

< Calibration model is unknown

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_ACCEL

< Accelerometer sensor

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_COLOR

< Color sensor

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_DEPTH

< Depth sensor

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_GYRO

< Gyroscope sensor

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_NUM

< Number of types excluding unknown type

k4a_calibration_type_t_K4A_CALIBRATION_TYPE_UNKNOWN

< Calibration type is unknown

k4a_color_control_command_t_K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY

Exposure or Framerate priority setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION

Backlight compensation setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_BRIGHTNESS

Brightness setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_CONTRAST

Contrast setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE

Exposure time setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_GAIN

Gain setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_POWERLINE_FREQUENCY

Powerline frequency setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_SATURATION

Saturation setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_SHARPNESS

Sharpness setting.

k4a_color_control_command_t_K4A_COLOR_CONTROL_WHITEBALANCE

White balance setting.

k4a_color_control_mode_t_K4A_COLOR_CONTROL_MODE_AUTO

< set the associated k4a_color_control_command_t to auto

k4a_color_control_mode_t_K4A_COLOR_CONTROL_MODE_MANUAL

< set the associated k4a_color_control_command_t to manual

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_720P

< 1280 * 720 16:9

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_1080P

< 1920 * 1080 16:9

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_1440P

< 2560 * 1440 16:9

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_1536P

< 2048 * 1536 4:3

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_2160P

< 3840 * 2160 16:9

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_3072P

< 4096 * 3072 4:3

k4a_color_resolution_t_K4A_COLOR_RESOLUTION_OFF

< Color camera will be turned off with this setting

k4a_depth_mode_t_K4A_DEPTH_MODE_NFOV_2X2BINNED

< Depth captured at 320x288. Passive IR is also captured at 320x288.

k4a_depth_mode_t_K4A_DEPTH_MODE_NFOV_UNBINNED

< Depth captured at 640x576. Passive IR is also captured at 640x576.

k4a_depth_mode_t_K4A_DEPTH_MODE_OFF

< Depth sensor will be turned off with this setting.

k4a_depth_mode_t_K4A_DEPTH_MODE_PASSIVE_IR

< Passive IR only, captured at 1024x1024.

k4a_depth_mode_t_K4A_DEPTH_MODE_WFOV_2X2BINNED

< Depth captured at 512x512. Passive IR is also captured at 512x512.

k4a_depth_mode_t_K4A_DEPTH_MODE_WFOV_UNBINNED

< Depth captured at 1024x1024. Passive IR is also captured at 1024x1024.

k4a_firmware_build_t_K4A_FIRMWARE_BUILD_DEBUG

< Pre-production firmware.

k4a_firmware_build_t_K4A_FIRMWARE_BUILD_RELEASE

< Production firmware.

k4a_firmware_signature_t_K4A_FIRMWARE_SIGNATURE_MSFT

< Microsoft signed firmware.

k4a_firmware_signature_t_K4A_FIRMWARE_SIGNATURE_TEST

< Test signed firmware.

k4a_firmware_signature_t_K4A_FIRMWARE_SIGNATURE_UNSIGNED

< Unsigned firmware.

k4a_fps_t_K4A_FRAMES_PER_SECOND_5

< 5 FPS

k4a_fps_t_K4A_FRAMES_PER_SECOND_15

< 15 FPS

k4a_fps_t_K4A_FRAMES_PER_SECOND_30

< 30 FPS

k4a_image_format_t_K4A_IMAGE_FORMAT_COLOR_BGRA32

Color image type BGRA32.

k4a_image_format_t_K4A_IMAGE_FORMAT_COLOR_MJPG

Color image type MJPG.

k4a_image_format_t_K4A_IMAGE_FORMAT_COLOR_NV12

Color image type NV12.

k4a_image_format_t_K4A_IMAGE_FORMAT_COLOR_YUY2

Color image type YUY2.

k4a_image_format_t_K4A_IMAGE_FORMAT_CUSTOM

Custom image format.

k4a_image_format_t_K4A_IMAGE_FORMAT_CUSTOM8

Single channel image type CUSTOM8.

k4a_image_format_t_K4A_IMAGE_FORMAT_CUSTOM16

Single channel image type CUSTOM16.

k4a_image_format_t_K4A_IMAGE_FORMAT_DEPTH16

Depth image type DEPTH16.

k4a_image_format_t_K4A_IMAGE_FORMAT_IR16

Image type IR16.

k4a_log_level_t_K4A_LOG_LEVEL_CRITICAL

< Most severe level of debug messaging.

k4a_log_level_t_K4A_LOG_LEVEL_ERROR

< 2nd most severe level of debug messaging.

k4a_log_level_t_K4A_LOG_LEVEL_INFO

< 2nd least severe level of debug messaging.

k4a_log_level_t_K4A_LOG_LEVEL_OFF

< No logging is performed

k4a_log_level_t_K4A_LOG_LEVEL_TRACE

< Least severe level of debug messaging.

k4a_log_level_t_K4A_LOG_LEVEL_WARNING

< 3nd most severe level of debug messaging.

k4a_result_t_K4A_RESULT_FAILED

< The result was a failure

k4a_result_t_K4A_RESULT_SUCCEEDED

< The result was successful

k4a_transformation_interpolation_type_t_K4A_TRANSFORMATION_INTERPOLATION_TYPE_LINEAR

< Linear interpolation

k4a_transformation_interpolation_type_t_K4A_TRANSFORMATION_INTERPOLATION_TYPE_NEAREST

< Nearest neighbor interpolation

k4a_wait_result_t_K4A_WAIT_RESULT_FAILED

< The result was a failure

k4a_wait_result_t_K4A_WAIT_RESULT_SUCCEEDED

< The result was successful

k4a_wait_result_t_K4A_WAIT_RESULT_TIMEOUT

< The operation timed out

k4a_wired_sync_mode_t_K4A_WIRED_SYNC_MODE_MASTER

< The 'Sync Out' jack is enabled and synchronization data it driven out the connected wire. While in master mode the color camera must be enabled as part of the multi device sync signalling logic. Even if the color image is not needed, the color camera must be running.

k4a_wired_sync_mode_t_K4A_WIRED_SYNC_MODE_STANDALONE

< Neither 'Sync In' or 'Sync Out' connections are used.

k4a_wired_sync_mode_t_K4A_WIRED_SYNC_MODE_SUBORDINATE

< The 'Sync In' jack is used for synchronization and 'Sync Out' is driven for the next device in the chain. 'Sync Out' is a mirror of 'Sync In' for this mode.

Statics

K4A_DEVICE_CONFIG_INIT_DISABLE_ALL

Functions

k4a_calibration_2d_to_2d

Transform a 2D pixel coordinate with an associated depth value of the source camera into a 2D pixel coordinate of the target camera.

k4a_calibration_2d_to_3d

Transform a 2D pixel coordinate with an associated depth value of the source camera into a 3D point of the target coordinate system.

k4a_calibration_3d_to_2d

Transform a 3D point of a source coordinate system into a 2D pixel coordinate of the target camera.

k4a_calibration_3d_to_3d

Transform a 3D point of a source coordinate system into a 3D point of the target coordinate system

k4a_calibration_color_2d_to_depth_2d

Transform a 2D pixel coordinate from color camera into a 2D pixel coordinate of the depth camera.

k4a_calibration_get_from_raw

Get the camera calibration for a device from a raw calibration blob.

k4a_capture_create

Create an empty capture object.

k4a_capture_get_color_image

Get the color image associated with the given capture.

k4a_capture_get_depth_image

Get the depth image associated with the given capture.

k4a_capture_get_ir_image

Get the IR image associated with the given capture.

k4a_capture_get_temperature_c

Get the temperature associated with the capture.

k4a_capture_reference

Add a reference to a capture.

k4a_capture_release

Release a capture.

k4a_capture_set_color_image

Set or add a color image to the associated capture.

k4a_capture_set_depth_image

Set or add a depth image to the associated capture.

k4a_capture_set_ir_image

Set or add an IR image to the associated capture.

k4a_capture_set_temperature_c

Set the temperature associated with the capture.

k4a_device_close

Closes an Azure Kinect device.

k4a_device_get_calibration

Get the camera calibration for the entire Azure Kinect device.

k4a_device_get_capture

Reads a sensor capture.

k4a_device_get_color_control

Get the Azure Kinect color sensor control value.

k4a_device_get_color_control_capabilities

Get the Azure Kinect color sensor control capabilities.

k4a_device_get_imu_sample

Reads an IMU sample.

k4a_device_get_installed_count

Gets the number of connected devices

k4a_device_get_raw_calibration

Get the raw calibration blob for the entire Azure Kinect device.

k4a_device_get_serialnum

Get the Azure Kinect device serial number.

k4a_device_get_sync_jack

Get the device jack status for the synchronization in and synchronization out connectors.

k4a_device_get_version

Get the version numbers of the device's subsystems.

k4a_device_open

Open an Azure Kinect device.

k4a_device_set_color_control

Set the Azure Kinect color sensor control value.

k4a_device_start_cameras

Starts color and depth camera capture.

k4a_device_start_imu

Starts the IMU sample stream.

k4a_device_stop_cameras

Stops the color and depth camera capture.

k4a_device_stop_imu

Stops the IMU capture.

k4a_image_create

Create an image.

k4a_image_create_from_buffer

Create an image from a pre-allocated buffer.

k4a_image_get_buffer

Get the image buffer.

k4a_image_get_device_timestamp_usec

Get the image's device timestamp in microseconds.

k4a_image_get_exposure_usec

Get the image exposure in microseconds.

k4a_image_get_format

Get the format of the image.

k4a_image_get_height_pixels

Get the image height in pixels.

k4a_image_get_iso_speed

Get the image ISO speed.

k4a_image_get_size

Get the image buffer size.

k4a_image_get_stride_bytes

Get the image stride in bytes.

k4a_image_get_system_timestamp_nsec

Get the image's system timestamp in nanoseconds.

k4a_image_get_timestamp_usec

Get the image's device timestamp in microseconds.

k4a_image_get_white_balance

Get the image white balance.

k4a_image_get_width_pixels

Get the image width in pixels.

k4a_image_reference

Add a reference to the k4a_image_t.

k4a_image_release

Remove a reference from the k4a_image_t.

k4a_image_set_device_timestamp_usec

Set the device time stamp, in microseconds, of the image.

k4a_image_set_exposure_time_usec

Set the exposure time, in microseconds, of the image.

k4a_image_set_exposure_usec

Set the exposure time, in microseconds, of the image.

k4a_image_set_iso_speed

Set the ISO speed of the image.

k4a_image_set_system_timestamp_nsec

Set the system time stamp, in nanoseconds, of the image.

k4a_image_set_timestamp_usec

Set the device time stamp, in microseconds, of the image.

k4a_image_set_white_balance

Set the white balance of the image.

k4a_set_allocator

Sets the callback functions for the SDK allocator

k4a_set_debug_message_handler

Sets and clears the callback function to receive debug messages from the Azure Kinect device.

k4a_transformation_color_image_to_depth_camera

Transforms a color image into the geometry of the depth camera.

k4a_transformation_create

Get handle to transformation handle.

k4a_transformation_depth_image_to_color_camera

Transforms the depth map into the geometry of the color camera.

k4a_transformation_depth_image_to_color_camera_custom

Transforms depth map and a custom image into the geometry of the color camera.

k4a_transformation_depth_image_to_point_cloud

Transforms the depth image into 3 planar images representing X, Y and Z-coordinates of corresponding 3D points.

k4a_transformation_destroy

Destroy transformation handle.

Type Definitions

__int32_t
__uint8_t
__uint32_t
__uint64_t
k4a_buffer_result_t

Result code returned by Azure Kinect APIs.

k4a_calibration_camera_t

Camera calibration contains intrinsic and extrinsic calibration information for a camera.

k4a_calibration_extrinsics_t

Extrinsic calibration data.

k4a_calibration_intrinsics_t

Camera sensor intrinsic calibration data.

k4a_calibration_model_type_t

Calibration model type.

k4a_calibration_t

Calibration type representing device calibration.

k4a_calibration_type_t

Calibration types.

k4a_capture_t
k4a_color_control_command_t

Color sensor control commands

k4a_color_control_mode_t

Color sensor control mode

k4a_color_resolution_t

Color sensor resolutions.

k4a_depth_mode_t

Depth sensor capture modes.

k4a_device_configuration_t

Configuration parameters for an Azure Kinect device.

k4a_device_t
k4a_firmware_build_t

Firmware build type.

k4a_firmware_signature_t

Firmware signature type.

k4a_fps_t

Color and depth sensor frame rate.

k4a_hardware_version_t

Structure to define hardware version.

k4a_image_format_t

Image format type.

k4a_image_t
k4a_imu_sample_t

IMU sample.

k4a_log_level_t

Verbosity levels of debug messaging

k4a_logging_message_cb_t

Callback function for debug messages being generated by the Azure Kinect SDK.

k4a_memory_allocate_cb_t

Callback function for a memory allocation.

k4a_memory_destroy_cb_t

Callback function for a memory object being destroyed.

k4a_result_t

Result code returned by Azure Kinect APIs.

k4a_transformation_interpolation_type_t

Transformation interpolation type.

k4a_transformation_t
k4a_version_t

Version information.

k4a_wait_result_t

Result code returned by Azure Kinect APIs.

k4a_wired_sync_mode_t

Synchronization mode when connecting two or more devices together.

Unions

k4a_calibration_intrinsic_parameters_t

Camera intrinsic calibration data.

k4a_float2_t

Two dimensional floating point vector.

k4a_float3_t

Three dimensional floating point vector.