Result of ImageTransfer module. More...

Inheritance diagram for fsdk::IImagesBatch:

Public Member Functions
virtual size_t	getSize () const noexcept=0
	Returns size.

virtual Image	getImage (size_t index=0) const noexcept=0
	Returns Image.

virtual Span< const Image >	getImages () const noexcept=0
	Return Images Span.

Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t	retain () noexcept=0
	Increase strong reference count.

virtual int32_t	retainLocked () noexcept=0
	Increase strong reference count thread safely.

virtual int32_t	release () noexcept=0
	Decrease strong reference count.

virtual int32_t	getRefCount () const noexcept=0
	Get actual strong reference count.

virtual int32_t	retainWeak () noexcept=0
	Increase weak reference count.

virtual int32_t	releaseWeak () noexcept=0
	Decrease weak reference count.

virtual int32_t	getWeakRefCount () const noexcept=0
	Get actual weak reference count.

Detailed Description

Result of ImageTransfer module.

Note: Images stored in IImagesBatch is located in internal memory pool placed on device user choose while making transfer.; This structure valid only while FaceEngine initialized. Usage of this structure after FaceEngine destruction is undefined behaviour.

Member Function Documentation

virtual Image fsdk::IImagesBatch::getImage ( size_t index = 0 ) const

pure virtualnoexcept

Returns Image.

Parameters

[in] index index of the image in a batch.

virtual Span< const Image > fsdk::IImagesBatch::getImages ( ) const

pure virtualnoexcept

Return Images Span.

Note: The resulting fsdk::Span refers to the fsdk::IImagesBatch object internal storage and does not own a data.

virtual size_t fsdk::IImagesBatch::getSize ( ) const

pure virtualnoexcept

Returns size.

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