Every user-facing document in this repository is listed below and appears in the same category under the site-wide Guides menu.

Start with Getting Started if you have not yet captured frames from a device.

Install & Upgrade

Installing on macOSHomebrew, Apple Silicon, Metal, and architecture fixes.
Installing on LinuxPackages, optional backends, udev rules, and multiple sensors.
Installing on WindowsUsbDk or libusbK, dependencies, Visual Studio, and vcpkg.
Kinect v1 versus Kinect v2 Identify the sensor and avoid incompatible v1 advice.
Migrating to libfreenect2 0.4 C++17, typed frames, runtime statistics, calibration, and manifests.
Migrating to libfreenect2 0.3 Timing, lifecycle, recording, filtering, CUDA, and calibration.
v0.3 upstream coverage Issue mapping and hosted versus hardware validation status.

Operate & Troubleshoot

Runtime configurationDepth filters, environment variables, RGB decoders, and camera controls.
Frame timing and software pairing Device clocks, timestamp thresholds, and synchronization limits.
USB bandwidth and transfer tuning Controller budgets, transfer pools, usbfs, and autosuspend.
TroubleshootingEnumeration, stalled streams, pipeline failures, depth problems, and bug reports.
Frequently asked questionsMirroring, emitters, logs, timestamps, audio, tracking, and interference.

Registration and coordinate mapping Convert among depth pixels, color pixels, and metric 3-D points.
Camera calibration profiles Canonical JSON, offline calibration, quality gates, and legacy YAML.
Depth accuracy and calibration Systematic offset, warm-up drift, intrinsics, and SDK differences.
Per-device depth correction Fit, validate, and explicitly apply a linear correction profile.
Recording, replay, and multiple Kinects Capture raw streams and replay them through any pipeline.
Using Kinect v2 as a webcamBridge RGB frames into webcam-oriented applications.
Using libfreenect2 from PythonBindings, registered depth, and the supported pose-estimation workflow.

Kinect v2 USB protocolTopology, command transactions, calibration pages, and stream framing.
Benchmarking and performance Reproducible measurements, processing costs, and decoder choices.

Development and contributing Toolchains, builds, formatting, documentation, CI, and patches.
Quality checksTests, sanitizers, fuzzing, coverage, static analysis, and hardware soak.
Test planAutomated coverage, hardware smoke checks, lifecycle tests, and release evidence.
Self-hosted macOS CI runner Provision and maintain the machine that validates Metal.