Wrapper for k4a_image_t. More...

#include <k4a/k4a.hpp>

Public Member Functions
	image (k4a_image_t handle=nullptr) noexcept
	Creates an image from a k4a_image_t. More...

	image (const image &other) noexcept
	Creates a shallow copy of another image.

	image (image &&other) noexcept
	Moves another image into a new image.

image &	operator= (const image &other) noexcept
	Sets image to a shallow copy of the other image.

image &	operator= (image &&other) noexcept
	Moves another image into this image; other is set to invalid.

image &	operator= (std::nullptr_t) noexcept
	Invalidates this image.

bool	operator== (const image &other) const noexcept
	Returns true if two images refer to the same k4a_image_t, false otherwise.

bool	operator== (std::nullptr_t) const noexcept
	Returns false if the image is valid, true otherwise.

bool	operator!= (const image &other) const noexcept
	Returns true if two images wrap different k4a_image_t instances, false otherwise.

bool	operator!= (std::nullptr_t) const noexcept
	Returns true if the image is valid, false otherwise.

	operator bool () const noexcept
	Returns true if the image is valid, false otherwise.

bool	is_valid () const noexcept
	Returns true if the image is valid, false otherwise.

k4a_image_t	handle () const noexcept
	Returns the underlying k4a_image_t handle. More...

void	reset () noexcept
	Releases the underlying k4a_image_t; the image is set to invalid.

uint8_t *	get_buffer () noexcept
	Get the image buffer. More...

const uint8_t *	get_buffer () const noexcept
	Get the image buffer. More...

size_t	get_size () const noexcept
	Get the image buffer size in bytes. More...

k4a_image_format_t	get_format () const noexcept
	Get the image format of the image. More...

int	get_width_pixels () const noexcept
	Get the image width in pixels. More...

int	get_height_pixels () const noexcept
	Get the image height in pixels. More...

int	get_stride_bytes () const noexcept
	Get the image stride in bytes. More...

std::chrono::microseconds	get_device_timestamp () const noexcept
	Get the image's device timestamp in microseconds. More...

std::chrono::nanoseconds	get_system_timestamp () const noexcept
	Get the image's system timestamp in nanoseconds. More...

std::chrono::microseconds	get_exposure () const noexcept
	Get the image exposure time in microseconds. More...

uint32_t	get_white_balance () const noexcept
	Get the image white balance in Kelvin (color images only) More...

uint32_t	get_iso_speed () const noexcept
	Get the image's ISO speed (color images only) More...

void	set_timestamp (std::chrono::microseconds timestamp) noexcept
	Set the image's timestamp in microseconds. More...

void	set_exposure_time (std::chrono::microseconds exposure) noexcept
	Set the image's exposure time in microseconds (color images only) More...

void	set_white_balance (uint32_t white_balance) noexcept
	Set the white balance of the image (color images only) More...

void	set_iso_speed (uint32_t iso_speed) noexcept
	Set the ISO speed of the image (color images only) More...

Static Public Member Functions
static image	create (k4a_image_format_t format, int width_pixels, int height_pixels, int stride_bytes)
	Create a blank image Throws error on failure. More...

static image	create_from_buffer (k4a_image_format_t format, int width_pixels, int height_pixels, int stride_bytes, uint8_t buffer, size_t buffer_size, k4a_memory_destroy_cb_t buffer_release_cb, void *buffer_release_cb_context)
	Create an image from a pre-allocated buffer Throws error on failure. More...

Detailed Description

Wrapper for k4a_image_t.

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

See also: k4a_image_t

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

k4a.hpp

Public Member Functions

Static Public Member Functions

Detailed Description