#include <inttypes.h>
#include <stddef.h>
#include <string.h>
#include <stdbool.h>

Classes
struct	_k4a_device_configuration_t

struct	_k4a_calibration_extrinsics_t

union	k4a_calibration_intrinsic_parameters_t

struct	k4a_calibration_intrinsic_parameters_t::_param

struct	_k4a_calibration_intrinsics_t

struct	_k4a_calibration_camera_t

struct	_k4a_calibration_t

struct	_k4a_version_t

struct	_k4a_hardware_version_t

union	k4a_float2_t

struct	k4a_float2_t::_xy

union	k4a_float3_t

struct	k4a_float3_t::_xyz

struct	_k4a_imu_sample_t

Macros
#define	K4A_DECLARE_HANDLE(_handle_name_)

#define	K4A_SUCCEEDED(_result_) (_result_ == K4A_RESULT_SUCCEEDED)

#define	K4A_FAILED(_result_) (!K4A_SUCCEEDED(_result_))

#define	K4A_DEVICE_DEFAULT (0)

#define	K4A_WAIT_INFINITE (-1)

Typedefs
typedef void()	k4a_logging_message_cb_t(void context, k4a_log_level_t level, const char file, const int line, const char *message)

typedef void()	k4a_memory_destroy_cb_t(void buffer, void context)

typedef uint8_t *()	k4a_memory_allocate_cb_t(int size, void **context)

typedef struct _k4a_device_configuration_t	k4a_device_configuration_t

typedef struct _k4a_calibration_extrinsics_t	k4a_calibration_extrinsics_t

typedef struct _k4a_calibration_intrinsics_t	k4a_calibration_intrinsics_t

typedef struct _k4a_calibration_camera_t	k4a_calibration_camera_t

typedef struct _k4a_calibration_t	k4a_calibration_t

typedef struct _k4a_version_t	k4a_version_t

typedef struct _k4a_hardware_version_t	k4a_hardware_version_t

typedef struct _k4a_imu_sample_t	k4a_imu_sample_t

Enumerations
enum	k4a_result_t { K4A_RESULT_SUCCEEDED = 0 , K4A_RESULT_FAILED }

enum	k4a_buffer_result_t { K4A_BUFFER_RESULT_SUCCEEDED = 0 , K4A_BUFFER_RESULT_FAILED , K4A_BUFFER_RESULT_TOO_SMALL }

enum	k4a_wait_result_t { K4A_WAIT_RESULT_SUCCEEDED = 0 , K4A_WAIT_RESULT_FAILED , K4A_WAIT_RESULT_TIMEOUT }

enum	k4a_log_level_t { K4A_LOG_LEVEL_CRITICAL = 0 , K4A_LOG_LEVEL_ERROR , K4A_LOG_LEVEL_WARNING , K4A_LOG_LEVEL_INFO , K4A_LOG_LEVEL_TRACE , K4A_LOG_LEVEL_OFF }

enum	k4a_depth_mode_t { K4A_DEPTH_MODE_OFF = 0 , K4A_DEPTH_MODE_NFOV_2X2BINNED , K4A_DEPTH_MODE_NFOV_UNBINNED , K4A_DEPTH_MODE_WFOV_2X2BINNED , K4A_DEPTH_MODE_WFOV_UNBINNED , K4A_DEPTH_MODE_PASSIVE_IR }

enum	k4a_color_resolution_t { K4A_COLOR_RESOLUTION_OFF = 0 , K4A_COLOR_RESOLUTION_720P , K4A_COLOR_RESOLUTION_1080P , K4A_COLOR_RESOLUTION_1440P , K4A_COLOR_RESOLUTION_1536P , K4A_COLOR_RESOLUTION_2160P , K4A_COLOR_RESOLUTION_3072P }

enum	k4a_image_format_t { K4A_IMAGE_FORMAT_COLOR_MJPG = 0 , K4A_IMAGE_FORMAT_COLOR_NV12 , K4A_IMAGE_FORMAT_COLOR_YUY2 , K4A_IMAGE_FORMAT_COLOR_BGRA32 , K4A_IMAGE_FORMAT_DEPTH16 , K4A_IMAGE_FORMAT_IR16 , K4A_IMAGE_FORMAT_CUSTOM8 , K4A_IMAGE_FORMAT_CUSTOM16 , K4A_IMAGE_FORMAT_CUSTOM }

enum	k4a_transformation_interpolation_type_t { K4A_TRANSFORMATION_INTERPOLATION_TYPE_NEAREST = 0 , K4A_TRANSFORMATION_INTERPOLATION_TYPE_LINEAR }

enum	k4a_fps_t { K4A_FRAMES_PER_SECOND_5 = 0 , K4A_FRAMES_PER_SECOND_15 , K4A_FRAMES_PER_SECOND_30 , K4A_FRAMES_PER_SECOND_25 }

enum	k4a_color_control_command_t { K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE = 0 , K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY , K4A_COLOR_CONTROL_BRIGHTNESS , K4A_COLOR_CONTROL_CONTRAST , K4A_COLOR_CONTROL_SATURATION , K4A_COLOR_CONTROL_SHARPNESS , K4A_COLOR_CONTROL_WHITEBALANCE , K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION , K4A_COLOR_CONTROL_GAIN , K4A_COLOR_CONTROL_POWERLINE_FREQUENCY }

enum	k4a_color_control_mode_t { K4A_COLOR_CONTROL_MODE_AUTO = 0 , K4A_COLOR_CONTROL_MODE_MANUAL }

enum	k4a_wired_sync_mode_t { K4A_WIRED_SYNC_MODE_STANDALONE , K4A_WIRED_SYNC_MODE_MASTER , K4A_WIRED_SYNC_MODE_SUBORDINATE }

enum	k4a_calibration_type_t { K4A_CALIBRATION_TYPE_UNKNOWN = -1 , K4A_CALIBRATION_TYPE_DEPTH , K4A_CALIBRATION_TYPE_COLOR , K4A_CALIBRATION_TYPE_GYRO , K4A_CALIBRATION_TYPE_ACCEL , K4A_CALIBRATION_TYPE_NUM }

enum	k4a_calibration_model_type_t { K4A_CALIBRATION_LENS_DISTORTION_MODEL_UNKNOWN = 0 , K4A_CALIBRATION_LENS_DISTORTION_MODEL_THETA , K4A_CALIBRATION_LENS_DISTORTION_MODEL_POLYNOMIAL_3K , K4A_CALIBRATION_LENS_DISTORTION_MODEL_RATIONAL_6KT , K4A_CALIBRATION_LENS_DISTORTION_MODEL_BROWN_CONRADY }

enum	k4a_firmware_build_t { K4A_FIRMWARE_BUILD_RELEASE , K4A_FIRMWARE_BUILD_DEBUG }

enum	k4a_firmware_signature_t { K4A_FIRMWARE_SIGNATURE_MSFT , K4A_FIRMWARE_SIGNATURE_TEST , K4A_FIRMWARE_SIGNATURE_UNSIGNED }

Functions
	K4A_DECLARE_HANDLE (k4a_device_t)

	K4A_DECLARE_HANDLE (k4a_capture_t)

	K4A_DECLARE_HANDLE (k4a_image_t)

	K4A_DECLARE_HANDLE (k4a_transformation_t)

Detailed Description

Definition in file k4atypes.h.

Macro Definition Documentation

◆ K4A_DECLARE_HANDLE

#define K4A_DECLARE_HANDLE ( _handle_name_ )

Value:

    typedef struct _##_handle_name_                                                                                    \
    {                                                                                                                  \
        size_t _rsvd;                                                                     \
    } *_handle_name_;

Declare an opaque handle type.

Parameters

_handle_name_ The type name of the handle

Remarks: This is used to define the public handle types for the Azure Kinect APIs. The macro is not intended to be used outside of the Azure Kinect headers.

Definition at line 34 of file k4atypes.h.

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ K4A_DECLARE_HANDLE