A Sink for a synchronized pose and texture buffer based on an image buffer useful for AR video see-through pipelines.. UUID: 85db2f25-4f1c-4e06-9011-e020284bfc4f
More...
#include <SolARBasicSink.h>
|
void | set (const SolAR::datastructure::Transform3Df &pose, const SRef< SolAR::datastructure::Image > image) override |
| Set a new image and pose coming from the pipeline. More...
|
|
void | set (const SRef< SolAR::datastructure::Image > image) override |
| Set a new image without pose. More...
|
|
FrameworkReturnCode | setImageBuffer (unsigned char *imageBufferPointer) override |
| Set a pointer to the texture buffer to update it with the new image when required. More...
|
|
SolAR::api::sink::SinkReturnCode | get (SolAR::datastructure::Transform3Df &pose) override |
| 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...
|
|
SolAR::api::sink::SinkReturnCode | tryGet (SolAR::datastructure::Transform3Df &pose) override |
| 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...
|
|
void | unloadComponent () override final |
|
A Sink for a synchronized pose and texture buffer based on an image buffer useful for AR video see-through pipelines.. UUID: 85db2f25-4f1c-4e06-9011-e020284bfc4f
This interface allows to make available a pose to a third party application and to update image buffer with a new image.
◆ get()
SolAR::api::sink::SinkReturnCode SolAR::MODULES::TOOLS::SolARBasicSink::get |
( |
SolAR::datastructure::Transform3Df & |
pose | ) |
|
|
override |
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 SinkReturnCode::_SUCCESS if a new pose and image are available, otherwise frameworkReturnCode::_ERROR.
◆ set() [1/2]
void SolAR::MODULES::TOOLS::SolARBasicSink::set |
( |
const SolAR::datastructure::Transform3Df & |
pose, |
|
|
const SRef< SolAR::datastructure::Image > |
image |
|
) |
| |
|
override |
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]
void SolAR::MODULES::TOOLS::SolARBasicSink::set |
( |
const SRef< SolAR::datastructure::Image > |
image | ) |
|
|
override |
Set a new image without pose.
- Parameters
-
[in] | image | The new image to update a buffer texture when required. |
◆ setImageBuffer()
FrameworkReturnCode SolAR::MODULES::TOOLS::SolARBasicSink::setImageBuffer |
( |
unsigned char * |
imageBufferPointer | ) |
|
|
override |
Set a pointer to the texture buffer to update it with the new image when required.
- Parameters
-
[in] | imageBuffer | the texture buffer uses to contain the new image |
- Returns
- FrameworkReturnCode::SUCCESS if the texture buffer pointer is well set.
◆ tryGet()
SolAR::api::sink::SinkReturnCode SolAR::MODULES::TOOLS::SolARBasicSink::tryGet |
( |
SolAR::datastructure::Transform3Df & |
pose | ) |
|
|
override |
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 SinkReturnCode::_SUCCESS if a new pose and image are available, otherwise frameworkReturnCode::_ERROR.
The documentation for this class was generated from the following file: