SolAR::api::sink::ISinkPoseTextureBuffer Class Reference

A Sink for a synchronized pose and texture buffer useful for AR video see-through pipelines. UUID: 8b220946-34ab-4fba-9aa7-ea8da807a2cf More...

#include <ISinkPoseTextureBuffer.h>

Inheritance diagram for SolAR::api::sink::ISinkPoseTextureBuffer:

Collaboration diagram for SolAR::api::sink::ISinkPoseTextureBuffer:

Public Member Functions
virtual	~ISinkPoseTextureBuffer ()=default
	~ISinkPoseTextureBuffer
virtual void	set (const SolAR::datastructure::Transform3Df &pose, const SRef< SolAR::datastructure::Image > image)=0
	Set a new image and pose coming from the pipeline. More...
virtual void	set (const SRef< SolAR::datastructure::Image > image)=0
	Set a new image without pose. More...
virtual FrameworkReturnCode	setTextureBuffer (void *textureBufferPointer)=0
	Set a pointer to the texture buffer to update it with the new image when required. More...
virtual void	updateFrameDataOGL (int enventID)=0
	???
virtual SinkReturnCode	udpate (SolAR::datastructure::Transform3Df &pose)=0
	Provide an access to the new pose and update the texture buffer with the new image. The implementation of this interface must be thread safe. More...
virtual SinkReturnCode	tryUpdate (SolAR::datastructure::Transform3Df &pose)=0
	Provide an access to the new pose and update the texture buffer with the new image only if the image and the pose have been updated by the pipeline. The implementation of this interface must be thread safe. More...

Detailed Description

A Sink for a synchronized pose and texture buffer useful for AR video see-through pipelines. UUID: 8b220946-34ab-4fba-9aa7-ea8da807a2cf

This interface allows to make available a pose to a third party application and to update a texture buffer with a new image.

Member Function Documentation

set() [1/2]

virtual void SolAR::api::sink::ISinkPoseTextureBuffer::set ( const SolAR::datastructure::Transform3Df &  pose, const SRef< SolAR::datastructure::Image >  image  )

pure virtual

Set a new image and pose coming from the pipeline.

Parameters

[in]	pose	The new pose to be made available to a third party application.
[in]	image	The new image to update a buffer texture when required.

set() [2/2]

virtual void SolAR::api::sink::ISinkPoseTextureBuffer::set ( const SRef< SolAR::datastructure::Image >  image )

pure virtual

Set a new image without pose.

Parameters

[in]

image

The new image to update a buffer texture when required.

setTextureBuffer()

virtual FrameworkReturnCode SolAR::api::sink::ISinkPoseTextureBuffer::setTextureBuffer ( void *  textureBufferPointer )

pure virtual

Set a pointer to the texture buffer to update it with the new image when required.

Parameters

[in]

textureBufferPointer

the pointer on texture buffer

Returns

FrameworkReturnCode::SUCCESS if the texture buffer pointer is well set.

tryUpdate()

virtual SinkReturnCode SolAR::api::sink::ISinkPoseTextureBuffer::tryUpdate ( SolAR::datastructure::Transform3Df &  pose )

pure virtual

Provide an access to the new pose and update the texture buffer with the new image only if the image and the pose have been updated by the pipeline. The implementation of this interface must be thread safe.

Parameters

[in,out]

pose

the new pose made available by the pipeline.

Returns

return FrameworkReturnCode::SUCCESS if a new pose and image are available, otherwise frameworkReturnCode::_ERROR.

udpate()

virtual SinkReturnCode SolAR::api::sink::ISinkPoseTextureBuffer::udpate ( SolAR::datastructure::Transform3Df &  pose )

pure virtual

Provide an access to the new pose and update the texture buffer with the new image. The implementation of this interface must be thread safe.

Parameters

[in,out]

pose

the new pose made available by the pipeline.

Returns

return FrameworkReturnCode::SUCCESS if a new pose and image have been updated, otherwise frameworkReturnCode::_ERROR.

---

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

• interfaces/api/sink/ISinkPoseTextureBuffer.h