Share via

Kinect for Windows SDK Offline Docs

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Starting with version 1.5, the Kinect for Windows SDK was divided into two downloads: the core SDK and the developer toolkit. This was done to allow more rapid updating of the developer toolkit. The SDK documentation was also removed from the SDK install and moved to an online model, which also allows the documentation to be updated more rapidly on MSDN.

Starting with version 1.5, after installing the SDK, you can launch online documentation through MSDN. To launch the online documentation, click Start > All Programs > Kinect for Windows SDK v1.5.1 > SDK Documentation (Kinect for Windows). To view the reference page for a specific programming element in the Kinect for Windows API, press F1 after selecting the element in a file opened for editing in Visual Studio. If you prefer to look at a local copy of the documentation, you may also install offline documentation to your local machine using the Visual Studio Help Library Manager.

To Install Offline (Local) SDK Documentation

To install the SDK documentation to your machine, use the Visual Studio 2010 Help Library Manager (or a later version).

  1. Launch Visual Studio Help Library Manager by clicking Start > All Programs > Microsoft Visual Studio 2010 > Visual Studio Tools > Manage Help Settings.

    Figure 1.  Visual Studio 2010 Help Library Manager

    JJ160159.k4w_vs2010_1(en-us,IEB.10).png

  2. Click Install content from online. Wait for the dialog box to be populated with all of the content collections that are available for installation.

  3. Scroll down to find Kinect for Windows SDK. Click Add.

  4. Click Update to download the content.

  5. Click Finish.

To access the documentation, click Help > View Help from within Visual Studio or press F1 from a reference page.

At any time, you can check (or change) whether the Help Library Manager displays online or local documentation by clicking Choose online or local help.