DeviceInfo (JavaCPP Presets for OpenCV 4.3.0-1.5.3 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.opencv.opencv_core.DeviceInfo

All Implemented Interfaces:: AutoCloseable

@Namespace(value="cv::cuda")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class DeviceInfo
extends Pointer

\brief Class providing functionality for querying the specified GPU properties.

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ComputeModeDefault` enum cv::cuda::DeviceInfo::ComputeMode
`static int`	`ComputeModeExclusive` enum cv::cuda::DeviceInfo::ComputeMode
`static int`	`ComputeModeExclusiveProcess` enum cv::cuda::DeviceInfo::ComputeMode
`static int`	`ComputeModeProhibited` enum cv::cuda::DeviceInfo::ComputeMode

Fields inherited from class org.bytedeco.javacpp.Pointer
address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description
`DeviceInfo()` creates DeviceInfo object for the current GPU
`DeviceInfo(int device_id)` \brief The constructors.
`DeviceInfo(Pointer p)` Pointer cast constructor.

Method Summary

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

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ComputeModeDefault
```
public static final int ComputeModeDefault
```
    enum cv::cuda::DeviceInfo::ComputeMode
    
    See Also:
    
    Constant Field Values
  - ComputeModeExclusive
```
public static final int ComputeModeExclusive
```
    enum cv::cuda::DeviceInfo::ComputeMode
    
    See Also:
    
    Constant Field Values
  - ComputeModeProhibited
```
public static final int ComputeModeProhibited
```
    enum cv::cuda::DeviceInfo::ComputeMode
    
    See Also:
    
    Constant Field Values
  - ComputeModeExclusiveProcess
```
public static final int ComputeModeExclusiveProcess
```
    enum cv::cuda::DeviceInfo::ComputeMode
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DeviceInfo
```
public DeviceInfo(Pointer p)
```
    Pointer cast constructor. Invokes Pointer.Pointer(Pointer).
  - DeviceInfo
```
public DeviceInfo()
```
    creates DeviceInfo object for the current GPU
  - DeviceInfo
```
public DeviceInfo(int device_id)
```
    \brief 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.
- Method Detail
  - deviceID
```
public int deviceID()
```
    \brief Returns system index of the CUDA device starting with 0.
  - name
```
@Cast(value="const char*")
public BytePointer name()
```
    ASCII string identifying device
  - totalGlobalMem
```
@Cast(value="size_t")
public long totalGlobalMem()
```
    global memory available on device in bytes
  - sharedMemPerBlock
```
@Cast(value="size_t")
public long sharedMemPerBlock()
```
    shared memory available per block in bytes
  - regsPerBlock
```
public int regsPerBlock()
```
    32-bit registers available per block
  - warpSize
```
public int warpSize()
```
    warp size in threads
  - memPitch
```
@Cast(value="size_t")
public long memPitch()
```
    maximum pitch in bytes allowed by memory copies
  - maxThreadsPerBlock
```
public int maxThreadsPerBlock()
```
    maximum number of threads per block
  - maxThreadsDim
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxThreadsDim()
```
    maximum size of each dimension of a block
  - maxGridSize
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxGridSize()
```
    maximum size of each dimension of a grid
  - clockRate
```
public int clockRate()
```
    clock frequency in kilohertz
  - totalConstMem
```
@Cast(value="size_t")
public long totalConstMem()
```
    constant memory available on device in bytes
  - majorVersion
```
public int majorVersion()
```
    major compute capability
  - minorVersion
```
public int minorVersion()
```
    minor compute capability
  - textureAlignment
```
@Cast(value="size_t")
public long textureAlignment()
```
    alignment requirement for textures
  - texturePitchAlignment
```
@Cast(value="size_t")
public long texturePitchAlignment()
```
    pitch alignment requirement for texture references bound to pitched memory
  - multiProcessorCount
```
public int multiProcessorCount()
```
    number of multiprocessors on device
  - kernelExecTimeoutEnabled
```
@Cast(value="bool")
public boolean kernelExecTimeoutEnabled()
```
    specified whether there is a run time limit on kernels
  - integrated
```
@Cast(value="bool")
public boolean integrated()
```
    device is integrated as opposed to discrete
  - canMapHostMemory
```
@Cast(value="bool")
public boolean canMapHostMemory()
```
    device can map host memory with cudaHostAlloc/cudaHostGetDevicePointer
  - computeMode
```
@Cast(value="cv::cuda::DeviceInfo::ComputeMode")
public int computeMode()
```
    compute mode
  - maxTexture1D
```
public int maxTexture1D()
```
    maximum 1D texture size
  - maxTexture1DMipmap
```
public int maxTexture1DMipmap()
```
    maximum 1D mipmapped texture size
  - maxTexture1DLinear
```
public int maxTexture1DLinear()
```
    maximum size for 1D textures bound to linear memory
  - maxTexture2D
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxTexture2D()
```
    maximum 2D texture dimensions
  - maxTexture2DMipmap
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxTexture2DMipmap()
```
    maximum 2D mipmapped texture dimensions
  - maxTexture2DLinear
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxTexture2DLinear()
```
    maximum dimensions (width, height, pitch) for 2D textures bound to pitched memory
  - maxTexture2DGather
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxTexture2DGather()
```
    maximum 2D texture dimensions if texture gather operations have to be performed
  - maxTexture3D
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxTexture3D()
```
    maximum 3D texture dimensions
  - maxTextureCubemap
```
public int maxTextureCubemap()
```
    maximum Cubemap texture dimensions
  - maxTexture1DLayered
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxTexture1DLayered()
```
    maximum 1D layered texture dimensions
  - maxTexture2DLayered
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxTexture2DLayered()
```
    maximum 2D layered texture dimensions
  - maxTextureCubemapLayered
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxTextureCubemapLayered()
```
    maximum Cubemap layered texture dimensions
  - maxSurface1D
```
public int maxSurface1D()
```
    maximum 1D surface size
  - maxSurface2D
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxSurface2D()
```
    maximum 2D surface dimensions
  - maxSurface3D
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxSurface3D()
```
    maximum 3D surface dimensions
  - maxSurface1DLayered
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxSurface1DLayered()
```
    maximum 1D layered surface dimensions
  - maxSurface2DLayered
```
@ByVal
 @Cast(value="cv::Vec3i*")
public Point3i maxSurface2DLayered()
```
    maximum 2D layered surface dimensions
  - maxSurfaceCubemap
```
public int maxSurfaceCubemap()
```
    maximum Cubemap surface dimensions
  - maxSurfaceCubemapLayered
```
@ByVal
 @Cast(value="cv::Vec2i*")
public Point maxSurfaceCubemapLayered()
```
    maximum Cubemap layered surface dimensions
  - surfaceAlignment
```
@Cast(value="size_t")
public long surfaceAlignment()
```
    alignment requirements for surfaces
  - concurrentKernels
```
@Cast(value="bool")
public boolean concurrentKernels()
```
    device can possibly execute multiple kernels concurrently
  - ECCEnabled
```
@Cast(value="bool")
public boolean ECCEnabled()
```
    device has ECC support enabled
  - pciBusID
```
public int pciBusID()
```
    PCI bus ID of the device
  - pciDeviceID
```
public int pciDeviceID()
```
    PCI device ID of the device
  - pciDomainID
```
public int pciDomainID()
```
    PCI domain ID of the device
  - tccDriver
```
@Cast(value="bool")
public boolean tccDriver()
```
    true if device is a Tesla device using TCC driver, false otherwise
  - asyncEngineCount
```
public int asyncEngineCount()
```
    number of asynchronous engines
  - unifiedAddressing
```
@Cast(value="bool")
public boolean unifiedAddressing()
```
    device shares a unified address space with the host
  - memoryClockRate
```
public int memoryClockRate()
```
    peak memory clock frequency in kilohertz
  - memoryBusWidth
```
public int memoryBusWidth()
```
    global memory bus width in bits
  - l2CacheSize
```
public int l2CacheSize()
```
    size of L2 cache in bytes
  - maxThreadsPerMultiProcessor
```
public int maxThreadsPerMultiProcessor()
```
    maximum resident threads per multiprocessor
  - queryMemory
```
public void queryMemory(@Cast(value="size_t*") @ByRef
                        SizeTPointer totalMemory,
                        @Cast(value="size_t*") @ByRef
                        SizeTPointer freeMemory)
```
    gets free and total device memory
  - freeMemory
```
@Cast(value="size_t")
public long freeMemory()
```
  - totalMemory
```
@Cast(value="size_t")
public long totalMemory()
```
  - supports
```
@Cast(value="bool")
public boolean supports(@Cast(value="cv::cuda::FeatureSet")
                                            int feature_set)
```
    \brief 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
  - isCompatible
```
@Cast(value="bool")
public boolean isCompatible()
```
    \brief 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 .

Class DeviceInfo

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Field Detail

ComputeModeDefault

ComputeModeExclusive

ComputeModeProhibited

ComputeModeExclusiveProcess

Constructor Detail

DeviceInfo

DeviceInfo

DeviceInfo

Method Detail

deviceID

name

totalGlobalMem

sharedMemPerBlock

regsPerBlock

warpSize

memPitch

maxThreadsPerBlock

maxThreadsDim

maxGridSize

clockRate

totalConstMem

majorVersion

minorVersion

textureAlignment

texturePitchAlignment

multiProcessorCount

kernelExecTimeoutEnabled

integrated

canMapHostMemory

computeMode

maxTexture1D

maxTexture1DMipmap

maxTexture1DLinear

maxTexture2D

maxTexture2DMipmap

maxTexture2DLinear

maxTexture2DGather

maxTexture3D

maxTextureCubemap

maxTexture1DLayered

maxTexture2DLayered

maxTextureCubemapLayered

maxSurface1D

maxSurface2D

maxSurface3D

maxSurface1DLayered

maxSurface2DLayered

maxSurfaceCubemap

maxSurfaceCubemapLayered

surfaceAlignment

concurrentKernels

ECCEnabled

pciBusID

pciDeviceID

pciDomainID

tccDriver

asyncEngineCount

unifiedAddressing

memoryClockRate

memoryBusWidth

l2CacheSize

maxThreadsPerMultiProcessor

queryMemory

freeMemory

totalMemory

supports

isCompatible