cv::cuda::DeviceInfo Class Reference

Class providing functionality for querying the specified GPU properties. More...

#include <cuda.hpp>

Public Types
enum	ComputeMode { ComputeModeDefault , ComputeModeExclusive , ComputeModeProhibited , ComputeModeExclusiveProcess }

Public Member Functions
CV_WRAP	DeviceInfo ()
	creates DeviceInfo object for the current GPU
CV_WRAP	DeviceInfo (int device_id)
	The constructors.
CV_WRAP int	deviceID () const
	Returns system index of the CUDA device starting with 0.
const char *	name () const
	ASCII string identifying device.
CV_WRAP size_t	totalGlobalMem () const
	global memory available on device in bytes
CV_WRAP size_t	sharedMemPerBlock () const
	shared memory available per block in bytes
CV_WRAP int	regsPerBlock () const
	32-bit registers available per block
CV_WRAP int	warpSize () const
	warp size in threads
CV_WRAP size_t	memPitch () const
	maximum pitch in bytes allowed by memory copies
CV_WRAP int	maxThreadsPerBlock () const
	maximum number of threads per block
CV_WRAP Vec3i	maxThreadsDim () const
	maximum size of each dimension of a block
CV_WRAP Vec3i	maxGridSize () const
	maximum size of each dimension of a grid
CV_WRAP int	clockRate () const
	clock frequency in kilohertz
CV_WRAP size_t	totalConstMem () const
	constant memory available on device in bytes
CV_WRAP int	majorVersion () const
	major compute capability
CV_WRAP int	minorVersion () const
	minor compute capability
CV_WRAP size_t	textureAlignment () const
	alignment requirement for textures
CV_WRAP size_t	texturePitchAlignment () const
	pitch alignment requirement for texture references bound to pitched memory
CV_WRAP int	multiProcessorCount () const
	number of multiprocessors on device
CV_WRAP bool	kernelExecTimeoutEnabled () const
	specified whether there is a run time limit on kernels
CV_WRAP bool	integrated () const
	device is integrated as opposed to discrete
CV_WRAP bool	canMapHostMemory () const
	device can map host memory with cudaHostAlloc/cudaHostGetDevicePointer
CV_WRAP DeviceInfo::ComputeMode	computeMode () const
	compute mode
CV_WRAP int	maxTexture1D () const
	maximum 1D texture size
CV_WRAP int	maxTexture1DMipmap () const
	maximum 1D mipmapped texture size
CV_WRAP int	maxTexture1DLinear () const
	maximum size for 1D textures bound to linear memory
CV_WRAP Vec2i	maxTexture2D () const
	maximum 2D texture dimensions
CV_WRAP Vec2i	maxTexture2DMipmap () const
	maximum 2D mipmapped texture dimensions
CV_WRAP Vec3i	maxTexture2DLinear () const
	maximum dimensions (width, height, pitch) for 2D textures bound to pitched memory
CV_WRAP Vec2i	maxTexture2DGather () const
	maximum 2D texture dimensions if texture gather operations have to be performed
CV_WRAP Vec3i	maxTexture3D () const
	maximum 3D texture dimensions
CV_WRAP int	maxTextureCubemap () const
	maximum Cubemap texture dimensions
CV_WRAP Vec2i	maxTexture1DLayered () const
	maximum 1D layered texture dimensions
CV_WRAP Vec3i	maxTexture2DLayered () const
	maximum 2D layered texture dimensions
CV_WRAP Vec2i	maxTextureCubemapLayered () const
	maximum Cubemap layered texture dimensions
CV_WRAP int	maxSurface1D () const
	maximum 1D surface size
CV_WRAP Vec2i	maxSurface2D () const
	maximum 2D surface dimensions
CV_WRAP Vec3i	maxSurface3D () const
	maximum 3D surface dimensions
CV_WRAP Vec2i	maxSurface1DLayered () const
	maximum 1D layered surface dimensions
CV_WRAP Vec3i	maxSurface2DLayered () const
	maximum 2D layered surface dimensions
CV_WRAP int	maxSurfaceCubemap () const
	maximum Cubemap surface dimensions
CV_WRAP Vec2i	maxSurfaceCubemapLayered () const
	maximum Cubemap layered surface dimensions
CV_WRAP size_t	surfaceAlignment () const
	alignment requirements for surfaces
CV_WRAP bool	concurrentKernels () const
	device can possibly execute multiple kernels concurrently
CV_WRAP bool	ECCEnabled () const
	device has ECC support enabled
CV_WRAP int	pciBusID () const
	PCI bus ID of the device.
CV_WRAP int	pciDeviceID () const
	PCI device ID of the device.
CV_WRAP int	pciDomainID () const
	PCI domain ID of the device.
CV_WRAP bool	tccDriver () const
	true if device is a Tesla device using TCC driver, false otherwise
CV_WRAP int	asyncEngineCount () const
	number of asynchronous engines
CV_WRAP bool	unifiedAddressing () const
	device shares a unified address space with the host
CV_WRAP int	memoryClockRate () const
	peak memory clock frequency in kilohertz
CV_WRAP int	memoryBusWidth () const
	global memory bus width in bits
CV_WRAP int	l2CacheSize () const
	size of L2 cache in bytes
CV_WRAP int	maxThreadsPerMultiProcessor () const
	maximum resident threads per multiprocessor
CV_WRAP void	queryMemory (size_t &totalMemory, size_t &freeMemory) const
	gets free and total device memory
CV_WRAP size_t	freeMemory () const
CV_WRAP size_t	totalMemory () const
bool	supports (FeatureSet feature_set) const
	Provides information on CUDA feature support.
CV_WRAP bool	isCompatible () const
	Checks the CUDA module and device compatibility.

Detailed Description

Class providing functionality for querying the specified GPU properties.

Member Enumeration Documentation

ComputeMode

enum cv::cuda::DeviceInfo::ComputeMode

Enumerator
ComputeModeDefault	default compute mode (Multiple threads can use cudaSetDevice with this device)
ComputeModeExclusive	compute-exclusive-thread mode (Only one thread in one process will be able to use cudaSetDevice with this device)
ComputeModeProhibited	compute-prohibited mode (No threads can use cudaSetDevice with this device)
ComputeModeExclusiveProcess	compute-exclusive-process mode (Many threads in one process will be able to use cudaSetDevice with this device)

Constructor & Destructor Documentation

DeviceInfo() [1/2]

CV_WRAP cv::cuda::DeviceInfo::DeviceInfo

(

)

creates DeviceInfo object for the current GPU

DeviceInfo() [2/2]

CV_WRAP cv::cuda::DeviceInfo::DeviceInfo

(

int

device_id

)

The constructors.

Parameters

device_id

System index of the CUDA device starting with 0.

Constructs the DeviceInfo object for the specified device. If device_id parameter is missed, it constructs an object for the current device.

Member Function Documentation

asyncEngineCount()

CV_WRAP int cv::cuda::DeviceInfo::asyncEngineCount

(

)

const

number of asynchronous engines

canMapHostMemory()

CV_WRAP bool cv::cuda::DeviceInfo::canMapHostMemory

(

)

const

device can map host memory with cudaHostAlloc/cudaHostGetDevicePointer

clockRate()

CV_WRAP int cv::cuda::DeviceInfo::clockRate

(

)

const

clock frequency in kilohertz

computeMode()

CV_WRAP DeviceInfo::ComputeMode cv::cuda::DeviceInfo::computeMode

(

)

const

compute mode

concurrentKernels()

CV_WRAP bool cv::cuda::DeviceInfo::concurrentKernels

(

)

const

device can possibly execute multiple kernels concurrently

deviceID()

CV_WRAP int cv::cuda::DeviceInfo::deviceID

(

)

const

Returns system index of the CUDA device starting with 0.

ECCEnabled()

CV_WRAP bool cv::cuda::DeviceInfo::ECCEnabled

(

)

const

device has ECC support enabled

freeMemory()

CV_WRAP size_t cv::cuda::DeviceInfo::freeMemory

(

)

const

integrated()

CV_WRAP bool cv::cuda::DeviceInfo::integrated

(

)

const

device is integrated as opposed to discrete

isCompatible()

CV_WRAP bool cv::cuda::DeviceInfo::isCompatible

(

)

const

Checks the CUDA module and device compatibility.

This function returns true if the CUDA module can be run on the specified device. Otherwise, it returns false .

kernelExecTimeoutEnabled()

CV_WRAP bool cv::cuda::DeviceInfo::kernelExecTimeoutEnabled

(

)

const

specified whether there is a run time limit on kernels

l2CacheSize()

CV_WRAP int cv::cuda::DeviceInfo::l2CacheSize

(

)

const

size of L2 cache in bytes

majorVersion()

CV_WRAP int cv::cuda::DeviceInfo::majorVersion

(

)

const

major compute capability

maxGridSize()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxGridSize

(

)

const

maximum size of each dimension of a grid

maxSurface1D()

CV_WRAP int cv::cuda::DeviceInfo::maxSurface1D

(

)

const

maximum 1D surface size

maxSurface1DLayered()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxSurface1DLayered

(

)

const

maximum 1D layered surface dimensions

maxSurface2D()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxSurface2D

(

)

const

maximum 2D surface dimensions

maxSurface2DLayered()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxSurface2DLayered

(

)

const

maximum 2D layered surface dimensions

maxSurface3D()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxSurface3D

(

)

const

maximum 3D surface dimensions

maxSurfaceCubemap()

CV_WRAP int cv::cuda::DeviceInfo::maxSurfaceCubemap

(

)

const

maximum Cubemap surface dimensions

maxSurfaceCubemapLayered()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxSurfaceCubemapLayered

(

)

const

maximum Cubemap layered surface dimensions

maxTexture1D()

CV_WRAP int cv::cuda::DeviceInfo::maxTexture1D

(

)

const

maximum 1D texture size

maxTexture1DLayered()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxTexture1DLayered

(

)

const

maximum 1D layered texture dimensions

maxTexture1DLinear()

CV_WRAP int cv::cuda::DeviceInfo::maxTexture1DLinear

(

)

const

maximum size for 1D textures bound to linear memory

maxTexture1DMipmap()

CV_WRAP int cv::cuda::DeviceInfo::maxTexture1DMipmap

(

)

const

maximum 1D mipmapped texture size

maxTexture2D()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxTexture2D

(

)

const

maximum 2D texture dimensions

maxTexture2DGather()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxTexture2DGather

(

)

const

maximum 2D texture dimensions if texture gather operations have to be performed

maxTexture2DLayered()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxTexture2DLayered

(

)

const

maximum 2D layered texture dimensions

maxTexture2DLinear()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxTexture2DLinear

(

)

const

maximum dimensions (width, height, pitch) for 2D textures bound to pitched memory

maxTexture2DMipmap()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxTexture2DMipmap

(

)

const

maximum 2D mipmapped texture dimensions

maxTexture3D()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxTexture3D

(

)

const

maximum 3D texture dimensions

maxTextureCubemap()

CV_WRAP int cv::cuda::DeviceInfo::maxTextureCubemap

(

)

const

maximum Cubemap texture dimensions

maxTextureCubemapLayered()

CV_WRAP Vec2i cv::cuda::DeviceInfo::maxTextureCubemapLayered

(

)

const

maximum Cubemap layered texture dimensions

maxThreadsDim()

CV_WRAP Vec3i cv::cuda::DeviceInfo::maxThreadsDim

(

)

const

maximum size of each dimension of a block

maxThreadsPerBlock()

CV_WRAP int cv::cuda::DeviceInfo::maxThreadsPerBlock

(

)

const

maximum number of threads per block

maxThreadsPerMultiProcessor()

CV_WRAP int cv::cuda::DeviceInfo::maxThreadsPerMultiProcessor

(

)

const

maximum resident threads per multiprocessor

memoryBusWidth()

CV_WRAP int cv::cuda::DeviceInfo::memoryBusWidth

(

)

const

global memory bus width in bits

memoryClockRate()

CV_WRAP int cv::cuda::DeviceInfo::memoryClockRate

(

)

const

peak memory clock frequency in kilohertz

memPitch()

CV_WRAP size_t cv::cuda::DeviceInfo::memPitch

(

)

const

maximum pitch in bytes allowed by memory copies

minorVersion()

CV_WRAP int cv::cuda::DeviceInfo::minorVersion

(

)

const

minor compute capability

multiProcessorCount()

CV_WRAP int cv::cuda::DeviceInfo::multiProcessorCount

(

)

const

number of multiprocessors on device

name()

const char * cv::cuda::DeviceInfo::name

(

)

const

ASCII string identifying device.

pciBusID()

CV_WRAP int cv::cuda::DeviceInfo::pciBusID

(

)

const

PCI bus ID of the device.

pciDeviceID()

CV_WRAP int cv::cuda::DeviceInfo::pciDeviceID

(

)

const

PCI device ID of the device.

pciDomainID()

CV_WRAP int cv::cuda::DeviceInfo::pciDomainID

(

)

const

PCI domain ID of the device.

queryMemory()

CV_WRAP void cv::cuda::DeviceInfo::queryMemory	(	size_t &	totalMemory,
		size_t &	freeMemory
	)		const

gets free and total device memory

regsPerBlock()

CV_WRAP int cv::cuda::DeviceInfo::regsPerBlock

(

)

const

32-bit registers available per block

sharedMemPerBlock()

CV_WRAP size_t cv::cuda::DeviceInfo::sharedMemPerBlock

(

)

const

shared memory available per block in bytes

supports()

bool cv::cuda::DeviceInfo::supports

(

FeatureSet

feature_set

)

const

Provides information on CUDA feature support.

Parameters

feature_set

Features to be checked. See cuda::FeatureSet.

This function returns true if the device has the specified CUDA feature. Otherwise, it returns false

surfaceAlignment()

CV_WRAP size_t cv::cuda::DeviceInfo::surfaceAlignment

(

)

const

alignment requirements for surfaces

tccDriver()

CV_WRAP bool cv::cuda::DeviceInfo::tccDriver

(

)

const

true if device is a Tesla device using TCC driver, false otherwise

textureAlignment()

CV_WRAP size_t cv::cuda::DeviceInfo::textureAlignment

(

)

const

alignment requirement for textures

texturePitchAlignment()

CV_WRAP size_t cv::cuda::DeviceInfo::texturePitchAlignment

(

)

const

pitch alignment requirement for texture references bound to pitched memory

totalConstMem()

CV_WRAP size_t cv::cuda::DeviceInfo::totalConstMem

(

)

const

constant memory available on device in bytes

totalGlobalMem()

CV_WRAP size_t cv::cuda::DeviceInfo::totalGlobalMem

(

)

const

global memory available on device in bytes

totalMemory()

CV_WRAP size_t cv::cuda::DeviceInfo::totalMemory

(

)

const

unifiedAddressing()

CV_WRAP bool cv::cuda::DeviceInfo::unifiedAddressing

(

)

const

device shares a unified address space with the host

warpSize()

CV_WRAP int cv::cuda::DeviceInfo::warpSize

(

)

const

warp size in threads

---

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

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