Share via


Constants

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Describes NUI constants.

  • NUI_CAMERA Flags
  • NUI_IMAGE Flags
  • NUI_INITIALIZE Flags
  • NUI_SKELETON Flags
  • NUI_SKELETON_QUALITY Flags
  • E_NUI Error Codes

NUI_CAMERA Flags

Constant Value
NUI_CAMERA_DEPTH_IMAGE_TO_SKELETON_MULTIPLIER_320x240 (NUI_CAMERA_DEPTH_NOMINAL_INVERSE_FOCAL_LENGTH_IN_PIXELS)
NUI_CAMERA_SKELETON_TO_DEPTH_IMAGE_MULTIPLIER_320x240 (NUI_CAMERA_DEPTH_NOMINAL_FOCAL_LENGTH_IN_PIXELS)
NUI_CAMERA_DEPTH_NOMINAL_FOCAL_LENGTH_IN_PIXELS (285.63f)
NUI_CAMERA_DEPTH_NOMINAL_INVERSE_FOCAL_LENGTH_IN_PIXELS (3.501e-3f)
NUI_CAMERA_DEPTH_NOMINAL_DIAGONAL_FOV (70.0f)
NUI_CAMERA_DEPTH_NOMINAL_HORIZONTAL_FOV (58.5f)
NUI_CAMERA_DEPTH_NOMINAL_VERTICAL_FOV (45.6f)
NUI_CAMERA_COLOR_NOMINAL_FOCAL_LENGTH_IN_PIXELS (531.15f)
NUI_CAMERA_COLOR_NOMINAL_INVERSE_FOCAL_LENGTH_IN_PIXELS (1.83e-3f)
NUI_CAMERA_COLOR_NOMINAL_DIAGONAL_FOV ( 73.9f)
NUI_CAMERA_COLOR_NOMINAL_HORIZONTAL_FOV ( 62.0f)
NUI_CAMERA_COLOR_NOMINAL_VERTICAL_FOV ( 48.6f)
NUI_CAMERA_ELEVATION_MAXIMUM 27
NUI_CAMERA_ELEVATION_MINIMUM (-27)

Header: NuiImageCamera.h

NUI_IMAGE Flags

Constant Value
NUI_IMAGE_DEPTH_MAXIMUM ((4000 << NUI_IMAGE_PLAYER_INDEX_SHIFT) | NUI_IMAGE_PLAYER_INDEX_MASK)
NUI_IMAGE_DEPTH_MINIMUM (800 << NUI_IMAGE_PLAYER_INDEX_SHIFT)
NUI_IMAGE_DEPTH_NO_VALUE 0
NUI_IMAGE_STREAM_FLAG_DISTINCT_OVERFLOW_DEPTH_VALUES 0x00040000
NUI_IMAGE_STREAM_FLAG_ENABLE_NEAR_MODE 0x00020000
NUI_IMAGE_STREAM_FLAG_SUPPRESS_NO_FRAME_DATA 0x00010000
NUI_IMAGE_STREAM_FLAG_TOO_FAR_IS_NONZERO 0x00040000
NUI_IMAGE_STREAM_FRAME_LIMIT_MAXIMUM 4
NUI_IMAGE_PLAYER_INDEX_SHIFT 3
NUI_IMAGE_PLAYER_INDEX_MASK ((1 << NUI_IMAGE_PLAYER_INDEX_SHIFT)-1)

Header: NuiImageCamera.h

NUI_INITIALIZE Flags

Kinect sensor initialization options when calling NuiInitialize. These may be combined using a bitwise OR.

Constant Description
NUI_INITIALIZE_DEFAULT_HARDWARE_THREAD This flag was deprecated in version 1.5; it is no longer used.
NUI_INITIALIZE_FLAG_USES_AUDIO Initialize the sensor to provide audio data.
NUI_INITIALIZE_FLAG_USES_COLOR Initialize the sensor to provide color data.
NUI_INITIALIZE_FLAG_USES_DEPTH Initialize the sensor to provide depth data.
NUI_INITIALIZE_FLAG_USES_DEPTH_AND_PLAYER_INDEX Initialize the sensor to provide depth data with a player index.
NUI_INITIALIZE_FLAG_USES_SKELETON Initialize the sensor to provide skeleton data.

Header: NuiApi.h

NUI_SKELETON Flags

Constant Value
NUI_SKELETON_COUNT 6
NUI_SKELETON_MAX_TRACKED_COUNT 2
NUI_SKELETON_INVALID_TRACKING_ID 0
NUI_SKELETON_FRAME_FLAG_CAMERA_MOTION 0x00000001
NUI_SKELETON_FRAME_FLAG_EXTRAPOLATED_FLOOR 0x00000002
NUI_SKELETON_FRAME_FLAG_UPPER_BODY_SKELETON 0x00000004
NUI_SKELETON_TRACKING_FLAG_SUPPRESS_NO_FRAME_DATA 0x00000001
NUI_SKELETON_TRACKING_FLAG_TITLE_SETS_TRACKED_SKELETONS 0x00000002
NUI_SKELETON_TRACKING_FLAG_ENABLE_SEATED_SUPPORT 0x00000004
NUI_SKELETON_TRACKING_FLAG_ENABLE_IN_NEAR_RANGE 0x00000008

Header: NuiSkeleton.h

NUI_SKELETON_QUALITY Flags

These flags indicate that part of the person is not visible on the screen. They can be used to provide feedback to the user to move to the center of the visible area. For instance, if a person is clipped on the right of the camera, then the person should move towards the left of the camera (to their right). These flags are used in NUI_SKELETON_DATA structure in the dwQualityFlags member.

Constant Description
NUI_SKELETON_QUALITY_CLIPPED_RIGHT Part of the player's body is out of frame to the camera's right.
NUI_SKELETON_QUALITY_CLIPPED_LEFT Part of the player's body is out of frame to the camera's left.
NUI_SKELETON_QUALITY_CLIPPED_TOP Part of the player's body is out of frame above the camera's field of view.
NUI_SKELETON_QUALITY_CLIPPED_BOTTOM Part of the player's body is out of frame below the camera's field of view.

Header: NuiSkeleton.h

E_NUI Error Codes

Constant Value
E_NUI_DEVICE_NOT_CONNECTED __HRESULT_FROM_WIN32(ERROR_DEVICE_NOT_CONNECTED)
E_NUI_DEVICE_NOT_READY __HRESULT_FROM_WIN32(ERROR_NOT_READY)
E_NUI_ALREADY_INITIALIZED __HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
E_NUI_NO_MORE_ITEMS __HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)
E_NUI_FRAME_NO_DATA MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 1)
E_NUI_STREAM_NOT_ENABLED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 2)
E_NUI_IMAGE_STREAM_IN_USE MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 3)
E_NUI_FRAME_LIMIT_EXCEEDED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 4)
E_NUI_FEATURE_NOT_INITIALIZED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 5)
E_NUI_DATABASE_NOT_FOUND MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 13)
E_NUI_DATABASE_VERSION_MISMATCH MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 14)
E_NUI_NOTCONNECTED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 20 */ ERROR_BAD_UNIT)
E_NUI_NOTREADY MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 21 */ ERROR_NOT_READY)
E_NUI_SKELETAL_ENGINE_BUSY MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 170 */ ERROR_BUSY)
E_NUI_NOTPOWERED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 639 */ ERROR_INSUFFICIENT_POWER)
E_NUI_BADIINDEX MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 1413 */ ERROR_INVALID_INDEX)

Header: NuiAPI.h