Kinect/NuiApi.h File Reference

NuiApi.h File Reference
#include <pshpack8.h>
#include <NuiSensor.h>
#include <NuiImageCamera.h>
#include <NuiSkeleton.h>
#include <poppack.h>

Macros

#define NUIAPI   __declspec( dllimport ) WINAPI
 
#define NUI_INITIALIZE_FLAG_USES_AUDIO   0x10000000
 
#define NUI_INITIALIZE_FLAG_USES_DEPTH_AND_PLAYER_INDEX   0x00000001
 
#define NUI_INITIALIZE_FLAG_USES_COLOR   0x00000002
 
#define NUI_INITIALIZE_FLAG_USES_SKELETON   0x00000008
 
#define NUI_INITIALIZE_FLAG_USES_DEPTH   0x00000020
 
#define NUI_INITIALIZE_FLAG_USES_HIGH_QUALITY_COLOR   0x00000040
 
#define NUI_INITIALIZE_DEFAULT_HARDWARE_THREAD   0xFFFFFFFF
 
#define _NUI_HRESULTS
 
#define E_NUI_DEVICE_NOT_CONNECTED   __HRESULT_FROM_WIN32(ERROR_DEVICE_NOT_CONNECTED)
 
#define E_NUI_DEVICE_NOT_READY   __HRESULT_FROM_WIN32(ERROR_NOT_READY)
 
#define E_NUI_ALREADY_INITIALIZED   __HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
 
#define E_NUI_NO_MORE_ITEMS   __HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)
 
#define FACILITY_NUI   0x301
 
#define S_NUI_INITIALIZING   MAKE_HRESULT(SEVERITY_SUCCESS, FACILITY_NUI, 1)
 
#define E_NUI_FRAME_NO_DATA   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 1)
 
#define E_NUI_STREAM_NOT_ENABLED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 2)
 
#define E_NUI_IMAGE_STREAM_IN_USE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 3)
 
#define E_NUI_FRAME_LIMIT_EXCEEDED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 4)
 
#define E_NUI_FEATURE_NOT_INITIALIZED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 5)
 
#define E_NUI_NOTGENUINE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 6)
 
#define E_NUI_INSUFFICIENTBANDWIDTH   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 7)
 
#define E_NUI_NOTSUPPORTED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 8)
 
#define E_NUI_DEVICE_IN_USE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 9)
 
#define E_NUI_DATABASE_NOT_FOUND   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 13)
 
#define E_NUI_DATABASE_VERSION_MISMATCH   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 14)
 
#define E_NUI_HARDWARE_FEATURE_UNAVAILABLE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 15)
 
#define E_NUI_NOTCONNECTED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 20 */ ERROR_BAD_UNIT)
 
#define E_NUI_NOTREADY   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 21 */ ERROR_NOT_READY)
 
#define E_NUI_SKELETAL_ENGINE_BUSY   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 170 */ ERROR_BUSY)
 
#define E_NUI_NOTPOWERED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 639 */ ERROR_INSUFFICIENT_POWER)
 
#define E_NUI_BADINDEX   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 1413 */ ERROR_INVALID_INDEX)
 
#define E_NUI_BADIINDEX   E_NUI_BADINDEX
 

Functions

HRESULT __declspec (dllimport) WINAPI NuiInitialize(_In_ DWORD dwFlags)
 Initializes the sensor. More...
 

Macro Definition Documentation

#define _NUI_HRESULTS

Definition at line 62 of file NuiApi.h.

#define E_NUI_ALREADY_INITIALIZED   __HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)

Definition at line 70 of file NuiApi.h.

#define E_NUI_BADIINDEX   E_NUI_BADINDEX

Definition at line 101 of file NuiApi.h.

#define E_NUI_BADINDEX   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 1413 */ ERROR_INVALID_INDEX)

Definition at line 100 of file NuiApi.h.

#define E_NUI_DATABASE_NOT_FOUND   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 13)

Definition at line 87 of file NuiApi.h.

#define E_NUI_DATABASE_VERSION_MISMATCH   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 14)

Definition at line 88 of file NuiApi.h.

#define E_NUI_DEVICE_IN_USE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 9)

Definition at line 85 of file NuiApi.h.

#define E_NUI_DEVICE_NOT_CONNECTED   __HRESULT_FROM_WIN32(ERROR_DEVICE_NOT_CONNECTED)

Definition at line 68 of file NuiApi.h.

#define E_NUI_DEVICE_NOT_READY   __HRESULT_FROM_WIN32(ERROR_NOT_READY)

Definition at line 69 of file NuiApi.h.

#define E_NUI_FEATURE_NOT_INITIALIZED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 5)

Definition at line 81 of file NuiApi.h.

#define E_NUI_FRAME_LIMIT_EXCEEDED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 4)

Definition at line 80 of file NuiApi.h.

#define E_NUI_FRAME_NO_DATA   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 1)

Definition at line 76 of file NuiApi.h.

#define E_NUI_HARDWARE_FEATURE_UNAVAILABLE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 15)

Definition at line 90 of file NuiApi.h.

#define E_NUI_IMAGE_STREAM_IN_USE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 3)

Definition at line 79 of file NuiApi.h.

#define E_NUI_INSUFFICIENTBANDWIDTH   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 7)
+ Examples:

Definition at line 83 of file NuiApi.h.

#define E_NUI_NO_MORE_ITEMS   __HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)

Definition at line 71 of file NuiApi.h.

#define E_NUI_NOTCONNECTED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 20 */ ERROR_BAD_UNIT)
+ Examples:

Definition at line 92 of file NuiApi.h.

#define E_NUI_NOTGENUINE   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 6)
+ Examples:

Definition at line 82 of file NuiApi.h.

#define E_NUI_NOTPOWERED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 639 */ ERROR_INSUFFICIENT_POWER)
+ Examples:

Definition at line 98 of file NuiApi.h.

#define E_NUI_NOTREADY   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 21 */ ERROR_NOT_READY)
+ Examples:

Definition at line 94 of file NuiApi.h.

#define E_NUI_NOTSUPPORTED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 8)
+ Examples:

Definition at line 84 of file NuiApi.h.

#define E_NUI_SKELETAL_ENGINE_BUSY   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, /* 170 */ ERROR_BUSY)

Definition at line 96 of file NuiApi.h.

#define E_NUI_STREAM_NOT_ENABLED   MAKE_HRESULT(SEVERITY_ERROR, FACILITY_NUI, 2)

Definition at line 78 of file NuiApi.h.

#define FACILITY_NUI   0x301

Definition at line 74 of file NuiApi.h.

#define NUI_INITIALIZE_DEFAULT_HARDWARE_THREAD   0xFFFFFFFF

Definition at line 33 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_AUDIO   0x10000000
+ Examples:

Definition at line 26 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_COLOR   0x00000002

Definition at line 28 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_DEPTH   0x00000020

Definition at line 30 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_DEPTH_AND_PLAYER_INDEX   0x00000001

Definition at line 27 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_HIGH_QUALITY_COLOR   0x00000040

Definition at line 31 of file NuiApi.h.

#define NUI_INITIALIZE_FLAG_USES_SKELETON   0x00000008
+ Examples:

Definition at line 29 of file NuiApi.h.

#define NUIAPI   __declspec( dllimport ) WINAPI

Definition at line 13 of file NuiApi.h.

#define S_NUI_INITIALIZING   MAKE_HRESULT(SEVERITY_SUCCESS, FACILITY_NUI, 1)
+ Examples:

Definition at line 75 of file NuiApi.h.

Function Documentation

VOID __declspec ( dllimport  )

Initializes the sensor.

Shuts down the sensor.

If the sensor is already initialized, this will shut down the sensor and reinitialize it.

Parameters
dwFlagsThe NUI subsystems to initialize, as a bitwise-OR combination of the NUI_INITIALIZE constants.
Returns
Returns S_OK if successful; otherwise, returns a failure code.

If the sensor is already shut down, nothing happens.

+ Examples:

Go to the source code of this file.