cv::ocl::Device Class Reference

#include <opencv2/core/ocl.hpp>

Public Types
enum	{   EXEC_KERNEL =(1 << 0) ,   EXEC_NATIVE_KERNEL =(1 << 1) }
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 }
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	{   NO_CACHE =0 ,   READ_ONLY_CACHE =1 ,   READ_WRITE_CACHE =2 }
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) }

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

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

Protected Attributes
Impl *	p

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
EXEC_KERNEL
EXEC_NATIVE_KERNEL

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

anonymous enum

anonymous enum

Enumerator
TYPE_DEFAULT
TYPE_CPU
TYPE_GPU
TYPE_ACCELERATOR
TYPE_DGPU
TYPE_IGPU
TYPE_ALL

anonymous enum

anonymous enum

Enumerator
NO_CACHE
READ_ONLY_CACHE
READ_WRITE_CACHE

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

Constructor & Destructor Documentation

Device() [1/4]

cv::ocl::Device::Device

(

)

Python:
	cv.ocl.Device(		) ->	<ocl_Device object>

Device() [2/4]

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

explicit

Python:
	cv.ocl.Device(		) ->	<ocl_Device object>

Device() [3/4]

cv::ocl::Device::Device

(

const Device &

d

)

Python:
	cv.ocl.Device(		) ->	<ocl_Device object>

Device() [4/4]

cv::ocl::Device::Device

(

Device &&

d

)

Python:
	cv.ocl.Device(		) ->	<ocl_Device object>

~Device()

cv::ocl::Device::~Device

(

)

Member Function Documentation

addressBits()

int cv::ocl::Device::addressBits

(

)

const

Python:
	cv.ocl.Device.addressBits(		) ->	retval

available()

bool cv::ocl::Device::available

(

)

const

Python:
	cv.ocl.Device.available(		) ->	retval

compilerAvailable()

bool cv::ocl::Device::compilerAvailable

(

)

const

Python:
	cv.ocl.Device.compilerAvailable(		) ->	retval

deviceVersionMajor()

int cv::ocl::Device::deviceVersionMajor

(

)

const

Python:
	cv.ocl.Device.deviceVersionMajor(		) ->	retval

deviceVersionMinor()

int cv::ocl::Device::deviceVersionMinor

(

)

const

Python:
	cv.ocl.Device.deviceVersionMinor(		) ->	retval

doubleFPConfig()

int cv::ocl::Device::doubleFPConfig

(

)

const

Python:
	cv.ocl.Device.doubleFPConfig(		) ->	retval

driverVersion()

String cv::ocl::Device::driverVersion

(

)

const

Python:
	cv.ocl.Device.driverVersion(		) ->	retval

empty()

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

inline

endianLittle()

bool cv::ocl::Device::endianLittle

(

)

const

Python:
	cv.ocl.Device.endianLittle(		) ->	retval

errorCorrectionSupport()

bool cv::ocl::Device::errorCorrectionSupport

(

)

const

Python:
	cv.ocl.Device.errorCorrectionSupport(		) ->	retval

executionCapabilities()

int cv::ocl::Device::executionCapabilities

(

)

const

Python:
	cv.ocl.Device.executionCapabilities(		) ->	retval

extensions()

String cv::ocl::Device::extensions

(

)

const

Python:
	cv.ocl.Device.extensions(		) ->	retval

fromHandle()

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()

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

static

Python:
	cv.ocl.Device.getDefault(		) ->	retval
	cv.ocl.Device_getDefault(		) ->	retval

getImpl()

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

inline

globalMemCacheLineSize()

int cv::ocl::Device::globalMemCacheLineSize

(

)

const

Python:
	cv.ocl.Device.globalMemCacheLineSize(		) ->	retval

globalMemCacheSize()

size_t cv::ocl::Device::globalMemCacheSize

(

)

const

Python:
	cv.ocl.Device.globalMemCacheSize(		) ->	retval

globalMemCacheType()

int cv::ocl::Device::globalMemCacheType

(

)

const

Python:
	cv.ocl.Device.globalMemCacheType(		) ->	retval

globalMemSize()

size_t cv::ocl::Device::globalMemSize

(

)

const

Python:
	cv.ocl.Device.globalMemSize(		) ->	retval

halfFPConfig()

int cv::ocl::Device::halfFPConfig

(

)

const

Python:
	cv.ocl.Device.halfFPConfig(		) ->	retval

hasFP16()

bool cv::ocl::Device::hasFP16

(

)

const

Python:
	cv.ocl.Device.hasFP16(		) ->	retval

true if 'cl_khr_fp16' extension is available

hasFP64()

bool cv::ocl::Device::hasFP64

(

)

const

Python:
	cv.ocl.Device.hasFP64(		) ->	retval

true if 'cl_khr_fp64' extension is available

hostUnifiedMemory()

bool cv::ocl::Device::hostUnifiedMemory

(

)

const

Python:
	cv.ocl.Device.hostUnifiedMemory(		) ->	retval

image2DMaxHeight()

size_t cv::ocl::Device::image2DMaxHeight

(

)

const

Python:
	cv.ocl.Device.image2DMaxHeight(		) ->	retval

image2DMaxWidth()

size_t cv::ocl::Device::image2DMaxWidth

(

)

const

Python:
	cv.ocl.Device.image2DMaxWidth(		) ->	retval

image3DMaxDepth()

size_t cv::ocl::Device::image3DMaxDepth

(

)

const

Python:
	cv.ocl.Device.image3DMaxDepth(		) ->	retval

image3DMaxHeight()

size_t cv::ocl::Device::image3DMaxHeight

(

)

const

Python:
	cv.ocl.Device.image3DMaxHeight(		) ->	retval

image3DMaxWidth()

size_t cv::ocl::Device::image3DMaxWidth

(

)

const

Python:
	cv.ocl.Device.image3DMaxWidth(		) ->	retval

imageBaseAddressAlignment()

uint cv::ocl::Device::imageBaseAddressAlignment

(

)

const

imageFromBufferSupport()

bool cv::ocl::Device::imageFromBufferSupport

(

)

const

Python:
	cv.ocl.Device.imageFromBufferSupport(		) ->	retval

imageMaxArraySize()

size_t cv::ocl::Device::imageMaxArraySize

(

)

const

Python:
	cv.ocl.Device.imageMaxArraySize(		) ->	retval

imageMaxBufferSize()

size_t cv::ocl::Device::imageMaxBufferSize

(

)

const

Python:
	cv.ocl.Device.imageMaxBufferSize(		) ->	retval

imagePitchAlignment()

uint cv::ocl::Device::imagePitchAlignment

(

)

const

imageSupport()

bool cv::ocl::Device::imageSupport

(

)

const

Python:
	cv.ocl.Device.imageSupport(		) ->	retval

intelSubgroupsSupport()

bool cv::ocl::Device::intelSubgroupsSupport

(

)

const

Python:
	cv.ocl.Device.intelSubgroupsSupport(		) ->	retval

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

isAMD()

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

inline

Python:
	cv.ocl.Device.isAMD(		) ->	retval

isExtensionSupported()

bool cv::ocl::Device::isExtensionSupported

(

const String &

extensionName

)

const

Python:
	cv.ocl.Device.isExtensionSupported(	extensionName	) ->	retval

isIntel()

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

inline

Python:
	cv.ocl.Device.isIntel(		) ->	retval

isNVidia()

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

inline

Python:
	cv.ocl.Device.isNVidia(		) ->	retval

linkerAvailable()

bool cv::ocl::Device::linkerAvailable

(

)

const

Python:
	cv.ocl.Device.linkerAvailable(		) ->	retval

localMemSize()

size_t cv::ocl::Device::localMemSize

(

)

const

Python:
	cv.ocl.Device.localMemSize(		) ->	retval

localMemType()

int cv::ocl::Device::localMemType

(

)

const

Python:
	cv.ocl.Device.localMemType(		) ->	retval

maxClockFrequency()

int cv::ocl::Device::maxClockFrequency

(

)

const

Python:
	cv.ocl.Device.maxClockFrequency(		) ->	retval

maxComputeUnits()

int cv::ocl::Device::maxComputeUnits

(

)

const

Python:
	cv.ocl.Device.maxComputeUnits(		) ->	retval

maxConstantArgs()

int cv::ocl::Device::maxConstantArgs

(

)

const

Python:
	cv.ocl.Device.maxConstantArgs(		) ->	retval

maxConstantBufferSize()

size_t cv::ocl::Device::maxConstantBufferSize

(

)

const

Python:
	cv.ocl.Device.maxConstantBufferSize(		) ->	retval

maxMemAllocSize()

size_t cv::ocl::Device::maxMemAllocSize

(

)

const

Python:
	cv.ocl.Device.maxMemAllocSize(		) ->	retval

maxParameterSize()

size_t cv::ocl::Device::maxParameterSize

(

)

const

Python:
	cv.ocl.Device.maxParameterSize(		) ->	retval

maxReadImageArgs()

int cv::ocl::Device::maxReadImageArgs

(

)

const

Python:
	cv.ocl.Device.maxReadImageArgs(		) ->	retval

maxSamplers()

int cv::ocl::Device::maxSamplers

(

)

const

Python:
	cv.ocl.Device.maxSamplers(		) ->	retval

maxWorkGroupSize()

size_t cv::ocl::Device::maxWorkGroupSize

(

)

const

Python:
	cv.ocl.Device.maxWorkGroupSize(		) ->	retval

maxWorkItemDims()

int cv::ocl::Device::maxWorkItemDims

(

)

const

Python:
	cv.ocl.Device.maxWorkItemDims(		) ->	retval

maxWorkItemSizes()

void cv::ocl::Device::maxWorkItemSizes

(

size_t *

)

const

maxWriteImageArgs()

int cv::ocl::Device::maxWriteImageArgs

(

)

const

Python:
	cv.ocl.Device.maxWriteImageArgs(		) ->	retval

memBaseAddrAlign()

int cv::ocl::Device::memBaseAddrAlign

(

)

const

Python:
	cv.ocl.Device.memBaseAddrAlign(		) ->	retval

name()

String cv::ocl::Device::name

(

)

const

Python:
	cv.ocl.Device.name(		) ->	retval

nativeVectorWidthChar()

int cv::ocl::Device::nativeVectorWidthChar

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthChar(		) ->	retval

nativeVectorWidthDouble()

int cv::ocl::Device::nativeVectorWidthDouble

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthDouble(		) ->	retval

nativeVectorWidthFloat()

int cv::ocl::Device::nativeVectorWidthFloat

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthFloat(		) ->	retval

nativeVectorWidthHalf()

int cv::ocl::Device::nativeVectorWidthHalf

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthHalf(		) ->	retval

nativeVectorWidthInt()

int cv::ocl::Device::nativeVectorWidthInt

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthInt(		) ->	retval

nativeVectorWidthLong()

int cv::ocl::Device::nativeVectorWidthLong

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthLong(		) ->	retval

nativeVectorWidthShort()

int cv::ocl::Device::nativeVectorWidthShort

(

)

const

Python:
	cv.ocl.Device.nativeVectorWidthShort(		) ->	retval

OpenCL_C_Version()

String cv::ocl::Device::OpenCL_C_Version

(

)

const

Python:
	cv.ocl.Device.OpenCL_C_Version(		) ->	retval

OpenCLVersion()

String cv::ocl::Device::OpenCLVersion

(

)

const

Python:
	cv.ocl.Device.OpenCLVersion(		) ->	retval

operator=() [1/2]

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

(

const Device &

d

)

operator=() [2/2]

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

(

Device &&

d

)

preferredVectorWidthChar()

int cv::ocl::Device::preferredVectorWidthChar

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthChar(		) ->	retval

preferredVectorWidthDouble()

int cv::ocl::Device::preferredVectorWidthDouble

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthDouble(		) ->	retval

preferredVectorWidthFloat()

int cv::ocl::Device::preferredVectorWidthFloat

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthFloat(		) ->	retval

preferredVectorWidthHalf()

int cv::ocl::Device::preferredVectorWidthHalf

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthHalf(		) ->	retval

preferredVectorWidthInt()

int cv::ocl::Device::preferredVectorWidthInt

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthInt(		) ->	retval

preferredVectorWidthLong()

int cv::ocl::Device::preferredVectorWidthLong

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthLong(		) ->	retval

preferredVectorWidthShort()

int cv::ocl::Device::preferredVectorWidthShort

(

)

const

Python:
	cv.ocl.Device.preferredVectorWidthShort(		) ->	retval

printfBufferSize()

size_t cv::ocl::Device::printfBufferSize

(

)

const

Python:
	cv.ocl.Device.printfBufferSize(		) ->	retval

profilingTimerResolution()

size_t cv::ocl::Device::profilingTimerResolution

(

)

const

Python:
	cv.ocl.Device.profilingTimerResolution(		) ->	retval

ptr()

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

(

)

const

set()

void cv::ocl::Device::set

(

void *

d

)

singleFPConfig()

int cv::ocl::Device::singleFPConfig

(

)

const

Python:
	cv.ocl.Device.singleFPConfig(		) ->	retval

type()

int cv::ocl::Device::type

(

)

const

Python:
	cv.ocl.Device.type(		) ->	retval

vendorID()

int cv::ocl::Device::vendorID

(

)

const

Python:
	cv.ocl.Device.vendorID(		) ->	retval

vendorName()

String cv::ocl::Device::vendorName

(

)

const

Python:
	cv.ocl.Device.vendorName(		) ->	retval

version()

String cv::ocl::Device::version

(

)

const

Python:
	cv.ocl.Device.version(		) ->	retval

Member Data Documentation

p

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

protected

---

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

• opencv2/core/ocl.hpp