fsdk::IImagesBatch Struct Reference

Result of ImageTransfer module. More...

#include <IImagesBatch.h>

Inheritance diagram for fsdk::IImagesBatch:

List of all members.

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.

---

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 virtual]

Returns Image.

Parameters:

[in]

index

index of the image in a batch.

Returns:

Image.

See also:

Image for details.

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

(

)

const [pure virtual]

Return Images Span.

Returns:

Span of Images.

See also:

Span and Image for details.

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 virtual]

Returns size.

Returns:

size of the image list.

---

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

• include/fsdk/IImagesBatch.h