cv::ocl::Device Class Reference

#include <ocl.hpp>

Public Types
enum	{   TYPE_DEFAULT = (1 << 0) , TYPE_CPU = (1 << 1) , TYPE_GPU = (1 << 2) , TYPE_ACCELERATOR = (1 << 3) ,   TYPE_DGPU = TYPE_GPU + (1 << 16) , TYPE_IGPU = TYPE_GPU + (1 << 17) , TYPE_ALL = 0xFFFFFFFF }
enum	{   FP_DENORM =(1 << 0) , FP_INF_NAN =(1 << 1) , FP_ROUND_TO_NEAREST =(1 << 2) , FP_ROUND_TO_ZERO =(1 << 3) ,   FP_ROUND_TO_INF =(1 << 4) , FP_FMA =(1 << 5) , FP_SOFT_FLOAT =(1 << 6) , FP_CORRECTLY_ROUNDED_DIVIDE_SQRT =(1 << 7) }
enum	{ EXEC_KERNEL =(1 << 0) , EXEC_NATIVE_KERNEL =(1 << 1) }
enum	{ NO_CACHE =0 , READ_ONLY_CACHE =1 , READ_WRITE_CACHE =2 }
enum	{ NO_LOCAL_MEM =0 , LOCAL_IS_LOCAL =1 , LOCAL_IS_GLOBAL =2 }
enum	{ UNKNOWN_VENDOR =0 , VENDOR_AMD =1 , VENDOR_INTEL =2 , VENDOR_NVIDIA =3 }

Public Member Functions
CV_WRAP	Device () CV_NOEXCEPT
	Device (void *d)
	Device (const Device &d)
Device &	operator= (const Device &d)
	Device (Device &&d) CV_NOEXCEPT
Device &	operator= (Device &&d) CV_NOEXCEPT
CV_WRAP	~Device ()
void	set (void *d)
CV_WRAP String	name () const
CV_WRAP String	extensions () const
CV_WRAP bool	isExtensionSupported (const String &extensionName) const
CV_WRAP String	version () const
CV_WRAP String	vendorName () const
CV_WRAP String	OpenCL_C_Version () const
CV_WRAP String	OpenCLVersion () const
CV_WRAP int	deviceVersionMajor () const
CV_WRAP int	deviceVersionMinor () const
CV_WRAP String	driverVersion () const
void *	ptr () const
CV_WRAP int	type () const
CV_WRAP int	addressBits () const
CV_WRAP bool	available () const
CV_WRAP bool	compilerAvailable () const
CV_WRAP bool	linkerAvailable () const
CV_WRAP int	doubleFPConfig () const
CV_WRAP int	singleFPConfig () const
CV_WRAP int	halfFPConfig () const
CV_WRAP bool	hasFP64 () const
	true if 'cl_khr_fp64' extension is available
CV_WRAP bool	hasFP16 () const
	true if 'cl_khr_fp16' extension is available
CV_WRAP bool	endianLittle () const
CV_WRAP bool	errorCorrectionSupport () const
CV_WRAP int	executionCapabilities () const
CV_WRAP size_t	globalMemCacheSize () const
CV_WRAP int	globalMemCacheType () const
CV_WRAP int	globalMemCacheLineSize () const
CV_WRAP size_t	globalMemSize () const
CV_WRAP size_t	localMemSize () const
CV_WRAP int	localMemType () const
CV_WRAP bool	hostUnifiedMemory () const
CV_WRAP bool	imageSupport () const
CV_WRAP bool	imageFromBufferSupport () const
uint	imagePitchAlignment () const
uint	imageBaseAddressAlignment () const
CV_WRAP bool	intelSubgroupsSupport () const
	deprecated, use isExtensionSupported() method (probably with "cl_khr_subgroups" value)
CV_WRAP size_t	image2DMaxWidth () const
CV_WRAP size_t	image2DMaxHeight () const
CV_WRAP size_t	image3DMaxWidth () const
CV_WRAP size_t	image3DMaxHeight () const
CV_WRAP size_t	image3DMaxDepth () const
CV_WRAP size_t	imageMaxBufferSize () const
CV_WRAP size_t	imageMaxArraySize () const
CV_WRAP int	vendorID () const
CV_WRAP bool	isAMD () const
CV_WRAP bool	isIntel () const
CV_WRAP bool	isNVidia () const
CV_WRAP int	maxClockFrequency () const
CV_WRAP int	maxComputeUnits () const
CV_WRAP int	maxConstantArgs () const
CV_WRAP size_t	maxConstantBufferSize () const
CV_WRAP size_t	maxMemAllocSize () const
CV_WRAP size_t	maxParameterSize () const
CV_WRAP int	maxReadImageArgs () const
CV_WRAP int	maxWriteImageArgs () const
CV_WRAP int	maxSamplers () const
CV_WRAP size_t	maxWorkGroupSize () const
CV_WRAP int	maxWorkItemDims () const
void	maxWorkItemSizes (size_t *) const
CV_WRAP int	memBaseAddrAlign () const
CV_WRAP int	nativeVectorWidthChar () const
CV_WRAP int	nativeVectorWidthShort () const
CV_WRAP int	nativeVectorWidthInt () const
CV_WRAP int	nativeVectorWidthLong () const
CV_WRAP int	nativeVectorWidthFloat () const
CV_WRAP int	nativeVectorWidthDouble () const
CV_WRAP int	nativeVectorWidthHalf () const
CV_WRAP int	preferredVectorWidthChar () const
CV_WRAP int	preferredVectorWidthShort () const
CV_WRAP int	preferredVectorWidthInt () const
CV_WRAP int	preferredVectorWidthLong () const
CV_WRAP int	preferredVectorWidthFloat () const
CV_WRAP int	preferredVectorWidthDouble () const
CV_WRAP int	preferredVectorWidthHalf () const
CV_WRAP size_t	printfBufferSize () const
CV_WRAP size_t	profilingTimerResolution () const
Impl *	getImpl () const
bool	empty () const

Static Public Member Functions
static CV_WRAP const Device &	getDefault ()
static Device	fromHandle (void *d)

Protected Attributes
Impl *	p

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
TYPE_DEFAULT
TYPE_CPU
TYPE_GPU
TYPE_ACCELERATOR
TYPE_DGPU
TYPE_IGPU
TYPE_ALL

anonymous enum

anonymous enum

Enumerator
FP_DENORM
FP_INF_NAN
FP_ROUND_TO_NEAREST
FP_ROUND_TO_ZERO
FP_ROUND_TO_INF
FP_FMA
FP_SOFT_FLOAT
FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

anonymous enum

anonymous enum

Enumerator
EXEC_KERNEL
EXEC_NATIVE_KERNEL

anonymous enum

anonymous enum

Enumerator
NO_CACHE
READ_ONLY_CACHE
READ_WRITE_CACHE

anonymous enum

anonymous enum

Enumerator
NO_LOCAL_MEM
LOCAL_IS_LOCAL
LOCAL_IS_GLOBAL

anonymous enum

anonymous enum

Enumerator
UNKNOWN_VENDOR
VENDOR_AMD
VENDOR_INTEL
VENDOR_NVIDIA

Constructor & Destructor Documentation

Device() [1/4]

CV_WRAP cv::ocl::Device::Device

(

)

Device() [2/4]

cv::ocl::Device::Device ( void *  d )

explicit

Device() [3/4]

cv::ocl::Device::Device

(

const Device &

d

)

Device() [4/4]

cv::ocl::Device::Device

(

Device &&

d

)

~Device()

CV_WRAP cv::ocl::Device::~Device

(

)

Member Function Documentation

addressBits()

CV_WRAP int cv::ocl::Device::addressBits

(

)

const

available()

CV_WRAP bool cv::ocl::Device::available

(

)

const

compilerAvailable()

CV_WRAP bool cv::ocl::Device::compilerAvailable

(

)

const

deviceVersionMajor()

CV_WRAP int cv::ocl::Device::deviceVersionMajor

(

)

const

deviceVersionMinor()

CV_WRAP int cv::ocl::Device::deviceVersionMinor

(

)

const

doubleFPConfig()

CV_WRAP int cv::ocl::Device::doubleFPConfig

(

)

const

driverVersion()

CV_WRAP String cv::ocl::Device::driverVersion

(

)

const

empty()

bool cv::ocl::Device::empty ( ) const

inline

endianLittle()

CV_WRAP bool cv::ocl::Device::endianLittle

(

)

const

errorCorrectionSupport()

CV_WRAP bool cv::ocl::Device::errorCorrectionSupport

(

)

const

executionCapabilities()

CV_WRAP int cv::ocl::Device::executionCapabilities

(

)

const

extensions()

CV_WRAP String cv::ocl::Device::extensions

(

)

const

fromHandle()

static Device cv::ocl::Device::fromHandle ( void *  d )

static

Parameters

d	OpenCL handle (cl_device_id). clRetainDevice() is called on success.

Note

Ownership of the passed device is passed to OpenCV on success. The caller should additionally call clRetainDevice on it if it intends to continue using the device.

getDefault()

static CV_WRAP const Device & cv::ocl::Device::getDefault ( )

static

getImpl()

Impl * cv::ocl::Device::getImpl ( ) const

inline

globalMemCacheLineSize()

CV_WRAP int cv::ocl::Device::globalMemCacheLineSize

(

)

const

globalMemCacheSize()

CV_WRAP size_t cv::ocl::Device::globalMemCacheSize

(

)

const

globalMemCacheType()

CV_WRAP int cv::ocl::Device::globalMemCacheType

(

)

const

globalMemSize()

CV_WRAP size_t cv::ocl::Device::globalMemSize

(

)

const

halfFPConfig()

CV_WRAP int cv::ocl::Device::halfFPConfig

(

)

const

hasFP16()

CV_WRAP bool cv::ocl::Device::hasFP16

(

)

const

true if 'cl_khr_fp16' extension is available

hasFP64()

CV_WRAP bool cv::ocl::Device::hasFP64

(

)

const

true if 'cl_khr_fp64' extension is available

hostUnifiedMemory()

CV_WRAP bool cv::ocl::Device::hostUnifiedMemory

(

)

const

image2DMaxHeight()

CV_WRAP size_t cv::ocl::Device::image2DMaxHeight

(

)

const

image2DMaxWidth()

CV_WRAP size_t cv::ocl::Device::image2DMaxWidth

(

)

const

image3DMaxDepth()

CV_WRAP size_t cv::ocl::Device::image3DMaxDepth

(

)

const

image3DMaxHeight()

CV_WRAP size_t cv::ocl::Device::image3DMaxHeight

(

)

const

image3DMaxWidth()

CV_WRAP size_t cv::ocl::Device::image3DMaxWidth

(

)

const

imageBaseAddressAlignment()

uint cv::ocl::Device::imageBaseAddressAlignment

(

)

const

imageFromBufferSupport()

CV_WRAP bool cv::ocl::Device::imageFromBufferSupport

(

)

const

imageMaxArraySize()

CV_WRAP size_t cv::ocl::Device::imageMaxArraySize

(

)

const

imageMaxBufferSize()

CV_WRAP size_t cv::ocl::Device::imageMaxBufferSize

(

)

const

imagePitchAlignment()

uint cv::ocl::Device::imagePitchAlignment

(

)

const

imageSupport()

CV_WRAP bool cv::ocl::Device::imageSupport

(

)

const

intelSubgroupsSupport()

CV_WRAP bool cv::ocl::Device::intelSubgroupsSupport

(

)

const

deprecated, use isExtensionSupported() method (probably with "cl_khr_subgroups" value)

isAMD()

CV_WRAP bool cv::ocl::Device::isAMD ( ) const

inline

isExtensionSupported()

CV_WRAP bool cv::ocl::Device::isExtensionSupported

(

const String &

extensionName

)

const

isIntel()

CV_WRAP bool cv::ocl::Device::isIntel ( ) const

inline

isNVidia()

CV_WRAP bool cv::ocl::Device::isNVidia ( ) const

inline

linkerAvailable()

CV_WRAP bool cv::ocl::Device::linkerAvailable

(

)

const

localMemSize()

CV_WRAP size_t cv::ocl::Device::localMemSize

(

)

const

localMemType()

CV_WRAP int cv::ocl::Device::localMemType

(

)

const

maxClockFrequency()

CV_WRAP int cv::ocl::Device::maxClockFrequency

(

)

const

maxComputeUnits()

CV_WRAP int cv::ocl::Device::maxComputeUnits

(

)

const

maxConstantArgs()

CV_WRAP int cv::ocl::Device::maxConstantArgs

(

)

const

maxConstantBufferSize()

CV_WRAP size_t cv::ocl::Device::maxConstantBufferSize

(

)

const

maxMemAllocSize()

CV_WRAP size_t cv::ocl::Device::maxMemAllocSize

(

)

const

maxParameterSize()

CV_WRAP size_t cv::ocl::Device::maxParameterSize

(

)

const

maxReadImageArgs()

CV_WRAP int cv::ocl::Device::maxReadImageArgs

(

)

const

maxSamplers()

CV_WRAP int cv::ocl::Device::maxSamplers

(

)

const

maxWorkGroupSize()

CV_WRAP size_t cv::ocl::Device::maxWorkGroupSize

(

)

const

maxWorkItemDims()

CV_WRAP int cv::ocl::Device::maxWorkItemDims

(

)

const

maxWorkItemSizes()

void cv::ocl::Device::maxWorkItemSizes

(

size_t *

)

const

maxWriteImageArgs()

CV_WRAP int cv::ocl::Device::maxWriteImageArgs

(

)

const

memBaseAddrAlign()

CV_WRAP int cv::ocl::Device::memBaseAddrAlign

(

)

const

name()

CV_WRAP String cv::ocl::Device::name

(

)

const

nativeVectorWidthChar()

CV_WRAP int cv::ocl::Device::nativeVectorWidthChar

(

)

const

nativeVectorWidthDouble()

CV_WRAP int cv::ocl::Device::nativeVectorWidthDouble

(

)

const

nativeVectorWidthFloat()

CV_WRAP int cv::ocl::Device::nativeVectorWidthFloat

(

)

const

nativeVectorWidthHalf()

CV_WRAP int cv::ocl::Device::nativeVectorWidthHalf

(

)

const

nativeVectorWidthInt()

CV_WRAP int cv::ocl::Device::nativeVectorWidthInt

(

)

const

nativeVectorWidthLong()

CV_WRAP int cv::ocl::Device::nativeVectorWidthLong

(

)

const

nativeVectorWidthShort()

CV_WRAP int cv::ocl::Device::nativeVectorWidthShort

(

)

const

OpenCL_C_Version()

CV_WRAP String cv::ocl::Device::OpenCL_C_Version

(

)

const

OpenCLVersion()

CV_WRAP String cv::ocl::Device::OpenCLVersion

(

)

const

operator=() [1/2]

Device & cv::ocl::Device::operator=

(

const Device &

d

)

operator=() [2/2]

Device & cv::ocl::Device::operator=

(

Device &&

d

)

preferredVectorWidthChar()

CV_WRAP int cv::ocl::Device::preferredVectorWidthChar

(

)

const

preferredVectorWidthDouble()

CV_WRAP int cv::ocl::Device::preferredVectorWidthDouble

(

)

const

preferredVectorWidthFloat()

CV_WRAP int cv::ocl::Device::preferredVectorWidthFloat

(

)

const

preferredVectorWidthHalf()

CV_WRAP int cv::ocl::Device::preferredVectorWidthHalf

(

)

const

preferredVectorWidthInt()

CV_WRAP int cv::ocl::Device::preferredVectorWidthInt

(

)

const

preferredVectorWidthLong()

CV_WRAP int cv::ocl::Device::preferredVectorWidthLong

(

)

const

preferredVectorWidthShort()

CV_WRAP int cv::ocl::Device::preferredVectorWidthShort

(

)

const

printfBufferSize()

CV_WRAP size_t cv::ocl::Device::printfBufferSize

(

)

const

profilingTimerResolution()

CV_WRAP size_t cv::ocl::Device::profilingTimerResolution

(

)

const

ptr()

void * cv::ocl::Device::ptr

(

)

const

set()

void cv::ocl::Device::set

(

void *

d

)

singleFPConfig()

CV_WRAP int cv::ocl::Device::singleFPConfig

(

)

const

type()

CV_WRAP int cv::ocl::Device::type

(

)

const

vendorID()

CV_WRAP int cv::ocl::Device::vendorID

(

)

const

vendorName()

CV_WRAP String cv::ocl::Device::vendorName

(

)

const

version()

CV_WRAP String cv::ocl::Device::version

(

)

const

Member Data Documentation

p

Impl* cv::ocl::Device::p

protected

---

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

• build/release/_deps/opencv-src/include/opencv4/opencv2/core/ocl.hpp