Back to Adaptive Vision Library website

You are here: Start » Function Reference » Configuration » AvsFilter_InitGPUProcessing

AvsFilter_InitGPUProcessing


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Initializes GPU OpenCL processing.

Syntax

void avs::AvsFilter_InitGPUProcessing
(
	InitGPUProcessingState& ioState,
	const atl::Optional<const atl::String&>& inPlatformName,
	const atl::Optional<const atl::String&>& inDeviceName,
	atl::Optional<atl::String&> diagDeviceInfo
)

Parameters

Name Type Default Description
ioState InitGPUProcessingState& Object used to maintain state of the function.
inPlatformName const Optional<const String&>& NIL Name or fragment of a name of OpenCL provider platform
inDeviceName const Optional<const String&>& NIL Name or fragment of a name of OpenCL device
diagDeviceInfo Optional<String&> Provides human readable diagnostic information about OpenCL device selected for processing

Errors

Error type Description
IoError OpenCL is not available in local system.
No OpenCL platform runtime software has been installed on local system.
IoError No suitable GPU OpenCL device available in local system.
Platform name and device name was not specified and there is no OpenCL capable graphics card installed in local system, there is no proper runtime software for it or it does not meet requirements.
IoError Unable to find OpenCL platform with specified name.
Platform name was specified but there is not OpenCL platform in local system with matching name.
IoError No suitable GPU OpenCL device available in selected local platform.
Platform name was specified and found but it does not contain an OpenCL capable graphics card or it does not meet requirements.
IoError Unable to find OpenCL device with specified name.
Device name was specified but local system (or specified platform) does not contain a device with matching name.
IoError Selected OpenCL device does not provides an OpenCL C compiler.
Device name was specified and found but it does not provide an OpenCL C compiler.
IoError Selected OpenCL device does not supports required minimal version of OpenCL C language.
Device name was specified and found but its OpenCL C compiler does not supports OpenCL C standard of required minimal version.
IoError Selected OpenCL device has endianness different than host.
Device name was specified and found but it reports endianness different than host CPU endianness.
DomainError Empty platform name specified.
inPlatformName is set to empty text.
DomainError Empty device name specified.
inDeviceName is set to empty text.