Solar
Public Member Functions | List of all members
SolAR::api::source::ISourceImage Class Referenceabstract

A Source for an image, useful for AR video see-through pipelines. UUID: 06e2fc5d-39da-4486-b2a6-1d8bd788fa13 More...

#include <ISourceImage.h>

Inheritance diagram for SolAR::api::source::ISourceImage:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::source::ISourceImage:
Collaboration graph
[legend]

Public Member Functions

virtual ~ISourceImage ()=default
 ~ISourceImage
 
virtual SourceReturnCode setInputTexture (const void *sourceTexturehandle, const int width, const int height)=0
 Set a new image coming from a third party. More...
 
virtual SourceReturnCode getNextImage (SRef< SolAR::datastructure::Image > &image) const =0
 Get a pointer to the texture buffer to update it with the new image when required. More...
 

Detailed Description

A Source for an image, useful for AR video see-through pipelines. UUID: 06e2fc5d-39da-4486-b2a6-1d8bd788fa13

This interface allows to link a texture buffer from a third party to our pipeline

Member Function Documentation

◆ getNextImage()

virtual SourceReturnCode SolAR::api::source::ISourceImage::getNextImage ( SRef< SolAR::datastructure::Image > &  image) const
pure virtual

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

Parameters
[in,out]image
Returns
SourceReturnCode::SUCCESS if a new pose and image have been updated, otherwise frameworkReturnCode::_ERROR

◆ setInputTexture()

virtual SourceReturnCode SolAR::api::source::ISourceImage::setInputTexture ( const void *  sourceTexturehandle,
const int  width,
const int  height 
)
pure virtual

Set a new image coming from a third party.

Parameters
[in]sourceTexturehandleTexture buffer from third party like Unity
[in]widthof the image coming from the third party like Unity
[in]heightof the image coming from the third party like Unity
Returns
SourceReturnCode::SUCCESS if a new pose and image have been updated, otherwise frameworkReturnCode::_ERROR

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