Implement various methods to decode color and depth images with different performance and platform support. More...

Classes
class	PacketPipeline
	Base class for other pipeline classes. More...
class	DumpPacketPipeline
class	CpuPacketPipeline
	Pipeline with CPU depth processing. More...
class	OpenGLPacketPipeline
	Pipeline with OpenGL depth processing. More...
class	OpenCLPacketPipeline
	Pipeline with OpenCL depth processing. More...
class	OpenCLKdePacketPipeline
class	CudaPacketPipeline
class	CudaKdePacketPipeline
class	MetalPacketPipeline
	Pipeline with Metal GPU depth processing (Apple platforms). More...

Functions
PacketPipeline *	createPacketPipeline (const std::string &name, int device_id=-1)
	Construct a compiled pipeline by canonical name, or return NULL.
PacketPipeline *	createPacketPipeline (const std::string &name, const PacketPipelineConfig &config, int device_id=-1)
PacketPipeline *	createDefaultPacketPipeline ()
	Construct the environment-selected/default pipeline.
PacketPipeline *	createDefaultPacketPipeline (const PacketPipelineConfig &config)
std::vector< std::string >	getCompiledPacketPipelines ()
	Canonical names of pipelines compiled into this library.
std::vector< std::string >	getAvailablePacketPipelines ()
	Canonical names of compiled pipelines usable on this machine.

Detailed Description

Implement various methods to decode color and depth images with different performance and platform support.

You can construct a specific PacketPipeline object and provide it to Freenect2::openDevice().

Function Documentation

◆ createPacketPipeline() [1/2]

PacketPipeline * createPacketPipeline	(	const std::string &	name,
		int	device_id = -1 )

Construct a compiled pipeline by canonical name, or return NULL.

The caller owns the returned object until it is passed to Freenect2::openDevice().

◆ createPacketPipeline() [2/2]

PacketPipeline * createPacketPipeline	(	const std::string &	name,
		const PacketPipelineConfig &	config,
		int	device_id = -1 )

◆ createDefaultPacketPipeline() [1/2]

PacketPipeline * createDefaultPacketPipeline ( )

Construct the environment-selected/default pipeline.

◆ createDefaultPacketPipeline() [2/2]

PacketPipeline * createDefaultPacketPipeline ( const PacketPipelineConfig & config )

◆ getCompiledPacketPipelines()

std::vector< std::string > getCompiledPacketPipelines ( )

Canonical names of pipelines compiled into this library.

◆ getAvailablePacketPipelines()

std::vector< std::string > getAvailablePacketPipelines ( )

Canonical names of compiled pipelines usable on this machine.

Availability probing constructs each compiled pipeline and can initialize graphics or compute runtimes and create a hidden OpenGL context. The call can therefore be relatively expensive and have process-global driver side effects; avoid using it on latency-sensitive paths.

Classes

Functions