SyncMultiFrameListener Class Reference

Collect multiple types of frames. More...

#include <libfreenect2/frame_listener_impl.h>

Inheritance diagram for SyncMultiFrameListener:

Public Member Functions
	SyncMultiFrameListener (unsigned int frame_types)
virtual	~SyncMultiFrameListener ()
bool	hasNewFrame () const
	Test if there are new frames.
bool	waitForNewFrame (FrameMap &frame, int milliseconds)
	Wait milliseconds for new frames.
void	waitForNewFrame (FrameMap &frame)
	Wait indefinitely for new frames.
void	release (FrameMap &frame)
	Shortcut to delete all frames in Frame Listeners.
virtual bool	onNewFrame (Frame::Type type, Frame *frame)
	libfreenect2 calls this function when a new frame is decoded.
Public Member Functions inherited from FrameListener
virtual	~FrameListener ()

Detailed Description

Collect multiple types of frames.

Constructor & Destructor Documentation

SyncMultiFrameListener()

SyncMultiFrameListener

(

unsigned int

frame_types

)

Parameters

frame_types

Use bitwise or to combine multiple types, e.g. Frame::Ir | Frame::Depth.

Referenced by onNewFrame().

~SyncMultiFrameListener()

virtual ~SyncMultiFrameListener ( )

virtual

Member Function Documentation

hasNewFrame()

bool hasNewFrame

(

)

const

Test if there are new frames.

Non-blocking.

waitForNewFrame() [1/2]

bool waitForNewFrame	(	FrameMap &	frame,
		int	milliseconds )

Wait milliseconds for new frames.

Parameters

[out]	frame	Caller is responsible to release the frames in Frame Listeners.
	milliseconds	Timeout in milliseconds.

Returns

true if a frame is received; false if not.

waitForNewFrame() [2/2]

void waitForNewFrame

(

FrameMap &

frame

)

Wait indefinitely for new frames.

Parameters

[out]

frame

Caller is responsible to release the frames in Frame Listeners.

release()

void release

(

FrameMap &

frame

)

Shortcut to delete all frames in Frame Listeners.

onNewFrame()

virtual bool onNewFrame ( Frame::Type type, Frame * frame )

virtual

libfreenect2 calls this function when a new frame is decoded.

Parameters

type	Type of the new frame.
frame	Data of the frame.

Returns

true if you want to take ownership of the frame, i.e. reuse/delete it. Will be reused/deleted by caller otherwise.

Implements FrameListener.

References SyncMultiFrameListener().