fsdk::IImageTransfer Struct Reference

Image transfer facility which give speed up of usage internal memory pool. More...

#include <IImageTransfer.h>

Inheritance diagram for fsdk::IImageTransfer:

List of all members.

Public Member Functions
virtual ResultValue< FSDKError, Ref< IImagesBatch > >	transfer (Span< const Image > images, Image::MemoryResidence residence) const noexcept=0
	Transfer of multiple images.
virtual Result< FSDKError >	validate (Span< const Image > images, Image::MemoryResidence residence, Span< Result< FSDKError >> errors) const noexcept=0
	Validate input of multiple frames in a single function call.
virtual ImagesBatchFuture	transferAsync (Span< const Image > images, Image::MemoryResidence residence) const =0
	Asynchronously transfer multiple images.

---

Detailed Description

Image transfer facility which give speed up of usage internal memory pool.

Note:

This module designed to work only while FaceEngine initialized. Usage of this module after FaceEngine destruction is undefined behaviour.

This module is only make sense to use if user get sdk compiled with cuda support and if user set deviceClass to GPU nevertheless transfer accomplished CPU -> GPU or reverse.

---

Member Function Documentation

virtual ResultValue<FSDKError, Ref<IImagesBatch> > fsdk::IImageTransfer::transfer	(	Span< const Image >	images,
		Image::MemoryResidence	residence
	)		const [pure virtual]

Transfer of multiple images.

Parameters:

[in]	images	span of source images.
[in]	residence	desired destination residence.

Returns:

ResultValue with error code and IImagesBatch object.

See also:

Ref, Span, Image, MemoryResidence, IImagesBatch, ResultValue and FSDKError for details.

Note:

all spans should be based on user owned continuous collections.

virtual ImagesBatchFuture fsdk::IImageTransfer::transferAsync	(	Span< const Image >	images,
		Image::MemoryResidence	residence
	)		const [pure virtual]

Asynchronously transfer multiple images.

Parameters:

[in]	images	span of source images.
[in]	residence	desired destination residence.

Returns:

Future with IImagesBatch object.

See also:

Ref, Span, Image, MemoryResidence, IImagesBatch vlc::future for details.

Note:

all spans should be based on user owned continuous collections.

this method is experimental and interface may be changed in the future.

this method is not marked as noexcept and may throw an exception.

virtual Result<FSDKError> fsdk::IImageTransfer::validate	(	Span< const Image >	images,
		Image::MemoryResidence	residence,
		Span< Result< FSDKError >>	errors
	)		const [pure virtual]

Validate input of multiple frames in a single function call.

Parameters:

[in]	images	span of source images.
[in]	residence	desired destination residence.
[out]	errors	output span of errors for each image.

Returns:

Result with error code.

See also:

Span, Image, MemoryResidence, Result and FSDKError for details.

Note:

all spans should be based on user owned continuous collections.

all spans should be equal size.

---

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

• include/fsdk/IImageTransfer.h