k4a::capture Class Reference

Wrapper for k4a_capture_t. More...

#include <k4a/k4a.hpp>

Public Member Functions
	capture (k4a_capture_t handle=nullptr) noexcept
	Creates a capture from a k4a_capture_t Takes ownership of the handle, i.e. More...
	capture (const capture &other) noexcept
	Creates a shallow copy of another capture.
	capture (capture &&other) noexcept
	Moves another capture into a new capture.
capture &	operator= (const capture &other) noexcept
	Sets capture to a shallow copy of the other image.
capture &	operator= (capture &&other) noexcept
	Moves another capture into this capture; other is set to invalid.
capture &	operator= (std::nullptr_t) noexcept
	Invalidates this capture.
bool	operator== (const capture &other) const noexcept
	Returns true if two captures refer to the same k4a_capture_t, false otherwise.
bool	operator== (std::nullptr_t) const noexcept
	Returns false if the capture is valid, true otherwise.
bool	operator!= (const capture &other) const noexcept
	Returns true if two captures wrap different k4a_capture_t instances, false otherwise.
bool	operator!= (std::nullptr_t) const noexcept
	Returns true if the capture is valid, false otherwise.
	operator bool () const noexcept
	Returns true if the capture is valid, false otherwise.
bool	is_valid () const noexcept
	Returns true if the capture is valid, false otherwise.
k4a_capture_t	handle () const noexcept
	Returns the underlying k4a_capture_t handle. More...
void	reset () noexcept
	Releases the underlying k4a_capture_t; the capture is set to invalid.
image	get_color_image () const noexcept
	Get the color image associated with the capture. More...
image	get_depth_image () const noexcept
	Get the depth image associated with the capture. More...
image	get_ir_image () const noexcept
	Get the IR image associated with the capture. More...
void	set_color_image (const image &color_image) noexcept
	Set / add a color image to the capture. More...
void	set_depth_image (const image &depth_image) noexcept
	Set / add a depth image to the capture. More...
void	set_ir_image (const image &ir_image) noexcept
	Set / add an IR image to the capture. More...
void	set_temperature_c (float temperature_c) noexcept
	Set the temperature associated with the capture in Celsius. More...
float	get_temperature_c () const noexcept
	Get temperature (in Celsius) associated with the capture. More...

Static Public Member Functions
static capture	create ()
	Create an empty capture object. More...

Detailed Description

Wrapper for k4a_capture_t.

Wraps a handle for a capture. Copying/moving is cheap, copies are shallow.

---

The documentation for this class was generated from the following file:

• k4a.hpp