NVIDIA CUDA Compute Unified Device Architecture

Reference Manual

Version 2.0
June 2008

Contents
1 RuntimeApiReference 1.1 DeviceManagement RT 1.1.1 1.1.2 1.1.3 1.1.4 1.1.5 1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 3 4 5 6 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

cudaGetDeviceCount

cudaSetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGetDeviceProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaChooseDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ThreadManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.1 1.2.2 cudaThreadSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaThreadExit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3

StreamManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.1 1.3.2 1.3.3 1.3.4 cudaStreamCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.4

EventManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.4.6 cudaEventCreate cudaEventRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaEventQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaEventSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaEventDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaEventElapsedTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5

MemoryManagement RT 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9

cudaMalloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMallocPitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaFree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaMallocArray

cudaFreeArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMallocHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaFreeHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaMemset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMemset2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

i

1.5.10 cudaMemcpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.11 cudaMemcpy2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34 35 36 37 38 39 40 41 42 43 44 45 46 48 50 52 54 55 63 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

1.5.12 cudaMemcpyToArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.13 cudaMemcpy2DToArray 1.5.14 cudaMemcpyFromArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5.15 cudaMemcpy2DFromArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.16 cudaMemcpyArrayToArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.17 cudaMemcpy2DArrayToArray 1.5.18 cudaMemcpyToSymbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5.19 cudaMemcpyFromSymbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.20 cudaGetSymbolAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.21 cudaGetSymbolSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.22 cudaMalloc3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.23 cudaMalloc3DArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.24 cudaMemset3D 1.5.25 cudaMemcpy3D 1.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TextureReferenceManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.1 1.6.2 LowLevelApi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HighLevelApi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.7

ExecutionControl RT 1.7.1 1.7.2 1.7.3

cudaConfigureCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaSetupArgument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.8

OpenGlInteroperability RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8.1 1.8.2 1.8.3 1.8.4 1.8.5 cudaGLSetGLDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaGLRegisterBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGLMapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGLUnmapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaGLUnregisterBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9

Direct3dInteroperability RT 1.9.1 1.9.2 1.9.3 1.9.4 cudaD3D9GetDevice

cudaD3D9SetDirect3DDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9GetDirect3DDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaD3D9RegisterResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

1.9.5 1.9.6 1.9.7 1.9.8 1.9.9

cudaD3D9UnregisterResource cudaD3D9MapResources

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84 85 86 87 89 90 91 92 94 95 97 98 99

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaD3D9UnmapResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9ResourceSetMapFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9ResourceGetSurfaceDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9.10 cudaD3D9ResourceGetMappedPointer 1.9.11 cudaD3D9ResourceGetMappedSize

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9.12 cudaD3D9ResourceGetMappedPitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10 ErrorHandling RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10.1 cudaGetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10.2 cudaGetErrorString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 DriverApiReference 2.1 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.1 2.2

cuInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

DeviceManagement 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7

cuDeviceComputeCapability

cuDeviceGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 cuDeviceGetAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 cuDeviceGetCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 cuDeviceGetName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 cuDeviceGetProperties cuDeviceTotalMem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

2.3

ContextManagement 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

cuCtxAttach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 cuCtxCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 cuCtxDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

cuCtxDetach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 cuCtxGetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 cuCtxPopCurrent cuCtxPushCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

cuCtxSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

2.4

ModuleManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 2.4.1 cuModuleGetFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

iii

. . . . .7 ExecutionControl 2. . . . . . . . . . . . . . . . .6 cuEventCreate . . . . . . . . . . . . . . . . . . . . . . .1 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 2. . . . 142 cuLaunchGrid cuParamSetSize .7. . . . .4. . . . . . . . . . . . . . . . . . . . . . 130 . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 cuArrayGetDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . .6. . . . . . . . . . . . . . . 154 . . . . . . . . . . . 133 cuStreamSynchronize 2. . .6.4 2. . . . . . . . . 139 cuEventSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . 134 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 cuEventDestroy . . . . . . . . . . . . . . . . . .7. . . . . . . .9 cuLaunch . . . . . . . . . . . . .7 2. . .8. . . . . . . . . 157 cuArray3DGetDescriptor . . . . . .2 2. . . . . . . . .6 2. . . . . . . . . . . . . . . . . . . .3 2. . . . . . . 147 cuParamSetv . . . . . . . . . . . . . . . .2 2. . . . . . . . .4 cuStreamCreate cuStreamDestroy cuStreamQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 2.6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7. . . . . . . .7. . .8. . . . . . . . . . 136 . . . . . . . . . . . . . . . . . . .7 2. . . . 137 cuEventElapsedTime cuEventQuery . . . . . . . . . . . 128 StreamManagement . . . . . . . . . . . . . . . . . . . . . . . .7. . . . . . . .7. . . . . . . . . . 125 cuModuleLoadData . . . . . . . . . . 148 cuFuncSetBlockShape . . 132 . . . . 124 cuModuleLoad . . . . . . . . . . .2 2. . . . . . . .4. . . . . . . . . . . 129 2. .8. . . . . . . . . . 149 cuFuncSetSharedSize . . . . . . . . .7. .5. . . . . . . . . . . 138 cuEventRecord . . . .4 2. . 123 cuModuleGetTexRef . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . 146 cuParamSeti . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5. . . . . . . . . . . . . . . . . . . .6 2. . . . . . .6. . . . . . . . . . . . . . . . . 152 cuArray3DCreate cuArrayDestroy . . . . . 126 cuModuleLoadFatBinary . . . . . . . . . . . . . . . . . . . . . 144 . . . . . . . . . . . . . . . . . . . .1 2. . . . . .5 2. .6. . . . . . . . . . . . . . . . . . . . . . 158 iv . . . . . . . . . . . . . . . . . . .3 2. . . . 150 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . 145 cuParamSetTexRef cuParamSetf . . . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . .2 2. . . . . . . . . . . . . . .3 2. . . . . . . . . . .8 MemoryManagement 2. . . . . . . . . . . . . . . . . . .6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5. . . . . . . . . . . . .5 2. . . . .7. . . . . . . . . . . . . . . . . . . .4 2. . . . .5 2. . . 140 .7. . . . . . . . . . . . . . . . . . . .1 2. . . .6 EventManagement . . .8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 . . . . . . . . .5 cuModuleGetGlobal . . . . . . . . . . . . . . . . . . . . . . . . . . 127 cuModuleUnload . . . . . . . . .4. . . . . . . . . .5. . . . . . . .3 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 2. . . . . 151 cuArrayCreate . . . . . . . . . . .1 2. . . . . . .3 2.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 2. . . . . . . . . . . 143 . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .7 2. . . .23 cuMemset . . .11 cuMemGetAddressRange . . . . . .18 cuMemcpyDtoA . . . . . 187 cuTexRefGetAddress cuTexRefGetAddressMode cuTexRefGetArray . . . . . . 161 cuMemAllocHost cuMemAllocPitch cuMemFree . .21 cuMemcpyHtoA . . . . . . . . . . . . .8. . .8. . . . . . . . . . .8. . . . . . . . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . 186 . . . . . . . . 195 2. . . . . . . . .8. . . . . . .9. . . . . . 188 . . . . . . . . . . . .8. . . . . . . .9. 191 cuTexRefSetAddress . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 cuTexRefGetFormat . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . 181 2. . . .20 cuMemcpyDtoH . . . .8. . . . .8. . . . . 173 2. . . . . . . . . .4 2. . . . . . . . . .13 cuMemcpy2D 2. . . . . . .24 cuMemset2D . . . . . . . 194 2. . . . . . . . . 197 v . .16 cuMemcpyAtoD . . . . . . . . . . .8. .7 2. . . . . . . . . . . . . . . . . 165 2. . . .8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 2. . . . . . . . . . . . . . . . . . . . . . . . . . .2 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 cuMemcpyHtoD . . . . . . . . . . . . . . . 185 . . . . 174 2. 176 2. . . . . . . . . . . .8. .8. . . . . . . . . . . . . . .8. . . . . 189 cuTexRefGetFilterMode cuTexRefGetFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 cuMemFreeHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. . 170 2. . .17 cuMemcpyAtoH . . . . . . . . . . . . . . .14 cuMemcpy3D . . . . . . .8. . . . . . . . . . . . . . .8 2. . .8. . . . .9 TextureReferenceManagement 2. .9. . . .19 cuMemcpyDtoD . . . . . . . . . . 180 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 cuTexRefSetArray . . . . 192 . . . . . . . . . . . . . . . . . . . .6 2. . . . . . . . . . 159 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . . . . . .12 cuMemGetInfo . . . . . . . . . . . . . 179 2. . . . . . . . . . .10 cuTexRefSetAddressMode 2. . .8. . . . 175 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 2. . . . .8. . . . . . . 160 . . .2. . . . . . . . . . . . . . . .14 cuTexRefSetFormat . . . 196 2. . . . .9. .9. . . . . . . . . .9. . . . . . . . . . . .6 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . .13 cuTexRefSetFlags . . . . . . . . . . . . . . . . . 184 . . . . . . . .9. . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . 167 . . . . . . . . . . . 166 2. . . . . . . .9 cuTexRefCreate cuTexRefDestroy . . . 164 2.9 cuMemAlloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 cuTexRefSetFilterMode . . . . . . . . . . . . . . . . . . 178 2. . . . . . . . . . . . . . . . . . . . . 182 2. . . . . . . . . . . . . . . .8. . . . . . . . . . . . . 183 . . . . . . 193 2. . . . . . . . . . . . . . . .15 cuMemcpyAtoA . . . . . . . . . .5 2. . . .8 2. . . .

. . . 214 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 atomicAnd . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . .5 cuGLUnmapBufferObject . . . . . . . . .1 cuGLCtxCreate . . . . . . . . . . . . . . . 223 3. . . . . . . .11. . . . . . . . .11 Direct3dInteroperability . . . . . . 212 2. . . . . . . . . 199 2. . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . . . 234 vi . . . . . . . . .2 BitwiseFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11. 232 3. . . . . 204 2. . .1 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 cuGLUnregisterBufferObject . . . 224 atomicSub atomicExch atomicMin . . . . . . .11. . . . . . . 216 2. . . . 225 . . . 231 3. . . . .11. 207 2. . . . . . . . .4 cuD3D9RegisterResource . . . . . . . . . . . . 233 atomicOr . 198 2. . . . . . . . . .10. . . . . . . . . . . . . . . . . . . . . . . . .2 cuGLInit . . . . .11. . . . . . . . . . . . . . . . . . . . . . . . 209 2.12 cuD3D9ResourceGetMappedPitch . . . . . .11. . . . . . . . . . . . . . . . .3 cuGLMapBufferObject . . . . . . . . . . . . . . . . . . . . . . . .7 cuD3D9UnmapResources . . . .2. . . . . . . . .9 cuD3D9ResourceGetSurfaceDimensions . . . . . . . . .10 cuD3D9ResourceGetMappedPointer . . . 220 3 AtomicFunctions 3. . . .10. . . . . . . . . . . .11. . . . . . . . . . . . . .10. . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 . . . . . . . . .11. . . 230 atomicCAS . . . . .6 cuD3D9MapResources . . . . . . . . . . . . . . .11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 2. . . . . . . . .1. . . . . .1 222 ArithmeticFunctions . . . . . .1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. 203 2. . . . 217 2.1. . . . . . . . .3 cuD3D9GetDirect3DDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11. . . . . . . . . .7 3.1. . . . . . . . . . . . . . . . . . . .8 atomicAdd . . . . . . . . . . . . . . . . 200 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 2. . . . . . . . . . . . . . . . . . . . . 226 . . . . . . . . . . . . . . . 228 atomicInc . . . . . . .10. . . . . . . . . . . . . . . .2 3. . . . . . . . . . . . . . . . . . .3 3. . . . . . . . . . . . . . . . . . . . . . . 219 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 OpenGlInteroperability . . . . . . . . 206 2. . . . .11. . . . . . . . . . . .11. . . . . . .2 cuD3D9CtxCreate .6 3. . . . . . . . . . . .2. . . . . . . . .1 cuD3D9GetDevice . . . . . . . . . . . . . . . . . . . . . . . .5 3. . . . . . . . . . . . . . . . . . . . . .10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 2. . . . . . . . . . . . . . . . 202 2. . 229 atomicDec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . .4 cuGLRegisterBufferObject 2. . . . . . .10. . . . . . . . . .11 cuD3D9ResourceGetMappedSize . . . . . . . . 227 atomicMax . . . . . . . . . . . . . . . . . .8 cuD3D9ResourceSetMapFlags . . . . . . . . . . . . . . . . . . . .1 3. . . 211 2. . . . . . . . . . . . . . .5 cuD3D9UnregisterResource .

. . . . .3 atomicXor . . . . 235 vii .2. . . . . . . . . . . . . . . . . . . .3. . . . . . . . . . . . . . .

using overloading.h) is a C-style interface that does not require compiling with nvcc. SEE ALSO Device Management.h) is a C++-style interface built on top of the low-level API. references and default arguments. OpenGL Interoperability. Execution Management. the execution configuration syntax to invoke kernels is only available in source code compiled with nvcc.1 RuntimeApiReference NAME Runtime API Reference DESCRIPTION There are two levels for the runtime API. The high-level API also has some CUDA-specific wrappers that wrap low-level routines that deal with symbols. Memory Management. It wraps some of the low level API routines. Event Management. These wrappers can be used from C++ code and can be compiled with any C++ compiler. For example. and device functions. textures. The low-level API (cuda_runtime_api. Texture Reference Management. These wrappers require the use of nvcc because they depend on code being generated by the compiler. Stream Management. Thread Management. Direct3D Interoperability. Error Handling 1 . The high-level API (cuda_runtime.

Texture Reference Management. Memory Management. OpenGL Interoperability. Event Management. Error Handling 2 . Execution Management. Thread Management. Stream Management. cudaGetDeviceCount cudaSetDevice cudaGetDevice cudaGetDeviceProperties cudaChooseDevice SEE ALSO Device Management. Direct3D Interoperability.1.1 DeviceManagement RT NAME Device Management DESCRIPTION This section describes the CUDA runtime application programming interface.

cudaGetDeviceProperties. cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode. Since this device will be able to emulate all hardware features.0 that are available for execution. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. SEE ALSO cudaGetDevice. If there is no such device.returns the number of compute-capable devices SYNOPSIS cudaError_t cudaGetDeviceCount( int* count ) DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. asynchronous launches. cudaChooseDevice 3 .1 cudaGetDeviceCount NAME cudaGetDeviceCount .1.1. cudaSetDevice. this device will report major and minor compute capability versions of 9999.

1.2 cudaSetDevice NAME cudaSetDevice . asynchronous launches. cudaGetDevice. SEE ALSO cudaGetDeviceCount.sets device to be used for GPU executions SYNOPSIS cudaError_t cudaSetDevice( int dev ) DESCRIPTION Records dev as the device on which the active host thread executes the device code. cudaChooseDevice 4 . cudaGetDeviceProperties.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous.

RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. cudaGetDeviceProperties.1. asynchronous launches. cudaChooseDevice 5 . cudaSetDevice.3 cudaGetDevice NAME cudaGetDevice .returns which device is currently being used SYNOPSIS cudaError_t cudaGetDevice( int* dev ) DESCRIPTION Returns in *dev the device on which the active host thread executes the device code.1. SEE ALSO cudaGetDeviceCount.

The cudaDeviceProp structure is defined as: struct cudaDeviceProp { char name[256].1. int multiProcessorCount. int regsPerBlock. this number is shared by all thread blocks simultaneously resident on a multiprocessor. int major. int deviceOverlap. int warpSize.4 cudaGetDeviceProperties NAME cudaGetDeviceProperties . int minor. 6 . sharedMemPerBlock is the maximum amount of shared memory available to a thread block in bytes. size_t textureAlignment. regsPerBlock is the maximum number of 32-bit registers available to a thread block. totalGlobalMem is the total amount of global memory available on the device in bytes. size_t sharedMemPerBlock. size_t totalConstMem. int maxGridSize[3]. this amount is shared by all thread blocks simultaneously resident on a multiprocessor. size_t memPitch. int clockRate. } where: name is an ASCII string identifying the device. int dev ) DESCRIPTION Returns in *prop the properties of device dev. int maxThreadsDim[3].returns information on the compute-device SYNOPSIS cudaError_t cudaGetDeviceProperties( struct cudaDeviceProp* prop. size_t totalGlobalMem. warpSize is the warp size in threads. int maxThreadsPerBlock.1.

maxGridSize[3] is the maximum sizes of each dimension of a grid. texture base addresses that are aligned to textureAlignment bytes do not need an offset applied to texture fetches. cudaChooseDevice 7 . or 0 if not. clockRate is the clock frequency in kilohertz. cudaGetDevice. textureAlignment is the alignment requirement. cudaSetDevice.memPitch is the maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cudaMallocPitch(). major. multiProcessorCount is the number of multiprocessors on the device. minor are the major and minor revision numbers defining the device’s compute capability. deviceOverlap is 1 if the device can concurrently copy memory between host and device while executing a kernel. maxThreadsDim[3] is the maximum sizes of each dimension of a block. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. totalConstMem is the total amount of constant memory available on the device in bytes. SEE ALSO cudaGetDeviceCount. maxThreadsPerBlock is the maximum number of threads per block. asynchronous launches.

const struct cudaDeviceProp* prop ) DESCRIPTION Returns in *dev the device which properties best match *prop.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaGetDevice. asynchronous launches.select compute-device which best matches criteria SYNOPSIS cudaError_t cudaChooseDevice( int* dev.5 cudaChooseDevice NAME cudaChooseDevice . cudaGetDeviceProperties 8 . cudaSetDevice. SEE ALSO cudaGetDeviceCount.1.

Event Management. Error Handling 9 . Stream Management. Execution Management. Thread Management. Memory Management. cudaThreadSynchronize cudaThreadExit SEE ALSO Device Management.1. Direct3D Interoperability. Texture Reference Management. OpenGL Interoperability.2 ThreadManagement RT NAME Thread Management DESCRIPTION This section describes the CUDA runtime application programming interface.

1. cudaThreadSynchronize() returns an error if one of the preceding tasks failed.1 cudaThreadSynchronize NAME cudaThreadSynchronize . SEE ALSO cudaThreadExit 10 .wait for compute-device to finish SYNOPSIS cudaError_t cudaThreadSynchronize(void) DESCRIPTION Blocks until the device has completed all preceding requested tasks. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. asynchronous launches.2.

2.2 cudaThreadExit NAME cudaThreadExit . SEE ALSO cudaThreadSynchronize 11 . cudaThreadExit() is implicitly called on host thread exit. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.exit and clean-up from CUDA launches SYNOPSIS cudaError_t cudaThreadExit(void) DESCRIPTION Explicitly cleans up all runtime-related resources associated with the calling host thread. Any subsequent API call reinitializes the runtime. asynchronous launches.1.

Execution Management. Stream Management. cudaStreamCreate cudaStreamQuery cudaStreamSynchronize cudaStreamDestroy SEE ALSO Device Management. Direct3D Interoperability. Error Handling 12 . Thread Management. Event Management.1. Texture Reference Management. Memory Management. OpenGL Interoperability.3 StreamManagement RT NAME Stream Management DESCRIPTION This section describes the CUDA runtime application programming interface.

3. asynchronous launches.create an async stream SYNOPSIS cudaError_t cudaStreamCreate( cudaStream_t* stream ) DESCRIPTION Creates a stream. cudaStreamSynchronize.1.1 cudaStreamCreate NAME cudaStreamCreate . SEE ALSO cudaStreamQuery. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaStreamDestroy 13 .

asynchronous launches. cudaStreamSynchronize 14 . or cudaErrorNotReady if not. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotReady cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.2 cudaStreamQuery NAME cudaStreamQuery .3.queries a stream for completion-status SYNOPSIS cudaError_t cudaStreamQuery(cudaStream_t stream) DESCRIPTION Returns cudaSuccess if all operations in the stream have completed. SEE ALSO cudaStreamCreate.1. cudaStreamDestroy.

waits for stream tasks to complete SYNOPSIS cudaError_t cudaStreamSynchronize( cudaStream_t stream ) DESCRIPTION Blocks until the device has completed all operations in the stream. cudaStreamQuery 15 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. cudaStreamDestroy. asynchronous launches.1.3. SEE ALSO cudaStreamCreate.3 cudaStreamSynchronize NAME cudaStreamSynchronize .

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.destroys and cleans-up a stream object SYNOPSIS cudaError_t cudaStreamDestroy( cudaStream_t stream ) DESCRIPTION Destroys a stream object. cudaStreamSychronize.3. cudaStreamDestroy 16 . asynchronous launches.4 cudaStreamDestroy NAME cudaStreamDestroy . SEE ALSO cudaStreamCreate.1.

OpenGL Interoperability. Direct3D Interoperability. Event Management.4 EventManagement RT NAME Event Management DESCRIPTION This section describes the CUDA runtime application programming interface.1. Texture Reference Management. Stream Management. Error Handling 17 . Memory Management. Thread Management. Execution Management. cudaEventCreate cudaEventRecord cudaEventQuery cudaEventSynchronize cudaEventDestroy cudaEventElapsedTime SEE ALSO Device Management.

1. SEE ALSO cudaEventRecord. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaEventElapsedTime 18 . cudaEventSynchronzie.creates an event-object SYNOPSIS cudaError_t cudaEventCreate( cudaEvent_t* event ) DESCRIPTION Creates an event object.4. cudaEventDestroy. cudaEventQuery.1 cudaEventCreate NAME cudaEventCreate . asynchronous launches.

SEE ALSO cudaEventCreate. the event is recorded after all preceding operations in the stream have been completed. If cudaEventRecord() has previously been called and the event has not been recorded yet.records an event SYNOPSIS cudaError_t cudaEventRecord( cudaEvent_t event. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.4. cudaEventSynchronize. Since this operation is asynchronous. cudaEventQuery() and/or cudaEventSynchronize() must be used to determine when the event has actually been recorded. CUstream stream ) DESCRIPTION Records an event. this function returns cudaErrorInvalidValue.2 cudaEventRecord NAME cudaEventRecord . it is recorded after all preceding operations in the CUDA context have been completed.1. cudaEventQuery. cudaEventElapsedTime 19 . If stream is non-zero. cudaEventDestroy. otherwise. asynchronous launches.

cudaEventRecord. If cudaEventRecord() has not been called on this event. asynchronous launches. SEE ALSO cudaEventCreate. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotReady cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.4. or cudaErrorNotReady if not. the function returns cudaErrorInvalidValue. cudaEventSynchronize.query if an event has been recorded SYNOPSIS cudaError_t cudaEventQuery( cudaEvent_t event ) DESCRIPTION Returns cudaSuccess if the event has actually been recorded.3 cudaEventQuery NAME cudaEventQuery .1. cudaEventDestroy. cudaEventElapsedTime 20 .

If cudaEventRecord() has not been called on this event. asynchronous launches. cudaEventQuery.wait for an event to be recorded SYNOPSIS cudaError_t cudaEventSynchronize( cudaEvent_t event ) DESCRIPTION Blocks until the event has actually been recorded.1.4 cudaEventSynchronize NAME cudaEventSynchronize . cudaEventRecord.4. cudaEventElapsedTime 21 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. cudaEventDestroy. SEE ALSO cudaEventCreate. the function returns cudaErrorInvalidValue.

cudaEventSynchronize.1.destroys an event-object SYNOPSIS cudaError_t cudaEventDestroy( cudaEvent_t event ) DESCRIPTION Destroys the event-object. cudaEventElapsedTime 22 . asynchronous launches.5 cudaEventDestroy NAME cudaEventDestroy .4. cudaEventQuery. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaEventRecord. SEE ALSO cudaEventCreate.

DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0. this function returns cudaErrorInvalidValue. cudaEvent_t start. SEE ALSO cudaEventCreate. cudaEventQuery. If either event has been recorded with a non-zero stream.computes the elapsed time between events SYNOPSIS cudaError_t cudaEventElapsedTime( float* time. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.5 microseconds). cudaEvent_t end ). the result is undefined. cudaEventDestroy.6 cudaEventElapsedTime NAME cudaEventElapsedTime . cudaEventRecord 23 . asynchronous launches.1. cudaEventSynchronize. If either event has not been recorded yet.4.

Direct3D Interoperability. Texture Reference Management. Memory Management. Event Management. cudaMalloc cudaMallocPitch cudaFree cudaMallocArray cudaFreeArray cudaMallocHost cudaFreeHost cudaMemset cudaMemset2D cudaMemcpy cudaMemcpy2D cudaMemcpyToArray cudaMemcpy2DToArray cudaMemcpyFromArray cudaMemcpy2DFromArray cudaMemcpyArrayToArray cudaMemcpy2DArrayToArray cudaMemcpyToSymbol cudaMemcpyFromSymbol cudaGetSymbolAddress cudaGetSymbolSize SEE ALSO Device Management. Error Handling 24 .5 MemoryManagement RT NAME Memory Management DESCRIPTION This section describes the CUDA runtime application programming interface. OpenGL Interoperability. Stream Management.1. Execution Management. Thread Management.

cudaMalloc() returns cudaErrorMemoryAllocation in case of failure. cudaFreeArray. cudaFreeHost 25 .1. cudaFree. size_t count ) DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. The memory is not cleared.5. cudaMallocArray. asynchronous launches.allocate memory on the GPU SYNOPSIS cudaError_t cudaMalloc( void** devPtr. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. SEE ALSO cudaMallocPitch. cudaMallocHost.1 cudaMalloc NAME cudaMalloc . The allocated memory is suitably aligned for any kind of variable.

cudaFreeHost 26 .1. SEE ALSO cudaMalloc. size_t* pitch. cudaMallocHost. Given the row and column of an array element of type T.5. The intended usage of pitch is as a separate parameter of the allocation. asynchronous launches. size_t widthInBytes. size_t height ) DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. cudaFreeArray. Due to pitch alignment restrictions in the hardware. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch(). used to compute addresses within the 2D array. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column. cudaFree.2 cudaMallocPitch NAME cudaMallocPitch . this is especially true if the application will be performing 2D memory copies between different regions of device memory (whether linear memory or CUDA arrays). For allocations of 2D arrays. The pitch returned in *pitch by cudaMallocPitch() is the width in bytes of the allocation. The function may pad the allocation to ensure that corresponding pointers in any given row will continue to meet the alignment requirements for coalescing as the address is updated from row to row.allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr. cudaMallocArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous.

which must have been returned by a previous call to cudaMalloc() or cudaMallocPitch().1.5. cudaMallocHost. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevicePointer cudaErrorInitializationError Note that this function may also return error codes from previous. no operation is performed. an error is returned. cudaMallocArray. cudaFreeHost 27 .3 cudaFree NAME cudaFree . cudaFree() returns cudaErrorInvalidDevicePointer in case of failure. or if cudaFree(devPtr) has already been called before. SEE ALSO cudaMalloc. cudaMallocPitch. asynchronous launches. Otherwise. If devPtr is 0.frees memory on the GPU SYNOPSIS cudaError_t cudaFree(void* devPtr) DESCRIPTION Frees the memory space pointed to by devPtr. cudaFreeArray.

4 cudaMallocArray NAME cudaMallocArray . SEE ALSO cudaMalloc. const struct cudaChannelFormatDesc* desc. z. cudaChannelFormatKindUnsigned. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous.5. y.1. cudaFreeArray. cudaMallocPitch. size_t height ) DESCRIPTION Allocates a CUDA array according to the cudaChannelFormatDesc structure desc and returns a handle to the new CUDA array in *array. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. cudaFreeHost 28 . cudaChannelFormatKindFloat.allocate an array on the GPU SYNOPSIS cudaError_t cudaMallocArray( struct cudaArray** array. enum cudaChannelFormatKind f. }. asynchronous launches. cudaMallocHost. size_t width. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. w. cudaFree.

If array is 0. cudaFreeHost 29 . cudaMallocPitch.frees an array on the GPU SYNOPSIS cudaError_t cudaFreeArray( struct cudaArray* array ) DESCRIPTION Frees the CUDA array array.1.5. cudaMallocHost.5 cudaFreeArray NAME cudaFreeArray . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError Note that this function may also return error codes from previous. no operation is performed. cudaFree. asynchronous launches. SEE ALSO cudaMalloc. cudaMallocArray.

As a result.6 cudaMallocHost NAME cudaMallocHost . Allocating excessive amounts of memory with cudaMallocHost() may degrade system performance. cudaFreeHost 30 .allocates page-locked memory on the host SYNOPSIS cudaError_t cudaMallocHost( void** hostPtr. cudaFree. cudaMallocPitch. asynchronous launches. SEE ALSO cudaMalloc. this function is best used sparingly to allocate staging areas for data exchange between host and device.5. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc().1. size_t size ) DESCRIPTION Allocates size bytes of host memory that is page-locked and accessible to the device. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cudaMemcpy*(). RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. since it reduces the amount of memory available to the system for paging. Since the memory can be accessed directly by the device. cudaFreeArray. cudaMallocArray.

7 cudaFreeHost NAME cudaFreeHost . cudaMallocArray. asynchronous launches. which must have been returned by a previous call to cudaMallocHost(). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError Note that this function may also return error codes from previous. cudaMallocPitch. cudaFree. SEE ALSO cudaMalloc.frees page-locked memory SYNOPSIS cudaError_t cudaFreeHost( void* hostPtr ) DESCRIPTION Frees the memory space pointed to by hostPtr.1. cudaFreeArray. cudaMallocHost 31 .5.

1. cudaMemset3D 32 . asynchronous launches.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset( void* devPtr. int value. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous.5.8 cudaMemset NAME cudaMemset . size_t count ) DESCRIPTION Fills the first count bytes of the memory area pointed to by devPtr with the constant byte value value. SEE ALSO cudaMemset2D.

5. including any padding added to the end of each row. int value. size_t pitch.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset2D( void* dstPtr. size_t width. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous.9 cudaMemset2D NAME cudaMemset2D . This function performs fastest when the pitch is one that has been passed back by cudaMallocPitch(). SEE ALSO cudaMemset. size_t height ) DESCRIPTION Sets to the specified value value a matrix (height rows of width bytes each) pointed to by dstPtr. cudaMemset3D 33 . asynchronous launches.1. pitch is the width in memory in bytes of the 2D array pointed to by dstPtr.

The memory areas may not overlap. cudaMemcpyArrayToArray. cudaMemcpyHostToDevice. cudaMemcpy2DToArray. cudaMemcpyAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. cudaMemcpyFromArray. size_t count. cudaMemcpyToArray. SEE ALSO cudaMemcpy2D.copies data between GPU and host SYNOPSIS cudaError_t cudaMemcpy( void* dst. or cudaMemcpyDeviceToDevice. cudaMemcpy2DArrayToArray. cudaMemcpy2DFromArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. asynchronous launches. cudaMemcpyDeviceToHost. cudaMemcpyToSymbol. cudaMemcpyFromSymbol 34 . const void* src. cudaStream_t stream ) DESCRIPTION Copies count bytes from the memory area pointed to by src to the memory area pointed to by dst. Calling cudaMemcpy() with dst and src pointers that do not match the direction of the copy results in an undefined behavior. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. enum cudaMemcpyKind kind ) cudaError_t cudaMemcpyAsync( void* dst. where kind is one of cudaMemcpyHostToHost.1. const void* src.10 cudaMemcpy NAME cudaMemcpy . and specifies the direction of the copy. enum cudaMemcpyKind kind. size_t count.5.

size_t spitch.5. cudaMemcpy2D() returns an error if dpitch or spitch is greater than the maximum allowed. cudaMemcpy2DToArray. cudaMemcpy2DAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. cudaMemcpy2DArrayToArray. size_t dpitch. size_t height. size_t width. const void* src. cudaMemcpyArrayToArray. cudaMemcpyDeviceToHost. Calling cudaMemcpy2D() with dst and src pointers that do not match the direction of the copy results in an undefined behavior. cudaMemcpyToSymbol. size_t width. cudaMemcpyToArray. SEE ALSO cudaMemcpy. where kind is one of cudaMemcpyHostToHost. const void* src. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidPitchValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaStream_t stream ) DESCRIPTION Copies a matrix (height rows of width bytes each) from the memory area pointed to by src to the memory area pointed to by dst. dpitch and spitch are the widths in memory in bytes of the 2D arrays pointed to by dst and src. cudaMemcpyFromArray. size_t height.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2D( void* dst. enum cudaMemcpyKind kind ) cudaError_t cudaMemcpy2DAsync( void* dst. or cudaMemcpyDeviceToDevice. including any padding added to the end of each row. cudaMemcpyHostToDevice. enum cudaMemcpyKind kind.11 cudaMemcpy2D NAME cudaMemcpy2D . size_t dpitch.1. cudaMemcpy2DFromArray. The memory areas may not overlap. size_t spitch. cudaMemcpyFromSymbol 35 . asynchronous launches. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. and specifies the direction of the copy.

cudaMemcpy2D. size_t dstX. const void* src. size_t dstX. asynchronous launches. cudaMemcpyHostToDevice. where kind is one of cudaMemcpyHostToHost. cudaMemcpyDeviceToHost. const void* src. cudaMemcpy2DFromArray. size_t dstY. cudaMemcpyArrayToArray.12 cudaMemcpyToArray NAME cudaMemcpyToArray . SEE ALSO cudaMemcpy. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpyToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. or cudaMemcpyDeviceToDevice. size_t count. cudaMemcpyFromArray. enum cudaMemcpyKind kind. and specifies the direction of the copy. dstY). cudaMemcpy2DToArray.5. size_t dstY. cudaMemcpyFromSymbol 36 .1. cudaMemcpy2DArrayToArray.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyToArray(struct cudaArray* dstArray. size_t count. cudaMemcpyToSymbol. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyToArrayAsync(struct cudaArray* dstArray. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cudaStream_t stream) DESCRIPTION Copies count bytes from the memory area pointed to by src to the CUDA array dstArray starting at the upper left corner (dstX.

or cudaMemcpyDeviceToDevice. cudaError_t cudaMemcpy2DToArrayAsync(struct cudaArray* dstArray. enum cudaMemcpyKind kind. cudaMemcpyArrayToArray. cudaMemcpyDeviceToHost. cudaMemcpyToSymbol.5. size_t width. asynchronous launches. size_t dstX. cudaMemcpyHostToDevice. size_t width. and specifies the direction of the copy. including any padding added to the end of each row. size_t height. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidPitchValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpy2D() returns an error if spitch is greater than the maximum allowed. cudaStream_t stream). cudaMemcpyToArray. cudaMemcpy2DArrayToArray. enum cudaMemcpyKind kind). cudaMemcpy2DToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument.1. size_t dstY. size_t spitch. const void* src. size_t height. DESCRIPTION Copies a matrix (height rows of width bytes each) from the memory area pointed to by src to the CUDA array dstArray starting at the upper left corner (dstX. dstY).copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DToArray(struct cudaArray* dstArray. cudaMemcpy2DFromArray. cudaMemcpyFromSymbol 37 . spitch is the width in memory in bytes of the 2D array pointed to by src. size_t spitch. cudaMemcpyFromArray. cudaMemcpy2D. size_t dstY. const void* src. where kind is one of cudaMemcpyHostToHost. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.13 cudaMemcpy2DToArray NAME cudaMemcpy2DToArray . size_t dstX. SEE ALSO cudaMemcpy.

cudaMemcpy2DFromArray. const struct cudaArray* srcArray. cudaMemcpyDeviceToHost. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. enum cudaMemcpyKind kind. size_t count. asynchronous launches. where kind is one of cudaMemcpyHostToHost. cudaMemcpyToArray. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyFromArrayAsync(void* dst. cudaMemcpy2D. size_t srcX. cudaMemcpyHostToDevice. or cudaMemcpyDeviceToDevice. cudaMemcpyToSymbol.1. size_t count. cudaStream_t stream) DESCRIPTION Copies count bytes from the CUDA array srcArray starting at the upper left corner (srcX. srcY) to the memory area pointed to by dst. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. size_t srcY.5. const struct cudaArray* srcArray. cudaMemcpyArrayToArray. cudaMemcpy2DToArray. and specifies the direction of the copy. size_t srcX. cudaMemcpyFromArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. cudaMemcpy2DArrayToArray.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyFromArray(void* dst. SEE ALSO cudaMemcpy. size_t srcY.14 cudaMemcpyFromArray NAME cudaMemcpyFromArray . cudaMemcpyFromSymbol 38 .

cudaMemcpyDeviceToHost. and specifies the direction of the copy. cudaMemcpy2DArrayToArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidPitchValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. const struct cudaArray* srcArray. cudaMemcpyHostToDevice.5. srcY) to the memory area pointed to by dst. including any padding added to the end of each row. cudaMemcpy2DToArray. or cudaMemcpyDeviceToDevice. size_t width.1. enum cudaMemcpyKind kind) cudaError_t cudaMemcpy2DFromArrayAsync(void* dst. size_t srcY. const struct cudaArray* srcArray. cudaStream_t stream) DESCRIPTION Copies a matrix (height rows of width bytes each) from the CUDA array srcArray starting at the upper left corner (srcX. size_t srcX. cudaMemcpyFromSymbol 39 . cudaMemcpy2DFromArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. size_t srcX.15 cudaMemcpy2DFromArray NAME cudaMemcpy2DFromArray . cudaMemcpyToSymbol. size_t dpitch. where kind is one of cudaMemcpyHostToHost. size_t width. size_t srcY. cudaMemcpyArrayToArray. cudaMemcpy2D() returns an error if dpitch is greater than the maximum allowed. cudaMemcpyToArray. enum cudaMemcpyKind kind. dpitch is the width in memory in bytes of the 2D array pointed to by dst. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. SEE ALSO cudaMemcpy. size_t dpitch. asynchronous launches.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DFromArray(void* dst. cudaMemcpyFromArray. cudaMemcpy2D. size_t height. size_t height.

srcY) to the CUDA array dstArray starting at the upper left corner (dstX.1. and specifies the direction of the copy. where kind is one of cudaMemcpyHostToHost. dstY). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. size_t count. size_t srcY. const struct cudaArray* srcArray. cudaMemcpy2DArrayToArray. cudaMemcpyToArray. cudaMemcpyFromSymbol 40 . cudaMemcpyFromArray. asynchronous launches. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the CUDA array srcArray starting at the upper left corner (srcX.16 cudaMemcpyArrayToArray NAME cudaMemcpyArrayToArray .5. size_t dstX. size_t dstY. cudaMemcpyToSymbol. cudaMemcpy2D. size_t srcX. cudaMemcpyDeviceToHost. SEE ALSO cudaMemcpy. cudaMemcpy2DFromArray. cudaMemcpyHostToDevice.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyArrayToArray(struct cudaArray* dstArray. or cudaMemcpyDeviceToDevice. cudaMemcpy2DToArray.

asynchronous launches. cudaMemcpy2D. size_t height. where kind is one of cudaMemcpyHostToHost. size_t dstX. cudaMemcpyToSymbol. dstY).1. size_t srcX. cudaMemcpy2DFromArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DArrayToArray(struct cudaArray* dstArray. size_t dstY. or cudaMemcpyDeviceToDevice.17 cudaMemcpy2DArrayToArray NAME cudaMemcpy2DArrayToArray .5. cudaMemcpy2DToArray. srcY) to the CUDA array dstArray starting at the upper left corner (dstX. cudaMemcpyFromArray. cudaMemcpyArrayToArray. size_t srcY. cudaMemcpyFromSymbol 41 . cudaMemcpyDeviceToHost. const struct cudaArray* srcArray. enum cudaMemcpyKind kind) DESCRIPTION Copies a matrix (height rows of width bytes each) from the CUDA array srcArray starting at the upper left corner (srcX. size_t width. cudaMemcpyToArray. and specifies the direction of the copy. cudaMemcpyHostToDevice. SEE ALSO cudaMemcpy.

SEE ALSO cudaMemcpy. cudaMemcpy2DArrayToArray.5. size_t offset. cudaMemcpyToArray. symbol can either be a variable that resides in global or constant memory space.copies data from host memory to GPU SYNOPSIS template < class T > cudaError_t cudaMemcpyToSymbol( const T& symbol. asynchronous launches. cudaMemcpyFromArray. const void* src. cudaMemcpy2D.1. cudaMemcpy2DToArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidSymbol cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpyArrayToArray. size_t count. cudaMemcpy2DFromArray. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the memory area pointed to by src to the memory area pointed to by offset bytes from the start of symbol symbol. or it can be a character string.18 cudaMemcpyToSymbol NAME cudaMemcpyToSymbol . cudaMemcpyFromSymbol 42 . The memory areas may not overlap. kind can be either cudaMemcpyHostToDevice or cudaMemcpyDeviceToDevice. naming a variable that resides in global or constant memory space.

The memory areas may not overlap.19 cudaMemcpyFromSymbol NAME cudaMemcpyFromSymbol . cudaMemcpy2DArrayToArray. kind can be either cudaMemcpyDeviceToHost or cudaMemcpyDeviceToDevice. cudaMemcpy2DFromArray. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the memory area pointed to by offset bytes from the start of symbol symbol to the memory area pointed to by dst. cudaMemcpyFromArray. cudaMemcpyArrayToArray. asynchronous launches.1. SEE ALSO cudaMemcpy. size_t count. cudaMemcpyToSymbol 43 . cudaMemcpy2D.5. or it can be a character string. cudaMemcpy2DToArray. cudaMemcpyToArray. const T& symbol. symbol can either be a variable that resides in global or constant memory space.copies data from GPU to host memory SYNOPSIS template < class T > cudaError_t cudaMemcpyFromSymbol( void *dst. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidSymbol cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. size_t offset. naming a variable that resides in global or constant memory space.

5. cudaGetSymbolAddress() returns cudaErrorInvalidSymbol in case of failure RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidSymbol cudaErrorAddressOfConstant Note that this function may also return error codes from previous. const T& symbol) DESCRIPTION Returns in *devPtr the address of symbol symbol on the device. or if symbol is not declared in global memory space.finds the address associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolAddress(void** devPtr. If symbol cannot be found. or it can be a character string. SEE ALSO cudaGetSymbolSize 44 . naming a variable that resides in global memory space. asynchronous launches. *devPtr is unchanged and an error is returned. symbol can either be a variable that resides in global memory space.20 cudaGetSymbolAddress NAME cudaGetSymbolAddress .1.

cudaGetSymbolSize() returns cudaErrorInvalidSymbol in case of failure.21 cudaGetSymbolSize NAME cudaGetSymbolSize . const T& symbol) DESCRIPTION Returns in *size the size of symbol symbol. SEE ALSO cudaGetSymbolAddress 45 . symbol can either be a variable that resides in global or constant memory space. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidSymbol Note that this function may also return error codes from previous.1. *size is unchanged and an error is returned.finds the size of the object associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolSize(size_t* size. or if symbol is not declared in global or constant memory space.5. naming a variable that resides in global or constant memory space. If symbol cannot be found. or it can be a character string.

which are equivalent to the width and height extent parameters provided by the programmer during allocation. For allocations of 2D. size_t depth. size_t height. size_t pitch.1. cudaError_t cudaMalloc3D( struct cudaPitchedPtr* pitchDevPtr. size_t ysize. this is especially true if the application will be performing memory copies involving 2D or 3D objects (whether linear memory or CUDA arrays).5. struct cudaExtent extent ) DESCRIPTION Allocates at least width*height*depth bytes of linear memory on the device and returns a pitchedDevPtr in which ptr is a pointer to the allocated memory.22 cudaMalloc3D NAME cudaMalloc3D .allocates logical 1D. the logical width and height of the allocation. }. 46 . 3D objects. asynchronous launches. The pitch returned in the pitch field of the pitchedDevPtr is the width in bytes of the allocation. 2D. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. The returned cudaPitchedPtr contains additional fields xsize and ysize. it is highly recommended that programmers perform allocations using cudaMalloc3D() or cudaMallocPitch(). Due to alignment restrictions in the hardware. }. The function may pad the allocation to ensure hardware alignment requirements are met. struct cudaExtent { size_t width. size_t xsize. or 3D memory objects on the GPU SYNOPSIS struct cudaPitchedPtr { void *ptr.

cudaMemset3D. cudaFree. cudaMalloc3DArray.SEE ALSO cudaMallocPitch. cudaMemcpy3D. cudaFreeArray. cudaFreeHost 47 . cudaMallocHost. cudaMallocArray.

0} . cudaMalloc3DArray is able to allocate 1D. 0. cudaChannelFormatKindFloat. (1. (1. size_t depth. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. • A 1D array is allocated if the height and depth extent are both zero.5.allocate an array on the GPU SYNOPSIS struct cudaExtent { size_t width. 2048)}. (1. 2048). 65536). asynchronous launches. For 1D arrays valid extents are {(1. 8192). y. a degenerate 2D array allows for significantly more linear storage than a 1D array. 2048). 2D. 32768). 0}. cudaChannelFormatKindUnsigned. For 3D arrays valid extents are {(1. 48 . • A 3D array is allocate if all three extents are non-zero. Note: That because of the differing extent limits it may be advantageous to use a degenerate array (with unused dimensions set to one) of higher dimensionality.1. cudaError_t cudaMalloc3DArray( struct cudaArray** arrayPtr. }. z. or 3D arrays. • A 2D array is allocated if only the depth extent is zero. size_t height. const struct cudaChannelFormatDesc* desc. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned.23 cudaMalloc3DArray NAME cudaMalloc3DArray . struct cudaExtent extent ) DESCRIPTION Allocates a CUDA array according to the cudaChannelFormatDesc structure desc and returns a handle to the new CUDA array in *arrayPtr. enum cudaChannelFormatKind f. w. For instance. }. For 2D arrays valid extents are {(1.

cudaMalloc. cudaFreeHost 49 .SEE ALSO cudaMalloc3D. cudaFree. cudaMallocPitch. cudaMallocHost. cudaFreeArray.

24 cudaMemset3D NAME cudaMemset3D . extents with height equal to the ysize of dstPitchPtr will perform faster than when the hieght is shorter than the ysize. 50 .1. The object to initialize is defined by dstPitchPtr. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous. Extents with width greater than or equal to the xsize of dstPitchPtr may perform significantly faster than extents narrower than the xsize. This function performs fastest when the dstPitchPtr has been allocated by cudaMalloc3D(). int value. size_t pitch. while the ysize field specifies the height of each 2D slice in rows. }. including any padding added to the end of each row. The extents of the initialized region are specified as a width in bytes. size_t depth. and a depth in slices. size_t ysize. }. asynchronous launches. struct cudaExtent extent ) DESCRIPTION Initializes each element of a 3D array to the specified value value. a height in rows. cudaError_t cudaMemset3D( struct cudaPitchedPtr dstPitchPtr. Secondarily.5. The xsize field specifies the logical width of each row in bytes.initializes or sets GPU memory to a value SYNOPSIS struct cudaPitchedPtr { void *ptr. The pitch field of dstPitchPtr is the width in memory in bytes of the 3D array pointed to by dstPitchPtr. size_t xsize. size_t height. struct cudaExtent { size_t width.

cudaMalloc3D 51 . cudaMemset2D.SEE ALSO cudaMemset.

struct cudaPos dstPos. The extent field defines the dimensions of the transferred area in elements. enum cudaMemcpyKind kind. positions must be in the range [0. The element for a host or device pointer is assumed to be unsigned char. cudaError_t cudaMemcpy3D( const struct cudaMemcpy3DParms *p ) cudaError_t cudaMemcpy3DAsync( const struct cudaMemcpy3DParms *p. struct cudaPos { size_t x. destination. If a CUDA array is participating in the copy the extent is defined in terms of that array’s elements. cudaMemcpyHostToDevice.1.25 cudaMemcpy3D NAME cudaMemcpy3D . It must be one of cudaMemcpyHostToHost. or cudaMemcpyDeviceToDevice. struct cudaPos srcPos. The source and destination objects may be in either host memory. struct cudaExtent extent. Passing more than one non-zero source or destination will cause cudaMemcpy3D() to return an error. The source. z. The srcPos and dstPos fields are optional offsets into the source and destination objects and are defined in units of each object’s elements. struct cudaPitchedPtr srcPtr. height. The kind field defines the direction of the copy. }. If no CUDA array is participating in the copy then the extents are defined in elements of unsigned char. struct cudaArray *dstArray. cudaStream_t stream ) DESCRIPTION cudaMemcpy3D() copies data betwen two 3D objects. y. cudaMemcpyDeviceToHost. extent. and kind of copy performed is specified by the cudaMemcpy3DParms struct which should be initialized to zero before use: cudaMemcpy3DParms myParms = {0}. device memory. }.copies data between between 3D objects SYNOPSIS struct cudaExtent { size_t width. struct cudaMemcpy3DParms { struct cudaArray *srcArray.5. depth. The struct passed to cudaMemcpy3D() must specify one of srcArray or srcPtr and one of dstArray or dstPtr. 2048) for any dimension. }. struct cudaPitchedPtr dstPtr. 52 . For CUDA arrays. or a CUDA array.

If either the source or destination is a host object it must be allocated in page-locked memory returned from cudaMallocHost(). If overlapping source and destination objects are specified undefined behavior will result. cudaMemcpy3D() returns an error if the pitch of srcPtr or dstPtr is greater than the maximum allowed. It will return an error if a pointer to memory not allocated with cudaMallocHost() is passed as input. cudaMemcpyToArray. cudaMemcpy3DAsync() is an asynchronous copy operation and can optionally be associated to a stream by passing a non-zero stream argument.If the source and destination are both arrays cudaMemcpy3D() will return an error if they do not have the same element size. cudaMemcpy. cudaMemcpy2DArrayToArray. cudaMemcpy2DToArray. cudaMalloc3DArray. cudaMemcpyFromSymbol 53 . cudaMemcpy2DFromArray. cudaMemset3D. RETURN VALUE cudaSuccess SEE ALSO cudaMalloc3D. cudaMemcpyFromArray. cudaMemcpyArrayToArray. The pitch of a cudaPitchedPtr allocated with cudaMalloc3D() will always be valid. cudaMemcpyToSymbol. The source and destination object may not overlap.

Stream Management. Thread Management. Error Handling 54 . Execution Management. Memory Management. Event Management.6 TextureReferenceManagement RT NAME Texture Reference Management DESCRIPTION This section describes the CUDA runtime application programming interface.1. Low-Level API High-Level API SEE ALSO Device Management. OpenGL Interoperability. Texture Reference Management. Direct3D Interoperability.

1.6.1 LowLevelApi NAME Low-Level Texture API DESCRIPTION This section describes the low-level CUDA run-time application programming interface for textures cudaCreateChannelDesc cudaGetChannelDesc cudaGetTextureReference cudaBindTexture cudaBindTextureToArray cudaUnbindTexture cudaGetTextureAlignmentOffset SEE ALSO High-Level API 55 .

cudaCreateChannelDesc NAME cudaCreateChannelDesc . cudaChannelFormatKindUnsigned. enum cudaChannelFormatKind f. int w. int z. int y.Low-level texture API SYNOPSIS struct cudaChannelFormatDesc cudaCreateChannelDesc(int x. y. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. SEE ALSO cudaGetChannelDesc. enum cudaChannelFormatKin f). cudaGetTextureAlignmentOffset 56 . z. cudaBindTexture. DESCRIPTION Returns a channel descriptor with format f and number of bits of each component x. }. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. and w. cudaBindTextureToArray. w. cudaGetTextureReference. cudaUnbindTexture. cudaChannelFormatKindFloat. z. asynchronous launches. y. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.

cudaBindTextureToArray. cudaGetTextureReference. SEE ALSO cudaCreateChannelDesc. cudaGetTextureAlignmentOffset 57 . const struct cudaArray* array). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous.cudaGetChannelDesc NAME cudaGetChannelDesc . DESCRIPTION Returns in *desc the channel descriptor of the CUDA array array. asynchronous launches.Low-level texture API SYNOPSIS cudaError_t cudaGetChannelDesc(struct cudaChannelFormatDesc* desc. cudaBindTexture. cudaUnbindTexture.

const char* symbol) DESCRIPTION Returns in *texRef the structure associated to the texture reference defined by symbol symbol.Low-level texture API SYNOPSIS cudaError_t cudaGetTextureReference( struct textureReference** texRef.cudaGetTextureReference NAME cudaGetTextureReference . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidTexture Note that this function may also return error codes from previous. cudaGetChannelDesc. SEE ALSO cudaCreateChannelDesc. cudaGetTextureAlignmentOffset 58 . cudaBindTextureToArray. cudaBindTexture. asynchronous launches. cudaUnbindTexture.

This offset must be divided by the texel size and passed to kernels that read from the texture so they can be applied to the tex1Dfetch() function. Any memory previously bound to texRef is unbound. const void* devPtr. cudaGetTextureAlignmentOffset 59 . cudaBindTexture() returns in *offset a byte offset that must be applied to texture fetches in order to read from the desired memory. If the device memory pointer was returned from cudaMalloc(). size_t size = UINT_MAX). Since the hardware enforces an alignment requirement on texture base addresses. cudaUnbindTexture. const struct textureReference* texRef. const struct cudaChannelFormatDesc* desc. cudaGetChannelDesc. the offset is guaranteed to be 0 and NULL may be passed as the offset parameter.Low-level texture API SYNOPSIS cudaError_t cudaBindTexture(size_t* offset. cudaBindTextureToArray. cudaGetTextureReference. SEE ALSO cudaCreateChannelDesc.cudaBindTexture NAME cudaBindTexture . asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to the texture reference texRef. desc describes how the memory is interpreted when fetching values from the texture.

desc describes how the memory is interpreted when fetching values from the texture. cudaGetChannelDesc. asynchronous launches.cudaBindTextureToArray NAME cudaBindTextureToArray . cudaGetTextureAlignmentOffset 60 . const struct cudaChannelFormatDesc* desc). cudaBindTexture. SEE ALSO cudaCreateChannelDesc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous.Low-level texture API SYNOPSIS cudaError_t cudaBindTextureToArray( const struct textureReference* texRef. Any CUDA array previously bound to texRef is unbound. const struct cudaArray* array. cudaGetTextureReference. DESCRIPTION Binds the CUDA array array to the texture reference texRef. cudaUnbindTexture.

DESCRIPTION Unbinds the texture bound to texture reference texRef. cudaGetChannelDesc. asynchronous launches.Low-level texture API SYNOPSIS cudaError_t cudaUnbindTexture( const struct textureReference* texRef). cudaBindTextureToArray. cudaGetTextureReference. cudaGetTextureAlignmentOffset 61 . cudaBindTexture. SEE ALSO cudaCreateChannelDesc.cudaUnbindTexture NAME cudaUnbindTexture . RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.

cudaGetChannelDesc. cudaUnbindTexture 62 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidTexture cudaErrorInvalidTextureBinding Note that this function may also return error codes from previous. DESCRIPTION Returns in *offset the offset that was returned when texture reference texRef was bound. cudaGetTextureReference. const struct textureReference* texRef). asynchronous launches.cudaGetTextureAlignmentOffset NAME cudaGetTextureAlignmentOffset .Low-level texture API SYNOPSIS cudaError_t cudaGetTextureAlignmentOffset(size_t* offset. SEE ALSO cudaCreateChannelDesc. cudaBindTextureToArray. cudaBindTexture.

2 HighLevelApi NAME High-Level Texture API DESCRIPTION This section describes the high-level CUDA run-time application programming interface for textures cudaCreateChannelDesc cudaBindTexture cudaBindTextureToArray cudaUnbindTexture SEE ALSO Low-Level API 63 .1.6.

y. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. y. DESCRIPTION Returns a channel descriptor with format f and number of bits of each component x. asynchronous launches. SEE ALSO 64 . w.High-level texture API SYNOPSIS template < class T > struct cudaChannelFormatDesc cudaCreateChannelDesc <T >(). and w. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. z.cudaCreateChannelDesc HL NAME cudaCreateChannelDesc . cudaChannelFormatKindFloat. cudaChannelFormatKindUnsigned. enum cudaChannelFormatKind f. }. z.

desc describes how the memory is interpreted when fetching values from the texture. const struct cudaChannelFormatDesc& desc. template E<lt> class T. const struct texture E<lt> T.High-level texture API SYNOPSIS template < class T. The offset parameter is an optional byte offset as with the lowlevel cudaBindTexture() function described RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. readMode E<gt>& texRef. The channel descriptor is inherited from the texture reference type. int dim. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTexture(size_t* offset. asynchronous launches. dim. binds size bytes of the memory area pointed to by devPtr to texture reference texRef. dim. enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTexture( size_t* offset. const struct texture < T. size_t size = UINT_MAX). Any memory previously bound to texRef is unbound. The offset parameter is an optional byte offset as with the low-level cudaBindTexture() function. const void* devPtr. SEE ALSO 65 . readMode >& texRef.cudaBindTexture HL NAME cudaBindTexture . int dim. size_t size = UINT_MAX) DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to texture reference texRef. const void* devPtr.

desc describes how the memory is interpreted when fetching values from the texture. The channel descriptor is inherited from the CUDA array. readMode E<gt>& texRef.cudaBindTextureToArray HL NAME cudaBindTextureToArray . readMode >& texRef. asynchronous launches. const struct cudaArray* cuArray).High-level texture API SYNOPSIS template < class T. binds the CUDA array array to texture reference texRef. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTextureToArray( const struct texture < T. Any CUDA array previously bound to texRef is unbound. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. dim. Any CUDA array previously bound to texRef is unbound. const struct cudaChannelFormatDesc& desc) DESCRIPTION Binds the CUDA array array to texture reference texRef. SEE ALSO cudaCreateChannelDesc_HL 66 . enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTextureToArray( const struct texture E<lt> T. int dim. const struct cudaArray* cuArray. template E<lt> class T. int dim. dim.

RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. dim. int dim.cudaUnbindTexture HL NAME cudaUnbindTexture . asynchronous launches. SEE ALSO 67 . readMode >& texRef) DESCRIPTION Unbinds the texture bound to texture reference texRef.High-level texture API SYNOPSIS template < class T. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaUnbindTexture(const struct texture < T.

cudaConfigureCall cudaLaunch cudaSetupArgument SEE ALSO Device Management. Stream Management. Execution Management. OpenGL Interoperability. Event Management. Memory Management.1. Error Handling 68 . Direct3D Interoperability. Texture Reference Management. Thread Management.7 ExecutionControl RT NAME Execution Control DESCRIPTION This section describes the CUDA runtime application programming interface.

Each call pushes data on top of an execution stack. SEE ALSO cudaLaunch. cudaSetupArgument 69 .7.configure a device-launch SYNOPSIS cudaError_t cudaConfigureCall(dim3 gridDim. together with any arguments for the call. asynchronous launches. size_t sharedMem = 0. int tokens = 0) DESCRIPTION Specifies the grid and block dimensions for the device call to be executed similar to the execution configuration syntax. cudaConfigureCall() is stack based.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidConfiguration Note that this function may also return error codes from previous. dim3 blockDim.1 cudaConfigureCall NAME cudaConfigureCall . This data contains the dimension for the grid and thread blocks.

or it can be a character string. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration Note that this function may also return error codes from previous.1.2 cudaLaunch NAME cudaLaunch . entry must be declared as a __global__ function. cudaSetupArgument 70 . cudaLaunch() must be preceded by a call to cudaConfigureCall() since it pops the data that was pushed by cudaConfigureCall() from the execution stack. asynchronous launches. naming a function that executes on the device. entry can either be a function that executes on the device.launches a device function SYNOPSIS template < class T > cudaError_t cudaLaunch(T entry) DESCRIPTION Launches the function entry on the device.7. SEE ALSO cudaConfigureCall.

asynchronous launches.3 cudaSetupArgument NAME cudaSetupArgument . SEE ALSO cudaConfigureCall. cudaLaunch 71 .1.7.configure a device-launch SYNOPSIS cudaError_t cudaSetupArgument(void* arg. size_t count. cudaSetupArgument() must be preceded by a call to cudaConfigureCall(). RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. size_t offset) DESCRIPTION Pushes count bytes of the argument pointed to by arg at offset bytes from the start of the parameter passing area. which starts at offset 0. size_t offset) template < class T > cudaError_t cudaSetupArgument(T arg. The arguments are stored in the top of the execution stack.

8 OpenGlInteroperability RT NAME OpenGL Interoperability DESCRIPTION This section describes the CUDA runtime application programming interface.1. Stream Management. Direct3D Interoperability. OpenGL Interoperability. Texture Reference Management. Memory Management. cudaGLSetGLDevice cudaGLRegisterBufferObject cudaGLMapBufferObject cudaGLUnmapBufferObject cudaGLUnregisterBufferObject SEE ALSO Device Management. Execution Management. Thread Management. Error Handling 72 . Event Management.

DESCRIPTION Records dev as the device on which the active host thread executes the device code.sets the CUDA device for use with GL Interopability SYNOPSIS cudaError_t cudaGLSetGLDevice(int device).1. cudaGLMapBufferObject. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. asynchronous launches. Records the thread as using GL Interopability.1 cudaGLSetGLDevice NAME cudaGLSetGLDevice . cudaGLUnregisterBufferObject 73 . SEE ALSO cudaGLRegisterBufferObject. cudaGLUnmapBufferObject.8.

cudaGLUnmapBufferObject.8. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands.OpenGL interoperability SYNOPSIS cudaError_t cudaGLRegisterBufferObject(GLuint bufferObj) DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. cudaGLUnregisterBufferObject 74 .1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotInitialized Note that this function may also return error codes from previous.2 cudaGLRegisterBufferObject NAME cudaGLRegisterBufferObject . asynchronous launches. cudaGLMapBufferObject. This function must be called before CUDA can map the buffer object. While it is registered. SEE ALSO cudaGLSetGLDevice.

cudaGLUnregisterBufferObject 75 . asynchronous launches. cudaGLRegisterBufferObject.1.8. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMapBufferObjectFailed Note that this function may also return error codes from previous. SEE ALSO cudaGLSetGLDevice. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of CUDA and returns in *devPtr the base pointer of the resulting mapping.3 cudaGLMapBufferObject NAME cudaGLMapBufferObject .OpenGL interoperability SYNOPSIS cudaError_t cudaGLMapBufferObject(void** devPtr. cudaGLUnmapBufferObject. GLuint bufferObj).

SEE ALSO cudaGLSetGLDevice.OpenGL interoperability SYNOPSIS cudaError_t cudaGLUnmapBufferObject(GLuint bufferObj).8. DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA. asynchronous launches. cudaGLRegisterBufferObject. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevicePointer cudaErrorUnmapBufferObjectFailed Note that this function may also return error codes from previous. cudaGLUnregisterBufferObject 76 .4 cudaGLUnmapBufferObject NAME cudaGLUnmapBufferObject .1. cudaGLMapBufferObject.

cudaGLRegisterBufferObject.1.5 cudaGLUnregisterBufferObject NAME cudaGLUnregisterBufferObject . SEE ALSO cudaGLSetGLDevice. cudaGLUnmapBufferObject 77 .OpenGL interoperability SYNOPSIS cudaError_t cudaGLUnregisterBufferObject(GLuint bufferObj). DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA. cudaGLMapBufferObject.8. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. asynchronous launches.

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

DESCRIPTION
This section describes the CUDA runtime application programming interface. cudaD3D9GetDevice cudaD3D9SetDirect3DDevice cudaD3D9GetDirect3DDevice cudaD3D9RegisterResource cudaD3D9UnregisterResource cudaD3D9MapResources cudaD3D9UnmapResources cudaD3D9ResourceGetSurfaceDimensions cudaD3D9ResourceSetMapFlags cudaD3D9ResourceGetMappedPointer cudaD3D9ResourceGetMappedSize cudaD3D9ResourceGetMappedPitch As of CUDA 2.0 the following functions are deprecated. They should not be used in new development. cudaD3D9Begin cudaD3D9End cudaD3D9RegisterVertexBuffer cudaD3D9MapVertexBuffer cudaD3D9UnmapVertexBuffer cudaD3D9UnregisterVertexBuffer

SEE ALSO
Device Management, Thread Management, Stream Management, Event Management, Execution Management, Memory Management, Texture Reference Management, OpenGL Interoperability, Direct3D Interoperability, Error Handling

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

SYNOPSIS
cudaError_t cudaD3D9GetDevice(int* dev, const char* adapterName);

DESCRIPTION
Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier(). If no device on the adapter with name adapterName is CUDA-compatible then the call will fail.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorUnknown Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9SetDirect3DDevice, cudaD3D9GetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

79

1.9.2

cudaD3D9SetDirect3DDevice

NAME
cudaD3D9SetDirect3DDevice - sets the Direct3D device to use for interoperability in this thread

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

DESCRIPTION
Records pDxDevice as the Direct3D device to use for Direct3D interoperability on this host thread. In order to use Direct3D interoperability, this call must be made before any other CUDA runtime calls on this thread. Successful context creation on pDxDevice will increase the internal reference count on pDxDevice. This reference count will be decremented upon destruction of this context through cudaThreadExit.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorInvalidValue Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9GetDevice, cudaD3D9GetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

80

1.9.3

cudaD3D9GetDirect3DDevice

NAME
cudaD3D9GetDirect3DDevice - get the Direct3D device against which the current CUDA context was created

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

DESCRIPTION
Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cudaD3D9SetDirect3DDevice.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorUnknown Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9GetDevice, cudaD3D9SetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

81

one must register the base texture object. • The primary rendertarget may not be registered with CUDA. DESCRIPTION Registers the Direct3D resource pResource for access by CUDA. The Flags argument specifies the mechanism through which CUDA will access the Direct3D resource. • IDirect3DVertexBuffer9: No notes. • Resources allocated as shared may not be registered with CUDA. This call is potentially high-overhead and should not be called every frame in interactive applications. 16. or 32-bit integer or floating-point data cannot be shared. or 4 channels of 8. This option is valid for all resource types. Also on success. The type of pResource must be one of the following. Not all Direct3D resources of the above types may be used for interoperability with CUDA. • IDirect3DSurface9: Only stand-alone objects of type IDirect3DSurface9 may be explicitly shared.9. 2. unsigned int Flags). • cudaD3D9RegisterFlagsNone: Specifies that CUDA will access this resource through a void*. this call will increase the internal reference count on pResource.4 cudaD3D9RegisterResource NAME cudaD3D9RegisterResource . size. • Any resources allocated in D3DPOOL_SYSTEMMEM may not be registered with CUDA.register a Direct3D resource for access by CUDA SYNOPSIS cudaError_t cudaD3D9RegisterResource(IDirect3DResource9* pResource. The pointer. If this call is successful then the application will be able to map and unmap this resource until it is unregistered through cudaD3D9UnregisterResource. and cudaD3D9ResourceGetMappedPitch respectively. In particular. • Textures which are not of a format which is 1. This reference count will be decremented when this resource is unregistered through cudaD3D9UnregisterResource. • IDirect3DIndexBuffer9: No notes. 82 . and pitch for each subresource of this resource may be queried through cudaD3D9ResourceGetMappedPointe cudaD3D9ResourceGetMappedSize. individual mipmap levels and faces of cube maps may not be registered directly. To access individual surfaces associated with a texture. The following are some limitations.1. The following value is allowed. • IDirect3DBaseTexture9: When a texture is registered all surfaces associated with the all mipmap levels of all faces of the texture will be accessible to CUDA.

g. asynchronous launches. cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer. cudaD3D9GetDirect3DDevice.• Surfaces of depth or stencil formats cannot be shared. SEE ALSO cudaD3D9GetDevice. cudaD3D9ResourceGetSurfaceDimensions. is a non-stand-alone IDirect3DSurface9) or is already registered then cudaErrorInvalidHandle is returned. cudaD3D9MapResources. cudaD3D9ResourceGetMappedSize. If Direct3D interoperability is not initialized on this context then is returned. If pResource is of incorrect type (e. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. If pResource cannot be registered then cudaErrorUnknown is returned. cudaD3D9UnmapResources. cudaD3D9UnregisterResource. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedPitch 83 .

cudaD3D9ResourceGetMappedPitch 84 . cudaD3D9UnmapResources. cudaD3D9GetDirect3DDevice. cudaD3D9MapResources. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. cudaD3D9ResourceGetMappedSize. asynchronous launches. cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer. If pResource is not registered then cudaErrorInvalidHandle is returned.unregister a Direct3D resource SYNOPSIS cudaError_t cudaD3D9UnregisterResource(IDirect3DResource9* pResource).5 cudaD3D9UnregisterResource NAME cudaD3D9UnregisterResource . DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again. cudaD3D9SetDirect3DDevice. SEE ALSO cudaD3D9GetDevice.9. cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9RegisterResource.1.

cudaD3D9ResourceSetMapFlags. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. SEE ALSO cudaD3D9GetDevice. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedPointer.1. IDirect3DResource9 **ppResources). This function provides the synchronization guarantee that any Direct3D calls issued before cudaD3D9MapResources will complete before any CUDA kernels issued after cudaD3D9MapResources begin. Direct3D should not access any resources while they are mapped by CUDA. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned. cudaD3D9GetDirect3DDevice. cudaD3D9ResourceGetMappedSize. cudaD3D9ResourceGetSurfaceDimensions.map Direct3D resources for access by CUDA SYNOPSIS cudaError_t cudaD3D9MapResources(unsigned int count. cudaD3D9ResourceGetMappedPitch 85 .9. If an application does so the results are undefined. asynchronous launches. The resources in ppResources may be accessed in CUDA kernels until they are unmapped. cudaD3D9UnmapResources.6 cudaD3D9MapResources NAME cudaD3D9MapResources . If any of ppResources are presently mapped for access by CUDA then cudaErrorUnknown is returned. cudaD3D9UnregisterResource. cudaD3D9RegisterResource. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.

cudaD3D9UnregisterResource. asynchronous launches. cudaD3D9ResourceSetMa cudaD3D9ResourceGetMappedPointer. cudaD3D9ResourceGetMappedPitch 86 . SEE ALSO cudaD3D9GetDevice. DESCRIPTION Unmaps the count Direct3D resources in ppResources. cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedSize.unmap Direct3D resources SYNOPSIS cudaError_t cudaD3D9UnmapResources(unsigned int count.1. cudaD3D9RegisterResource. This function provides the synchronization guarantee that any CUDA kernels issued before cudaD3D9UnmapResources will complete before any Direct3D calls issued after cudaD3D9UnmapResources begin. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. cudaD3D9MapResources.9. IDirect3DResource9** ppResources). cudaD3D9GetDirect3DDevice. If any of ppResources are not presently mapped for access by CUDA then cudaErrorUnknown is returned.7 cudaD3D9UnmapResources NAME cudaD3D9UnmapResources . If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned.

If pResource is presently mapped for access by CUDA then cudaErrorUnknown is returned.8 cudaD3D9ResourceSetMapFlags NAME cudaD3D9ResourceSetMapFlags . 87 . The Flags argument may be any of the following. so none of the data previously stored in the resource will be preserved.set usage flags for mapping a Direct3D resource SYNOPSIS cudaError_t cudaD3D9ResourceSetMapFlags(IDirect3DResource9 *pResource. Changes to flags will take effect the next time pResource is mapped. It is therefore assumed that this resource will be read from and written to by CUDA kernels. unsigned int Flags). If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. DESCRIPTION Set flags for mapping the Direct3D resource pResource. • cudaD3D9MapFlagsReadOnly: Specifies that CUDA kernels which access this resource will not write to this resource. asynchronous launches. • cudaD3D9MapFlagsNone: Specifies no hints about how this resource will be used. This is the default value. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.9. • cudaD3D9MapFlagsWriteDiscard: Specifies that CUDA kernels which access this resource will not read from this resource and will write over the entire contents of the resource.1.

cudaD3D9SetDirect3DDevice. cudaD3D9RegisterResource. cudaD3D9UnmapResources.SEE ALSO cudaD3D9GetDevice. cudaD3D9MapResources. cudaD3D9ResourceGetMappedSize. cudaD3D9GetDirect3DDevice. cudaD3D9ResourceGetMappedPitch 88 . cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceGetMappedPointer. cudaD3D9UnregisterResource.

cudaD3D9ResourceGetMappedPitch 89 . cudaD3D9ResourceGetMappedPointer. cudaD3D9ResourceGetMappedSize. cudaD3D9ResourceSetMapFlags. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle Note that this function may also return error codes from previous. cudaD3D9MapResources. cudaD3D9UnregisterResource. IDirect3DResource9* pResource. and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. If pResource is not of type IDirect3DBaseTexture9 or IDirect3DSurface9 or if pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. cudaD3D9UnmapResources. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. cudaD3D9GetDirect3DDevice. cudaD3D9SetDirect3DDevice. cudaD3D9RegisterResource.9 cudaD3D9ResourceGetSurfaceDimensions NAME cudaD3D9ResourceGetSurfaceDimensions .9. For 2D surfaces. size_t *pDepth. *pHeight. the value returned in *pDepth will be 0. DESCRIPTION Returns in *pWidth.get the dimensions of a registered surface SYNOPSIS cudaError_t cudaD3D9ResourceGetSurfaceDimensions(size_t* pWidth. unsigned int Level). and pDepth are optional. asynchronous launches. The parameters pWidth. Because anti-aliased surfaces may have multiple samples per pixel it is possible that the dimensions of a resource will be an integer factor larger than the dimensions reported by the Direct3D runtime. SEE ALSO cudaD3D9GetDevice. unsigned int Face. pHeight.1. size_t* pHeight.

If Level is invalid then cudaErrorInvalidValue is returned. If pResource is not registered then cudaErrorInvalidHandle is returned. The value set in pPointer may change every time that pResource is mapped. IDirect3DResource9* pResource. cudaD3D9ResourceGetMappedPitch 90 . If pResource is not mapped then cudaErrorUnknown is returned. For all other types Level must be 0. cudaD3D9MapResources. unsigned int Face. For all other types Face must be 0. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. SEE ALSO cudaD3D9GetDevice. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags. asynchronous launches. If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. If Face is invalid then cudaErrorInvalidValue is returned. Only mipmap level 0 is supported for now.9. cudaD3D9UnmapResources.get a pointer through which to access a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedPointer(void** pPointer. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. DESCRIPTION Returns in *pPointer the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. cudaD3D9SetDirect3DDevice. unsigned int Level). cudaD3D9UnregisterResource.1. cudaD3D9ResourceGetMappedSize. cudaD3D9RegisterResource.10 cudaD3D9ResourceGetMappedPointer NAME cudaD3D9ResourceGetMappedPointer . cudaD3D9GetDirect3DDevice.

If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. IDirect3DResource9* pResource. cudaD3D9ResourceGetMappedPitch 91 . If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. cudaD3D9GetDirect3DDevice. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags.9. cudaD3D9RegisterResource.1. cudaD3D9SetDirect3DDevice. cudaD3D9UnmapResources. cudaD3D9UnregisterResource.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedSize(size_t* pSize. SEE ALSO cudaD3D9GetDevice. unsigned int Level). cudaD3D9MapResources. unsigned int Face.11 cudaD3D9ResourceGetMappedSize NAME cudaD3D9ResourceGetMappedSize . For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. The value set in pSize may change every time that pResource is mapped. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. cudaD3D9ResourceGetMappedPointer.

If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. IDirect3DResource9* pResource. For a 2D surface the byte offset of the sample of at position x. unsigned int Face.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. 92 . For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer.y from the base pointer of the surface is If pResource is not of type IDirect3DBaseTexture9 or one of its sub-types or if pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.12 cudaD3D9ResourceGetMappedPitch NAME cudaD3D9ResourceGetMappedPitch . unsigned int Level).get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedPitch(size_t* pPitch.y. size_t* pPitchSlice. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. asynchronous launches.9. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. The values set in pPitch and pPitchSlice may change every time that pResource is mapped.

cudaD3D9ResourceGetMappedSize 93 . cudaD3D9RegisterResource.SEE ALSO cudaD3D9GetDevice. cudaD3D9ResourceGetMappedPointer. cudaD3D9UnmapResources. cudaD3D9UnregisterResource. cudaD3D9SetDirect3DDevice. cudaD3D9MapResources. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags. cudaD3D9GetDirect3DDevice.

Memory Management. Event Management. Execution Management. Error Handling 94 . Thread Management. Texture Reference Management.10 ErrorHandling RT NAME Error Handling DESCRIPTION This section describes the CUDA runtime application programming interface. cudaGetLastError cudaGetErrorString SEE ALSO Device Management. OpenGL Interoperability. Direct3D Interoperability.1. Stream Management.

1 cudaGetLastError NAME cudaGetLastError .1. 95 .10.returns the last error from a run-time call SYNOPSIS cudaError_t cudaGetLastError( void ) DESCRIPTION Returns the last error that was returned from any of the runtime calls in the same host thread and resets it to cudaSuccess. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.

cudaError 96 .SEE ALSO cudaGetErrorString.

DESCRIPTION Returns a message string from an error code.1.returns the message string from an error SYNOPSIS const char* cudaGetErrorString(cudaError_t error). RETURN VALUE char* pointer to a NULL-terminated string SEE ALSO cudaGetLastError 97 .10.2 cudaGetErrorString NAME cudaGetErrorString .

2 DriverApiReference NAME Driver API Reference DESCRIPTION This section describes the low-level CUDA driver application programming interface. MemoryManagement. ContextManagement. StreamManagement. SEE ALSO Initialization. OpenGlInteroperability. ExecutionControl. EventManagement. TextureReferenceManagement. ModuleManagement. Direct3dInteroperability 98 . DeviceManagement.

1 Initialization NAME Driver Initialization DESCRIPTION This section describes the low-level CUDA driver application programming interface. DeviceManagement. StreamManagement. ContextManagement. TextureReferenceManagement. ExecutionControl.2. cuInit SEE ALSO Initialization. OpenGlInteroperability. Direct3dInteroperability 99 . MemoryManagement. EventManagement. ModuleManagement.

asynchronous launches. any function from the driver API will return CUDA_ERROR_NOT_INITIALIZED. If cuInit() has not been called.1 cuInit NAME cuInit . DESCRIPTION Initializes the driver API and must be called before any other function from the driver API. SEE ALSO 100 .initialize the CUDA driver API SYNOPSIS CUresult cuInit( unsigned int Flags ). the Flags parameters must be 0.1.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NO_DEVICE Note that this function may also return error codes from previous. Currently.

ExecutionControl. OpenGlInteroperability. ContextManagement.2. DeviceManagement. EventManagement. MemoryManagement.2 DeviceManagement NAME Device Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. Direct3dInteroperability 101 . ModuleManagement. TextureReferenceManagement. StreamManagement. cuDeviceComputeCapability cuDeviceGet cuDeviceGetAttribute cuDeviceGetCount cuDeviceGetName cuDeviceGetProperties cuDeviceTotalMem SEE ALSO Initialization.

asynchronous launches.2. cuDeviceGetCount. cuDeviceGetName. cuDeviceGet. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. int* minor.returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major. SEE ALSO cuDeviceGetAttribute. DESCRIPTION Returns in *major and *minor the major and minor revision numbers that define the compute capability of device dev.1 cuDeviceComputeCapability NAME cuDeviceComputeCapability . CUdevice dev). cuDeviceGetProperties. cuDeviceTotalMem 102 .2.

SEE ALSO cuDeviceComputeCapability. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous.2.returns a device-handle SYNOPSIS CUresult cuDeviceGet(CUdevice* dev. cuDeviceGetName.2 cuDeviceGet NAME cuDeviceGet . DESCRIPTION Returns in *dev a device handle given an ordinal in the range [0. cuDeviceGetAttribute. cuDeviceGetCount. int ordinal).2. cuDeviceGetCount()-1]. cuDeviceTotalMem 103 . cuDeviceGetProperties.

The supported attributes are: • CU_DEVICE_ATTRIBUTE_MAX_THREADS_PER_BLOCK: maximum number of threads per block. • CU_DEVICE_ATTRIBUTE_GPU_OVERLAP: 1 if the device can concurrently copy memory between host and device while executing a kernel. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_X: maximum x-dimension of a block. 104 . CUdevice_attribute attrib. DESCRIPTION Returns in *value the integer value of the attribute attrib on device dev. texture base addresses aligned to textureAlign bytes do not need an offset applied to texture fetches. • CU_DEVICE_ATTRIBUTE_WARP_SIZE: warp size in threads.3 cuDeviceGetAttribute NAME cuDeviceGetAttribute . • CU_DEVICE_ATTRIBUTE_CLOCK_RATE: clock frequency in kilohertz. this amount is shared by all thread blocks simultaneously resident on a multiprocessor. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_Z: maximum z-dimension of a grid. • CU_DEVICE_ATTRIBUTE_TOTAL_CONSTANT_MEMORY: total amount of constant memory available on the device in bytes. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Z: maximum z-dimension of a block. • CU_DEVICE_ATTRIBUTE_MAX_REGISTERS_PER_BLOCK: maximum number of 32-bit registers available to a thread block. • CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK: maximum amount of shared memory available to a thread block in bytes. this number is shared by all thread blocks simultaneously resident on a multiprocessor. • CU_DEVICE_ATTRIBUTE_TEXTURE_ALIGNMENT: alignment requirement. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Y: maximum y-dimension of a block. CUdevice dev). • CU_DEVICE_ATTRIBUTE_MULTIPROCESSOR_COUNT: number of multiprocessors on the device. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_Y: maximum y-dimension of a grid.2.returns information about the device SYNOPSIS CUresult cuDeviceGetAttribute(int* value. or 0 if not. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_X: maximum x-dimension of a grid.2. • CU_DEVICE_ATTRIBUTE_MAX_PITCH: maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cuMemAllocPitch().

cuDeviceTotalMem 105 . asynchronous launches. SEE ALSO cuDeviceComputeCapability. cuDeviceGetCount. cuDeviceGetName.RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. cuDeviceGet. cuDeviceGetProperties.

DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. cuDeviceGetProperties. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuDeviceComputeCapability.0 that are available for execution. cuDeviceTotalMem 106 . cuDeviceGetName. cuDeviceGetCount() returns 0. If there is no such device.returns the number of compute-capable devices SYNOPSIS CUresult cuDeviceGetCount(int* count). cuDeviceGetAttribute. cuDeviceGet. asynchronous launches.2.4 cuDeviceGetCount NAME cuDeviceGetCount .2.

cuDeviceGet. DESCRIPTION Returns an ASCII string identifying the device dev in the NULL-terminated string pointed to by name. cuDeviceGetProperties. SEE ALSO cuDeviceComputeCapability. CUdevice dev). cuDeviceGetCount.5 cuDeviceGetName NAME cuDeviceGetName . int len. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous.returns an identifier string SYNOPSIS CUresult cuDeviceGetName(char* name. cuDeviceGetAttribute.2. cuDeviceTotalMem 107 . asynchronous launches.2. len specifies the maximum length of the string that may be returned.

2. int textureAlign } CUdevprop.2. • totalConstantMemory is the total amount of constant memory available on the device in bytes. DESCRIPTION Returns in *prop the properties of device dev. int clockRate.6 cuDeviceGetProperties NAME cuDeviceGetProperties . where: • maxThreadsPerBlock is the maximum number of threads per block. int sharedMemPerBlock. The CUdevprop structure is defined as: typedef struct CUdevprop_st { int maxThreadsPerBlock. • maxGridSize[3] is the maximum sizes of each dimension of a grid. int maxThreadsDim[3]. • maxThreadsDim[3] is the maximum sizes of each dimension of a block. int totalConstantMemory. CUdevice dev).get device properties SYNOPSIS CUresult cuDeviceGetProperties(CUdevprop* prop. int memPitch. • textureAlign is the alignment requirement. • sharedMemPerBlock is the total amount of shared memory available per block in bytes. int maxGridSize[3]. • memPitch is the maximum pitch allowed by the memory copy functions that involve memory regions allocated through cuMemAllocPitch(). int regsPerBlock. • clockRate is the clock frequency in kilohertz. int SIMDWidth. • SIMDWidth is the warp size. • regsPerBlock is the total number of registers available per block. texture base addresses that are aligned to textureAlign bytes do not need an offset applied to texture fetches. 108 .

asynchronous launches. cuDeviceGetCount. cuDeviceGet. cuDeviceGetAttribute. cuDeviceGetName.RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. SEE ALSO cuDeviceComputeCapability. cuDeviceTotalMem 109 .

returns the total amount of memory on the device SYNOPSIS CUresult cuDeviceTotalMem( unsigned int* bytes. asynchronous launches. cuDeviceGetAttribute. CUdevice dev ). cuDeviceGetName.2. SEE ALSO cuDeviceComputeCapability. cuDeviceGet. cuDeviceGetProperties 110 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. DESCRIPTION Returns in *bytes the total amount of memory available on the device dev in bytes.7 cuDeviceTotalMem NAME cuDeviceTotalMem .2. cuDeviceGetCount.

TextureReferenceManagement.3 ContextManagement NAME Context Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. cuCtxAttach cuCtxCreate cuCtxDestroy cuCtxDetach cuCtxGetDevice cuCtxPopCurrent cuCtxPushCurrent cuCtxSynchronize SEE ALSO Initialization.2. Direct3dInteroperability 111 . DeviceManagement. ContextManagement. EventManagement. ExecutionControl. StreamManagement. OpenGlInteroperability. ModuleManagement. MemoryManagement.

cuCtxDetach. asynchronous launches. SEE ALSO cuCtxCreate.3. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.2.1 cuCtxAttach NAME cuCtxAttach . DESCRIPTION Increments the usage count of the context and passes back a context handle in *pCtx that must be passed to cuCtxDetach() when the application is done with the context. the Flags parameter must be 0.increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx. cuCtxAttach() fails if there is no context current to the thread. cuCtxGetDevice. unsigned int Flags). cuCtxSynchronize 112 . Currently.

113 . The two LSBs of the Flags parameter can be used to control how the OS thread which owns the CUDA context at the time of an API call interacts with the OS scheduler when waiting for results from the GPU. • CU_CTX_SCHED_SPIN: Instruct CUDA to actively spin when waiting for results from the GPU. DESCRIPTION Creates a new CUDA context and associates it with the calling thread. uses a heuristic based on the number of active CUDA contexts in the process C and the number of logical processors in the system P. • CU_CTX_SCHED_AUTO: The default value if the Flags parameter is zero.3. This can increase latency when waiting for the GPU.2. If C > P then CUDA will yield to other OS threads when waiting for the GPU. but may lower the performance of CPU threads if they are performing work in parallel with the CUDA thread.2 cuCtxCreate NAME cuCtxCreate . If a context is already current to the thread. but can increase the performance of CPU threads performing work in parallel with the GPU. it is supplanted by the newly created context and may be restored by a subsequent call to cuCtxPopCurrent(). The context is created with a usage count of 1 and the caller of cuCtxCreate() must call cuCtxDestroy() or cuCtxDetach() when done using the context. This can decrease latency when waiting for the GPU. • CU_CTX_SCHED_YIELD: Instruct CUDA to yield its thread when waiting for results from the GPU. unsigned int Flags.create a CUDA context SYNOPSIS CUresult cuCtxCreate(CUcontext* pCtx. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_DEVICE CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. The Flags parameter is described below. asynchronous launches. CUdevice dev). otherwise CUDA will not yield while waiting for results and actively spin on the processor.

cuCtxPopCurrent 114 .SEE ALSO cuCtxAttach. cuCtxDestroy. cuCtxPushCurrent. cuCtxDetach.

Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function.destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). asynchronous launches. cuCtxDetach. cuCtxPushCurrent.3. cuCtxPopCurrent 115 . cuCtxAttach. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.3 cuCtxDestroy NAME cuCtxDestroy . this function fails. DESCRIPTION Destroys the given CUDA context.2. SEE ALSO cuCtxCreate. If the context usage count is not equal to 1. or the context is current to any CPU thread other than the current one.

cuCtxPopCurrent 116 .2.3.decrement a context’s usage-count SYNOPSIS CUresult cuCtxDetach(CUcontext ctx). cuCtxDestroy. cuCtxAttach. cuCtxPushCurrent.4 cuCtxDetach NAME cuCtxDetach . asynchronous launches. The context must be a handle that was passed back by cuCtxCreate() or cuCtxAttach(). and destroys the context if the usage count goes to 0. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. and must be current to the calling thread. DESCRIPTION Decrements the usage count of the context. SEE ALSO cuCtxCreate.

SEE ALSO cuCtxCreate.5 cuCtxGetDevice NAME cuCtxGetDevice . asynchronous launches. DESCRIPTION Returns in *device the ordinal of the current context’s device.return device-ID for current context SYNOPSIS CUresult cuCtxGetDevice(CUdevice* device). cuCtxAttach.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuCtxSynchronize 117 . cuCtxDetach.3.

DESCRIPTION Pops the current CUDA context from the CPU thread.6 cuCtxPopCurrent NAME cuCtxPopCurrent . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. cuCtxPushCurrent 118 . The CUDA context must have a usage count of 1. CUDA contexts have a usage count of 1 upon creation. SEE ALSO cuCtxCreate.pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx). cuCtxAttach. asynchronous launches.2.3. If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called. Floating contexts may be destroyed by calling cuCtxDestroy(). cuCtxDestroy. the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach(). cuCtxDetach. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent(). cuCtxPopCurrent() passes back the context handle in *pctx. this function makes that context current to the CPU thread again. If successful.

e. cuCtxAttach." i.attach floating context to CPU thread SYNOPSIS CUresult cuCtxPushCurrent(CUcontext ctx). The specified context becomes the CPU thread’s current context. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuCtxDestroy.3. Contexts are made to float by calling cuCtxPopCurrent(). cuCtxDetach.2.7 cuCtxPushCurrent NAME cuCtxPushCurrent . SEE ALSO cuCtxCreate. The previous current context may be made current again by calling cuCtxDestroy() or cuCtxPopCurrent(). The context must be "floating. not attached to any thread. asynchronous launches. cuCtxPopCurrent 119 . DESCRIPTION Pushes the given context onto the CPU thread’s stack of current contexts. so all CUDA functions that operate on the current context are affected.

block for a context’s tasks to complete SYNOPSIS CUresult cuCtxSynchronize(void).2. SEE ALSO cuCtxCreate.3. cuCtxDetach. asynchronous launches. cuCtxAttach. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. DESCRIPTION Blocks until the device has completed all preceding requested tasks.8 cuCtxSynchronize NAME cuCtxSynchronize . cuCtxSynchronize() returns an error if one of the preceding tasks failed. cuCtxGetDevice 120 .

ExecutionControl. TextureReferenceManagement. MemoryManagement. StreamManagement. ContextManagement. OpenGlInteroperability. cuModuleGetFunction cuModuleGetGlobal cuModuleGetTexRef cuModuleLoad cuModuleLoadData cuModuleLoadFatBinary cuModuleUnload SEE ALSO Initialization. EventManagement. Direct3dInteroperability 121 . ModuleManagement.4 ModuleManagement NAME Module Management DESCRIPTION This section describes the low-level CUDA driver application programming interface.2. DeviceManagement.

cuModuleLoadFatBinary. DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod.2. const char* funcname). cuModuleLoadData. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous. cuModuleGetTexRef 122 . cuModuleGetGlobal. If no function of that name exists. CUmodule mod.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func. cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND.4. asynchronous launches. cuModuleUnload.1 cuModuleGetFunction NAME cuModuleGetFunction . SEE ALSO cuModuleLoad.

If no variable of that name exists. asynchronous launches. If one of them is null. unsigned int* bytes. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND. CUmodule mod. SEE ALSO cuModuleLoad.2. cuModuleGetTexRef 123 . it is ignored. cuModuleGetFunction. Both parameters devPtr and bytes are optional. const char* globalname). cuModuleUnload.4.2 cuModuleGetGlobal NAME cuModuleGetGlobal . DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod. cuModuleLoadData.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr. cuModuleLoadFatBinary.

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

SYNOPSIS
CUresult cuModuleGetTexRef(CUtexref* texRef, CUmodule hmod, const char* texrefname);

DESCRIPTION
Returns in *texref the handle of the texture reference of name texrefname in the module mod. If no texture reference of that name exists, cuModuleGetTexRef() returns CUDA_ERROR_NOT_FOUND. This texture reference handle should not be destroyed, since it will be destroyed when the module is unloaded.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

SYNOPSIS
CUresult cuModuleLoad(CUmodule* mod, const char* filename);

DESCRIPTION
Takes a file name filename and loads the corresponding module mod into the current context. The CUDA driver API does not attempt to lazily allocate the resources needed by a module; if the memory for functions and data (constant and global) needed by the module cannot be allocated, cuModuleLoad() fails. The file should be a cubin file as output by nvcc.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_FILE_NOT_FOUND Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

SYNOPSIS
CUresult cuModuleLoadData(CUmodule* mod, const void* image);

DESCRIPTION
Takes a pointer image and loads the corresponding module mod into the current context. The pointer may be obtained by mapping a cubin file, passing a cubin file as a text string, or incorporating a cubin object into the executable resources and using operation system calls such as WindowsâĂŹ FindResource() to obtain the pointer.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

SYNOPSIS
CUresult cuModuleLoadFatBinary(CUmodule* mod, const void* fatBin);

DESCRIPTION
Takes a pointer fatBin and loads the corresponding module mod into the current context. The pointer represents a fat binary object, which is a collection of different cubin files, all representing the same device code but compiled and optimized for different architectures. There is currently no documented API for constructing and using fat binary objects by programmers, and therefore this function is an internal function in this version of CUDA. More information can be found in the nvcc document.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_NO_BINARY_FOR_GPU Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

127

cuModuleLoadData. SEE ALSO cuModuleLoad.7 cuModuleUnload NAME cuModuleUnload . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuModuleGetFunction. cuModuleLoadFatBinary. asynchronous launches. cuModuleGetGlobal. cuModuleGetTexRef 128 .unloads a module SYNOPSIS CUresult cuModuleUnload(CUmodule mod).4.2. DESCRIPTION Unloads a module mod from the current context.

cuStreamCreate cuStreamDestroy cuStreamQuery cuStreamSynchronize SEE ALSO Initialization. ModuleManagement. OpenGlInteroperability. ExecutionControl. MemoryManagement. TextureReferenceManagement. ContextManagement.2. StreamManagement.5 StreamManagement NAME Stream Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. Direct3dInteroperability 129 . EventManagement. DeviceManagement.

5. At present. SEE ALSO cuStreamQuery. cuStreamDestroy 130 . flags is required to be 0. DESCRIPTION Creates a stream.1 cuStreamCreate NAME cuStreamCreate . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. asynchronous launches.create a stream SYNOPSIS CUresult cuStreamCreate(CUstream* stream. unsigned int flags).2. cuStreamSynchronize.

cuStreamSynchronize 131 . asynchronous launches. DESCRIPTION Destroys the stream. SEE ALSO cuStreamCreate.2 cuStreamDestroy NAME cuStreamDestroy .2.destroys a stream SYNOPSIS CUresult cuStreamDestroy(CUstream stream). cuStreamQuery.5. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous.

cuStreamDestroy 132 .2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_READY Note that this function may also return error codes from previous. cuStreamSynchronize. SEE ALSO cuStreamCreate.3 cuStreamQuery NAME cuStreamQuery . DESCRIPTION Returns CUDA_SUCCESS if all operations in the stream have completed. or CUDA_ERROR_NOT_READY if not. asynchronous launches.determine status of a compute stream SYNOPSIS CUresult cuStreamQuery(CUstream stream).5.

SEE ALSO cuStreamCreate. DESCRIPTION Blocks until the device has completed all operations in the stream.4 cuStreamSynchronize NAME cuStreamSynchronize .2.block until a stream’s tasks are completed SYNOPSIS CUresult cuStreamSynchronize(CUstream stream).5. asynchronous launches. cuStreamQuery. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuStreamDestroy 133 .

DeviceManagement. EventManagement. ExecutionControl. TextureReferenceManagement.2. OpenGlInteroperability. Direct3dInteroperability 134 .6 EventManagement NAME Event Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. StreamManagement. MemoryManagement. ContextManagement. cuEventCreate cuEventDestroy cuEventElapsedTime cuEventQuery cuEventRecord cuEventSynchronize SEE ALSO Initialization. ModuleManagement.

flags is required to be 0. SEE ALSO cuEventRecord. cuEventDestroy. cuEventElapsedTime 135 . cuEventQuery.creates an event SYNOPSIS CUresult cuEventCreate(CUevent* event.6. cuEventSynchronize.1 cuEventCreate NAME cuEventCreate .2. DESCRIPTION Creates an event. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. asynchronous launches. unsigned int flags). At present.

cuEventSynchronize.2. cuEventRecord. DESCRIPTION Destroys the event.6. cuEventQuery.destroys an event SYNOPSIS CUresult cuEventDestroy(CUevent event). SEE ALSO cuEventCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous.2 cuEventDestroy NAME cuEventDestroy . cuEventElapsedTime 136 . asynchronous launches.

2. If either event has been recorded with a non-zero stream. cuEventSynchronize. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. CUevent end). the result is undefined. cuEventRecord.5 microseconds).3 cuEventElapsedTime NAME cuEventElapsedTime . If either event has not been recorded yet. cuEventQuery. asynchronous launches. cuEventDestroy 137 . CUevent start.computes the elapsed time between two events SYNOPSIS CUresult cuEventDestroy(float* time. this function returns CUDA_ERROR_INVALID_VALUE. SEE ALSO cuEventCreate.6. DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0.

cuEventDestroy. cuEventRecord. If cuEventRecord() has not been called on this event. cuEventSynchronize. SEE ALSO cuEventCreate. the function returns CUDA_ERROR_INVALID_VALUE RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_READY Note that this function may also return error codes from previous.6.4 cuEventQuery NAME cuEventQuery . or CUDA_ERROR_NOT_READY if not.2. DESCRIPTION Returns CUDA_SUCCESS if the event has actually been recorded.queries an event’s status SYNOPSIS CUresult cuEventQuery(CUevent event). cuEventElapsedTime 138 . asynchronous launches.

SEE ALSO cuEventCreate. cuEventSynchronize. cuEventDestroy. cuEventQuery() and/or cuEventSynchronize() must be used to determine when the event has actually been recorded. it is recorded after all preceding operations in the CUDA context have been completed. this function returns CUDA_ERROR_INVALID_VALUE. otherwise. Since this operation is asynchronous. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuEventQuery.records an event SYNOPSIS CUresult cuEventRecord(CUevent event. DESCRIPTION Records an event. the event is recorded after all preceding operations in the stream have been completed. cuEventElapsedTime 139 .2.6.5 cuEventRecord NAME cuEventRecord . If stream is non-zero. CUstream stream). If cuEventRecord() has previously been called and the event has not been recorded yet.

SEE ALSO cuEventCreate.6.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuEventElapsedTime 140 . the function returns CUDA_ERROR_INVALID_VALUE.waits for an event to complete SYNOPSIS CUresult cuEventSynchronize(CUevent event). cuEventDestroy.6 cuEventSynchronize NAME cuEventSynchronize . cuEventRecord. asynchronous launches. DESCRIPTION Blocks until the event has actually been recorded. If cuEventRecord() has not been called on this event. cuEventQuery.

7 ExecutionControl NAME Execution Control DESCRIPTION This section describes the low-level CUDA driver application programming interface. OpenGlInteroperability. TextureReferenceManagement. MemoryManagement. cuLaunch cuLaunchGrid cuParamSetSize cuParamSetTexRef cuParamSetf cuParamSeti cuParamSetv cuFuncSetBlockShape cuFuncSetSharedSize SEE ALSO Initialization. Direct3dInteroperability 141 . DeviceManagement. ModuleManagement. ContextManagement. EventManagement.2. ExecutionControl. StreamManagement.

7. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_LAUNCH_INCOMPATIBLE_TEXTURING Note that this function may also return error codes from previous. asynchronous launches. SEE ALSO cuFuncSetBlockShape. cuParamSetf. cuParamSetv. The block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). cuParamSeti. cuParamSetSize. cuLaunchGrid 142 .1 cuLaunch NAME cuLaunch . cuFuncSetSharedSize.2. DESCRIPTION Invokes the kernel func on a 1ÃŮ1 grid of blocks.launches a CUDA function SYNOPSIS CUresult cuLaunch(CUfunction func). cuParamSetTexRef.

int grid_width. CUstream stream). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_LAUNCH_INCOMPATIBLE_TEXTURING Note that this function may also return error codes from previous. int grid_height. CUresult cuLaunchGridAsync(CUfunction func. int grid_height).2 cuLaunchGrid NAME cuLaunchGrid . cuParamSetf. cuFuncSetSharedSize. cuParamSeti.2. cuParamSetTexRef. Each block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). SEE ALSO cuFuncSetBlockShape. int grid_width. asynchronous launches. DESCRIPTION Invokes the kernel on a grid_width x grid_height grid of blocks. cuParamSetv. cuParamSetSize.7. cuLaunch 143 . cuLaunchGridAsync() can optionally be associated to a stream by passing a non-zero stream argument.launches a CUDA function SYNOPSIS CUresult cuLaunchGrid(CUfunction func.

DESCRIPTION Sets through numbytes the total size in bytes needed by the function parameters of function func.3 cuParamSetSize NAME cuParamSetSize .2. SEE ALSO cuFuncSetBlockShape. cuParamSetf. cuLaunchGrid 144 . cuFuncSetSharedSize. cuParamSetv. asynchronous launches.sets the parameter-size for the function SYNOPSIS CUresult cuParamSetSize(CUfunction func. cuLaunch.7. unsigned int numbytes). cuParamSeti. cuParamSetTexRef. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

cuLaunch. cuParamSetf.7. cuLaunchGrid 145 .adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(CUfunction func. the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT. int texunit. cuParamSeti.4 cuParamSetTexRef NAME cuParamSetTexRef . cuFuncSetSharedSize. DESCRIPTION Makes the CUDA array or linear memory bound to the texture reference texRef available to a device program as a texture. SEE ALSO cuFuncSetBlockShape. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. cuParamSetSize.2. cuParamSetv. In this version of CUDA. CUtexref texRef).

int offset. asynchronous launches. cuParamSetv. SEE ALSO cuFuncSetBlockShape. cuLaunchGrid 146 .5 cuParamSetf NAME cuParamSetf .2. offset is a byte offset. cuParamSeti. DESCRIPTION Sets a floating point parameter that will be specified the next time the kernel corresponding to func will be invoked. cuParamSetTexRef. cuParamSetSize.7.adds a floating-point parameter to the function’s argument list SYNOPSIS CUresult cuParamSetf(CUfunction func. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuLaunch. float value). cuFuncSetSharedSize.

7.2. cuLaunch. SEE ALSO cuFuncSetBlockShape.adds an integer parameter to the function’s argument list SYNOPSIS CUresult cuParamSeti(CUfunction func. cuLaunchGrid 147 .6 cuParamSeti NAME cuParamSeti . asynchronous launches. cuParamSetf. cuFuncSetSharedSize. offset is a byte offset. unsigned int value). cuParamSetTexRef. int offset. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Sets an integer parameter that will be specified the next time the kernel corresponding to func will be invoked. cuParamSetSize. cuParamSetv.

asynchronous launches. int offset. cuParamSetSize. cuLaunch. cuFuncSetSharedSize. cuLaunchGrid 148 . unsigned int numbytes). SEE ALSO cuFuncSetBlockShape.7 cuParamSetv NAME cuParamSetv . offset is a byte offset. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuParamSetf. cuParamSeti. DESCRIPTION Copies an arbitrary amount of data into the parameter space of the kernel corresponding to func. cuParamSetTexRef.adds arbitrary data to the function’s argument list SYNOPSIS CUresult cuParamSetv(CUfunction func.2.7. void* ptr.

2.8 cuFuncSetBlockShape NAME cuFuncSetBlockShape . Y and Z dimensions of the thread blocks that are created when the kernel given by func is launched. int y. cuParamSeti. cuLaunch.7. cuParamSetTexRef. cuParamSetSize. SEE ALSO cuFuncSetSharedSize. cuParamSetf. cuParamSetv. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. int z). int x.sets the block-dimensions for the function SYNOPSIS CUresult cuFuncSetBlockShape(CUfunction func. DESCRIPTION Specifies the X. asynchronous launches. cuLaunchGrid 149 .

cuParamSetSize.7. cuParamSetv.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Sets through bytes the amount of shared memory that will be available to each thread block when the kernel given by func is launched. cuParamSetf.2. cuLaunchGrid 150 . cuParamSeti. cuParamSetTexRef. unsigned int bytes). cuLaunch. asynchronous launches. SEE ALSO cuFuncSetBlockShape.

8 MemoryManagement NAME Memory Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. ContextManagement. DeviceManagement. EventManagement. ModuleManagement. MemoryManagement. Direct3dInteroperability 151 . OpenGlInteroperability. TextureReferenceManagement. ExecutionControl. StreamManagement. cuArrayCreate cuArray3DCreate cuArrayDestroy cuArrayGetDescriptor cuArray3DGetDescriptor cuMemAlloc cuMemAllocHost cuMemAllocPitch cuMemFree cuMemFreeHost cuMemGetAddressRange cuMemGetInfo cuMemcpy2D cuMemcpy3D cuMemcpyAtoA cuMemcpyAtoD cuMemcpyAtoH cuMemcpyDtoA cuMemcpyDtoD cuMemcpyDtoH cuMemcpyHtoA cuMemcpyHtoD cuMemset cuMemset2D SEE ALSO Initialization.2.

Format = CU_AD_FORMAT_FLOAT. CU_AD_FORMAT_SIGNED_INT8 = 0x08. two-dimensional. • Format specifies the format of the elements. it may be 1. CU_AD_FORMAT_UNSIGNED_INT32 = 0x03.1 cuArrayCreate NAME cuArrayCreate . const CUDA_ARRAY_DESCRIPTOR* desc). CU_AD_FORMAT_UNSIGNED_INT16 = 0x02. CU_AD_FORMAT_SIGNED_INT32 = 0x0a. CU_AD_FORMAT_HALF = 0x10. The CUDA_ARRAY_DESCRIPTOR structure is defined as such: typedef struct { unsigned int Width. CU_AD_FORMAT_SIGNED_INT16 = 0x09. CU_AD_FORMAT_FLOAT = 0x20 } CUarray_format. unsigned int NumChannels. 152 . unsigned int Height. 2 or 4. desc.2. CUarray_format is defined as such: typedef enum CUarray_format_enum { CU_AD_FORMAT_UNSIGNED_INT8 = 0x01.. DESCRIPTION Creates a CUDA array according to the CUDA_ARRAY_DESCRIPTOR structure desc and returns a handle to the new CUDA array in *array. where: • Width and Height are the width and height of the CUDA array (in elements). Here are examples of CUDA array descriptions: • Description for a CUDA array of 2048 floats: CUDA_ARRAY_DESCRIPTOR desc.creates a 1D or 2D CUDA array SYNOPSIS CUresult cuArrayCreate(CUarray* array.8. } CUDA_ARRAY_DESCRIPTOR. otherwise. the CUDA array is one-dimensional if height is 0. • NumChannels specifies the number of packed components per CUDA array element. CUarray_format Format.

cuMemAllocPitch. desc. cuArrayGetDescriptor.Height = 64. desc. cuMemset. desc. desc.NumChannels = 4.Height = height.FormatFlags = CU_AD_FORMAT_UNSIGNED_INTS. asynchronous launches. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. • Description for a width x height CUDA array of 16-bit elements.Height = height. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. desc. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY_DESCRIPTOR desc.NumChannels = 1. desc. cuMemAllocHost. cuArrayDestroy.desc.FormatFlags = CU_AD_FORMAT_HALF. desc. desc.NumChannels = 1. desc. desc.Width = width. cuMemFreeHost.Height = 1. desc. desc. • Description for a width x height CUDA array of 64-bit. each of which is two 8-bit unsigned chars: CUDA_ARRAY_DESCRIPTOR arrayDesc. SEE ALSO cuMemGetInfo. cuMemset2D 153 . cuMemAlloc.Format = CU_AD_FORMAT_FLOAT. cuMemFree.Width = width. desc.Width = 2048. desc.Width = 64.NumChannels = 2. cuMemGetAddressRange.

CUarray_format is defined as such: typedef enum CUarray_format_enum { CU_AD_FORMAT_UNSIGNED_INT8 = 0x01. For now. CU_AD_FORMAT_SIGNED_INT8 = 0x08. CU_AD_FORMAT_SIGNED_INT16 = 0x09. • Format specifies the format of the elements. where: • Width. the CUDA array is one-dimensional if height and depth are 0.. • Flags provides for future features. unsigned int NumChannels.8. CUarray_format Format. } CUDA_ARRAY3D_DESCRIPTOR. height and depth of the CUDA array (in elements). it must be set to 0. two-dimensional if depth is 0. and threedimensional otherwise. The CUDA_ARRAY3D_DESCRIPTOR structure is defined as such: typedef struct { unsigned int Width. CU_AD_FORMAT_UNSIGNED_INT16 = 0x02.2 cuArray3DCreate NAME cuArray3DCreate . it may be 1. CU_AD_FORMAT_HALF = 0x10. 2 or 4. • NumChannels specifies the number of packed components per CUDA array element. unsigned int Flags. DESCRIPTION Creates a CUDA array according to the CUDA_ARRAY3D_DESCRIPTOR structure desc and returns a handle to the new CUDA array in *array. CU_AD_FORMAT_SIGNED_INT32 = 0x0a. const CUDA_ARRAY3D_DESCRIPTOR* desc). Height and Depth are the width. CU_AD_FORMAT_FLOAT = 0x20 } CUarray_format. unsigned int Depth.creates a CUDA array SYNOPSIS CUresult cuArray3DCreate(CUarray* array. CU_AD_FORMAT_UNSIGNED_INT32 = 0x03. Here are examples of CUDA array descriptions: 154 .2. unsigned int Height.

cuMemGetAddressRange. asynchronous launches. • Description for a width x height x depth CUDA array of 64-bit. desc. desc.Format = CU_AD_FORMAT_FLOAT. desc.• Description for a CUDA array of 2048 floats: CUDA_ARRAY3D_DESCRIPTOR desc. desc.Width = width. cuMemAllocPitch.NumChannels = 1. desc. desc. desc. SEE ALSO cuMemGetInfo.Width = 2048. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.Height = 0. desc.Depth = 0. cuArrayDestroy 155 .FormatFlags = CU_AD_FORMAT_HALF. desc.Format = CU_AD_FORMAT_FLOAT. desc. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY3D_DESCRIPTOR desc. desc.Height = height.NumChannels = 4.NumChannels = 1.Depth = 0.Width = 64. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. cuMemFreeHost. cuMemAllocHost. cuArray3DGetDescriptor. cuMemAlloc.Depth = depth. desc. desc. desc. desc. cuMemFree.Height = 64.

cuMemset. cuMemFreeHost. cuMemset2D 156 . asynchronous launches. cuMemAlloc.8. cuMemAllocPitch. cuMemAllocHost. cuMemGetAddressRange. cuArrayCreate. SEE ALSO cuMemGetInfo. cuMemFree. DESCRIPTION Destroys the CUDA array array. cuArrayGetDescriptor. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ARRAY_IS_MAPPED Note that this function may also return error codes from previous.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array).3 cuArrayDestroy NAME cuArrayDestroy .2.

It is useful for subroutines that have been passed a CUDA array. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuArray3DGetDescriptor.2.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor . but need to know the CUDA array parameters for validation or other purposes. cuArray3DCreate.get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc. cuArrayDestroy 157 .8. SEE ALSO cuArrayCreate. asynchronous launches.

SEE ALSO cuArrayCreate. but need to know the CUDA array parameters for validation or other purposes.8. CUarray array). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuArray3DCreate. It is useful for subroutines that have been passed a CUDA array.get a 3D CUDA array descriptor SYNOPSIS CUresult cuArray3DGetDescriptor(CUDA_ARRAY3D_DESC *arrayDesc. asynchronous launches.2.5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor . DESCRIPTION Returns in *arrayDesc a descriptor containing information on the format and dimensions of the CUDA array array. cuArrayDestroy 158 . cuArrayGetDescriptor.

8. cuArrayGetDescriptor. cuArrayCreate. cuMemFreeHost.2. cuMemFree. asynchronous launches. cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. unsigned int count). cuMemset2D 159 . DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuMemAllocHost. The memory is not cleared. cuMemGetAddressRange.6 cuMemAlloc NAME cuMemAlloc . The allocated memory is suitably aligned for any kind of variable. If count is 0. cuArrayDestroy. SEE ALSO cuMemGetInfo. cuMemset. cuMemAllocPitch.

Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance. this function is best used sparingly to allocate staging areas for data exchange between host and device. cuMemGetAddressRange. DESCRIPTION Allocates count bytes of host memory that is page-locked and accessible to the device. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cuMemcpy().allocates page-locked host memory SYNOPSIS CUresult cuMemAllocHost(void** hostPtr. cuArrayDestroy. cuMemAllocPitch. asynchronous launches. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc(). cuArrayGetDescriptor. cuMemFree. cuMemFreeHost. unsigned int count). since it reduces the amount of memory available to the system for paging. As a result. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuMemset2D 160 .7 cuMemAllocHost NAME cuMemAllocHost .2.8. SEE ALSO cuMemGetInfo. cuMemAlloc. cuArrayCreate. Since the memory can be accessed directly by the device. cuMemset.

161 . unsigned int elementSizeBytes). the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * Pitch) + Column.2. unsigned int height.8. elementSizeBytes specifies the size of the largest reads and writes that will be performed on the memory range. elementSizeBytes may be 4. asynchronous launches. this is especially true if the application will be performing 2D memory copies between different regions of device memory (whether linear memory or CUDA arrays).8 cuMemAllocPitch NAME cuMemAllocPitch . used to compute addresses within the 2D array. The function may pad the allocation to ensure that corresponding pointers in any given row will continue to meet the alignment requirements for coalescing as the address is updated from row to row. The intended usage of pitch is as a separate parameter of the allocation. The pitch returned by cuMemAllocPitch() is guaranteed to work with cuMemcpy2D() under all circumstances. it is recommended that programmers consider performing pitch allocations using cuMemAllocPitch(). 8 or 16 (since coalesced memory transactions are not possible on other data sizes). the kernel will run correctly. For allocations of 2D arrays. If elementSizeBytes is smaller than the actual read/write size of a kernel. DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. but possibly at reduced speed. unsigned int* pitch. Due to alignment restrictions in the hardware. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. Given the row and column of an array element of type T. unsigned int widthInBytes.allocates device memory SYNOPSIS CUresult cuMemAllocPitch(CUdeviceptr* devPtr. The pitch returned in *pitch by cuMemAllocPitch() is the width in bytes of the allocation.

cuArrayDestroy. cuMemGetAddressRange. cuMemAlloc. cuMemFreeHost. cuArrayCreate. cuMemFree.SEE ALSO cuMemGetInfo. cuMemAllocHost. cuArrayGetDescriptor. cuMemset. cuMemset2D 162 .

cuMemset.9 cuMemFree NAME cuMemFree .frees device memory SYNOPSIS CUresult cuMemFree(CUdeviceptr devPtr). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuMemGetInfo. cuMemset2D 163 . DESCRIPTION Frees the memory space pointed to by devPtr. cuArrayDestroy. which must have been returned by a previous call to cuMemMalloc() or cuMemMallocPitch(). cuMemAllocPitch. cuMemAlloc. cuMemGetAddressRange. cuMemFreeHost. cuArrayGetDescriptor. cuArrayCreate. asynchronous launches.2.8. cuMemAllocHost.

8. cuArrayDestroy.10 cuMemFreeHost NAME cuMemFreeHost . which must have been returned by a previous call to cuMemAllocHost(). SEE ALSO cuMemGetInfo. cuMemAllocPitch. cuArrayGetDescriptor. cuMemset2D 164 . cuMemFree. cuMemset. cuArrayCreate. DESCRIPTION Frees the memory space pointed to by hostPtr. cuMemGetAddressRange. cuMemAlloc. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemAllocHost. asynchronous launches.2.frees page-locked host memory SYNOPSIS CUresult cuMemFreeHost(void* hostPtr).

cuMemAllocPitch.2. CUdeviceptr devPtr). cuMemFreeHost.8. cuMemAlloc. unsigned int* size. cuMemAllocHost. DESCRIPTION Returns the base address in *basePtr and size and *size of the allocation by cuMemAlloc() or cuMemAllocPitch() that contains the input pointer devPtr. it is ignored. cuArrayCreate. asynchronous launches. cuArrayGetDescriptor. cuMemFree. Both parameters basePtr and size are optional. cuMemset. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.get information on memory allocations SYNOPSIS CUresult cuMemGetAddressRange(CUdeviceptr* basePtr.11 cuMemGetAddressRange NAME cuMemGetAddressRange . SEE ALSO cuMemGetInfo. If one of them is null. cuArrayDestroy. cuMemset2D 165 .

gets free and total memory SYNOPSIS CUresult cuMemGetInfo(unsigned int* free. cuArrayGetDescriptor. cuMemGetAddressRange. asynchronous launches. cuMemFree. SEE ALSO cuMemAlloc. the free and total amount of memory available for allocation by the CUDA context. cuMemAllocPitch. in bytes. cuArrayCreate.12 cuMemGetInfo NAME cuMemGetInfo . cuMemset2D 166 . cuMemFreeHost. unsigned int* total). cuMemset.2. DESCRIPTION Returns in *free and *total respectively.8. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuArrayDestroy. cuMemAllocHost.

unsigned int srcPitch. srcArray is ignored. CUstream stream). CU_MEMORYTYPE_DEVICE = 0x02. If srcMemoryType is CU_MEMORYTYPE_DEVICE. CUdeviceptr srcDevice. srcDevice and srcPitch specify the (device) base address of the source data and the bytes per row to apply.8. unsigned int dstXInBytes. unsigned int WidthInBytes. const void *srcHost. DESCRIPTION Perform a 2D memory copy according to the parameters specified in copyParam. where: • srcMemoryType and dstMemoryType specify the type of memory of the source and destination. The CUDA_MEMCPY2D structure is defined as such: typedef struct CUDA_MEMCPY2D_st { unsigned int srcXInBytes. CUarray dstArray. CUarray srcArray.2.copies memory for 2D arrays SYNOPSIS CUresult cuMemcpy2D(const CUDA_MEMCPY2D* copyParam). srcY. If srcMemoryType is CU_MEMORYTYPE_HOST. CU_MEMORYTYPE_ARRAY = 0x03 } CUmemorytype. CUdeviceptr dstDevice. CUresult cuMemcpy2DUnaligned(const CUDA_MEMCPY2D* copyParam). CUmemorytype_enum is defined as such: typedef enum CUmemorytype_enum { CU_MEMORYTYPE_HOST = 0x01. CUmemorytype dstMemoryType.13 cuMemcpy2D NAME cuMemcpy2D . CUresult cuMemcpy2DAsync(const CUDA_MEMCPY2D* copyParam. unsigned int Height. unsigned int dstPitch. } CUDA_MEMCPY2D. dstY. 167 . srcArray is ignored. srcHost and srcPitch specify the (host) base address of the source data and the bytes per row to apply. respectively. void *dstHost. CUmemorytype srcMemoryType.

CUDA array ? CUDA array). srcDevice and srcPitch are ignored. If dstMemoryType is CU_MEMORYTYPE_HOST. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. dstDevice and dstPitch are ignored. For host pointers. If dstMemoryType is CU_MEMORYTYPE_DEVICE. dstArray is ignored. For device pointers. dstHost. cuMemcpy2DAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. • dstXInBytes and dstY specify the base address of the destination data for the copy. Any pitches must be greater than or equal to WidthInBytes. dstXInBytes must be evenly divisible by the array element size. dstHost and dstPitch specify the (host) base address of the destination data and the bytes per row to apply. cuMemcpy2D() returns an error if any pitch is greater than the maximum allowed (CU_DEVICE_ATTRIBUTE_ cuMemAllocPitch() passes back pitches that always work with cuMemcpy2D(). • srcXInBytes and srcY specify the base address of the source data for the copy. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED 168 . If dstMemoryType is CU_MEMORYTYPE_ARRAY. the starting address is CUdeviceptr dstStart = dstDevice+dstY*dstPitch+dstXInBytes. the starting address is void* Start = (void*)((char*)srcHost+srcY*srcPitch + srcXInBytes). cuMemcpy2DUnaligned() does not have this restriction. dstArray specifies the handle of the destination data. dstDevice and dstPitch specify the (device) base address of the destination data and the bytes per row to apply. • WidthInBytes and Height specify the width (in bytes) and height of the 2D copy being performed. On intra-device memory copies (device ? device. dstArray is ignored. For CUDA arrays. the base address is void* dstStart = (void*)((char*)dstHost+dstY*dstPitch + dstXInBytes). srcArray specifies the handle of the source data. srcXInBytes must be evenly divisible by the array element size. srcHost. cuMemcpy2D() may fail for pitches not computed by cuMemAllocPitch(). the starting address is CUdeviceptr Start = srcDevice+srcY*srcPitch+srcXInBytes. For device pointers. CUDA array ? device. but may run significantly slower in the cases where cuMemcpy2D() would have returned an error code.If srcMemoryType is CU_MEMORYTYPE_ARRAY. For CUDA arrays. For host pointers.

cuMemcpy3D 169 . cuMemcpyAtoH.CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyAtoD. cuMemcpyDtoH. asynchronous launches. cuMemcpyHtoA. cuMemcpyDtoD. cuMemcpyDtoA. cuMemcpyAtoA. SEE ALSO cuMemcpyHtoD.

CUmemorytype_enum is defined as such: typedef enum CUmemorytype_enum { 170 . unsigned int dstLOD. CUarray srcArray. CUdeviceptr dstDevice. void *dstHost. unsigned int srcLOD. srcY. unsigned int Height. DESCRIPTION Perform a 3D memory copy according to the parameters specified in copyParam.8. where: • srcMemoryType and dstMemoryType specify the type of memory of the source and destination. unsigned int srcPitch. // ignored when dst is array unsigned int dstHeight. dstY. srcZ.2. may be 0 if Depth==1 unsigned int dstXInBytes. CUmemorytype dstMemoryType. may be 0 if Depth==1 unsigned int WidthInBytes.14 cuMemcpy3D NAME cuMemcpy3D .copies memory for 3D arrays SYNOPSIS CUresult cuMemcpy3D(const CUDA_MEMCPY3D* copyParam). CUmemorytype srcMemoryType. unsigned int Depth. respectively. CUresult cuMemcpy3DAsync(const CUDA_MEMCPY3D* copyParam. // ignored when src is array unsigned int srcHeight. } CUDA_MEMCPY3D. // ignored when src is array. unsigned int dstPitch. dstZ. The CUDA_MEMCPY3D structure is defined as such: typedef struct CUDA_MEMCPY3D_st { unsigned int srcXInBytes. // ignored when dst is array. CUresult CUDAAPI cuMemcpy3D( const CUDA_MEMCPY3D *pCopy ). CUstream stream). CUdeviceptr srcDevice. CUarray dstArray. const void *srcHost.

dstDevice. the bytes per row. srcY and srcZ specify the base address of the source data for the copy. CU_MEMORYTYPE_ARRAY = 0x03 } CUmemorytype. • srcXInBytes. The srcLOD and dstLOD members of the CUDA_MEMCPY3D structure must be set to 0. srcDevice. dstDevice and dstPitch specify the (device) base address of the destination data. dstXInBytes must be evenly divisible by the array element size. srcXInBytes must be evenly divisible by the array element size. srcPitch and srcHeight specify the (device) base address of the source data. srcPitch and srcHeight specify the (host) base address of the source data. If srcMemoryType is CU_MEMORYTYPE_ARRAY. If dstMemoryType is CU_MEMORYTYPE_ARRAY. and the height of each 2D slice of the 3D array. height and depth of the 3D copy being performed. the base address is void* dstStart = (void*)((char*)dstHost+(dstZ*dstHeight+dstY)*dstPitch + dstXInBytes). srcArray is ignored. • dstXInBytes. dstArray is ignored. and the height of each 2D slice of the 3D array. srcHost. For host pointers. Height and Depth specify the width (in bytes). srcArray is ignored. If dstMemoryType is CU_MEMORYTYPE_DEVICE. 171 cuMemcpy3D() returns an error if any pitch is greater than the maximum allowed (CU_DEVICE_ATTRIBUTE_ . srcArray specifies the handle of the source data. the starting address is CUdeviceptr dstStart = dstDevice+(dstZ*dstHeight+dstY)*dstPitch+dstXInBytes. cuMemcpy3DAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. dstY and dstZ specify the base address of the destination data for the copy. the starting address is CUdeviceptr Start = srcDevice+(srcZ*srcHeight+srcY)*srcPitch+srcXInBytes. the bytes per row. srcPitch and srcHeight are ignored. and the height of each 2D slice of the 3D array. srcDevice. and the height of each 2D slice of the 3D array. If dstMemoryType is CU_MEMORYTYPE_HOST. For host pointers. srcHost. the bytes per row. the starting address is void* Start = (void*)((char*)srcHost+(srcZ*srcHeight+srcY)*srcPitch + srcXInBytes). CU_MEMORYTYPE_DEVICE = 0x02. the bytes per row. dstHost. For CUDA arrays. For CUDA arrays. If srcMemoryType is CU_MEMORYTYPE_HOST. dstPitch and dstHeight are ignored. Any pitches must be greater than or equal to WidthInBytes. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. • WidthInBytes. dstArray is ignored. For device pointers.CU_MEMORYTYPE_HOST = 0x01. For device pointers. dstHost and dstPitch specify the (host) base address of the destination data. dstArray specifies the handle of the destination data. If srcMemoryType is CU_MEMORYTYPE_DEVICE.

cuMemcpy2DAsync 172 . cuMemcpy2D.RETURN VALUE CUDA_SUCCESS SEE ALSO cuMemcpyHtoD. cuMemcpyDtoD. cuMemcpyAtoH. cuMemcpyDtoH. cuMemcpyHtoA. cuMemcpyAtoA. cuMemcpyAtoD. cuMemcpyDtoA.

DESCRIPTION Copies from one 1D CUDA array to another. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyDtoH. cuMemcpyAtoD.15 cuMemcpyAtoA NAME cuMemcpyAtoA . CUarray srcArray.8. unsigned int srcIndex. dstIndex and srcIndex specify the destination and source indices into the CUDA array. These values are in the range [0. cuMemcpyAtoH.copies memory from Array to Array SYNOPSIS CUresult cuMemcpyAtoA(CUarray dstArray. dstArray and srcArray specify the handles of the destination and source CUDA arrays for the copy. Width-1] for the CUDA array. cuMemcpyDtoD. count is the number of bytes to be copied.2. they are not byte offsets. cuMemcpyHtoA. and count must be evenly divisible by that size. respectively. but the elements must be the same size. unsigned int count). cuMemcpy2D 173 . cuMemcpyDtoA. SEE ALSO cuMemcpyHtoD. unsigned int dstIndex. asynchronous launches. The size of the elements in the CUDA arrays need not be the same format.

count specifies the number of bytes to copy and must be evenly divisible by the array element size. cuMemcpyHtoA. SEE ALSO cuMemcpyHtoD. unsigned int srcIndex.8. DESCRIPTION Copies from a 1D CUDA array to device memory. cuMemcpyAtoA. cuMemcpyAtoH. unsigned int count). cuMemcpyDtoA.16 cuMemcpyAtoD NAME cuMemcpyAtoD .copies memory from Array to Device SYNOPSIS CUresult cuMemcpyAtoD(CUdeviceptr dstDevPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. CUarray srcArray. cuMemcpyDtoD. srcArray and srcIndex specify the CUDA array handle and the index (in array elements) of the array element where the copy is to begin. asynchronous launches. cuMemcpy2D 174 .2. dstDevPtr specifies the base pointer of the destination and must be naturally aligned with the CUDA array elements. cuMemcpyDtoH.

2. cuMemcpyAtoHAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. unsigned int count. unsigned int count). It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. unsigned int srcIndex.17 cuMemcpyAtoH NAME cuMempcyAtoH . count specifies the number of bytes to copy. srcArray and srcIndex specify the CUDA array handle and starting index of the source data. CUstream stream). unsigned int srcIndex. cuMemcpyDtoD. cuMemcpy2D 175 . asynchronous launches. SEE ALSO cuMemcpyHtoD. CUarray srcArray. cuMemcpyDtoH.copies memory from Array to Host SYNOPSIS CUresult cuMemcpyAtoH(void* dstHostPtr. cuMemcpyAtoD.8. cuMemcpyAtoA. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyDtoA. DESCRIPTION Copies from a 1D CUDA array to host memory. CUarray srcArray. CUresult cuMemcpyAtoHAsync(void* dstHostPtr. dstHostPtr specifies the base pointer of the destination. cuMemcpyHtoA.

18 cuMemcpyDtoA NAME cuMemcpyDtoA . dstArray and dstIndex specify the CUDA array handle and starting index of the destination data.2. cuMemcpyAtoD. DESCRIPTION Copies from device memory to a 1D CUDA array. CUdeviceptr srcDevPtr. cuMemcpyHtoA. asynchronous launches. srcDevPtr specifies the base pointer of the source. cuMemcpy2D 176 . cuMemcpyDtoH.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuMemcpyHtoD. count specifies the number of bytes to copy.8. unsigned int dstIndex. cuMemcpyAtoA. cuMemcpyDtoD. cuMemcpyAtoH. unsigned int count).

count specifies the number of bytes to copy. cuMemcpyAtoA.2. CUdeviceptr srcDevPtr. cuMemcpyAtoH. cuMemcpyDtoA. cuMemcpyDtoH. asynchronous launches. respectively.19 cuMemcpyDtoD NAME cuMemcpyDtoD . unsigned int count). SEE ALSO cuMemcpyHtoD.8. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. dstDevice and srcDevPtr are the base pointers of the destination and source. cuMemcpyHtoA.copies memory from Device to Device SYNOPSIS CUresult cuMemcpyDtoD(CUdeviceptr dstDevPtr. cuMemcpyAtoD. DESCRIPTION Copies from device memory to device memory. cuMemcpy2D 177 .

CUresult cuMemcpyDtoHAsync(void* dstHostPtr. unsigned int count). cuMemcpyAtoA. MemcpyDtoHAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.8. asynchronous launches. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cuMemcpyDtoD. CUdeviceptr srcDevPtr. CUstream stream). dstHostPtr and srcDevPtrspecify the base addresses of the source and destination. cuMemcpyAtoD. cuMemcpyHtoA. DESCRIPTION Copies from device to host memory.copies memory from Device to Host SYNOPSIS CUresult cuMemcpyDtoH(void* dstHostPtr. SEE ALSO cuMemcpyHtoD.2. cuMemcpyDtoA. cuMemcpyAtoH.20 cuMemcpyDtoH NAME cuMemcpyDtoH . countspecifies the number of bytes to copy. cuMemcpy2D 178 . respectively. unsigned int count. CUdeviceptr srcDevPtr.

CUstream stream). SEE ALSO cuMemcpyHtoD. CUresult cuMemcpyHtoAAsync(CUarray dstArray. cuMemcpyDtoA.copies memory from Host to Array SYNOPSIS CUresult cuMemcpyHtoA(CUarray dstArray. cuMemcpyDtoH.2. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. cuMemcpyAtoA. cuMemcpyAtoD. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.21 cuMemcpyHtoA NAME cuMemcpyHtoA . count specifies the number of bytes to copy. DESCRIPTION Copies from host memory to a 1D CUDA array. cuMemcpy2D 179 .8. const void *srcHostPtr. cuMemcpyAtoH. unsigned int count. cuMemcpyHtoAAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. unsigned int dstIndex. const void *srcHostPtr. unsigned int count). cuMemcpyDtoD. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. unsigned int dstIndex. srcHostPtr specify the base addresse of the source. asynchronous launches.

cuMemcpyAtoA. cuMemcpyAtoH. const void *srcHostPtr. SEE ALSO cuMemcpyDtoH. cuMemcpyHtoA. cuMemcpyHtoDAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. cuMemcpyAtoD. count specifies the number of bytes to copy.copy memory from Host to Device SYNOPSIS CUresult cuMemcpyHtoD(CUdeviceptr dstDevPtr.8. cuMemcpyDtoA. cuMemcpy2D 180 .22 cuMemcpyHtoD NAME cuMemcpyHtoD . unsigned int count. DESCRIPTION Copies from host memory to device memory. asynchronous launches. dstDevPtr and srcHostPtr specify the base addresses of the destination and source. unsigned int count). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyDtoD. respectively. CUstream stream). CUresult cuMemcpyHtoDAsync(CUdeviceptr dstDevPtr.2. const void *srcHostPtr. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.

16-. CUresult cuMemsetD32(CUdeviceptr dstDevPtr. cuArrayDestroy. cuMemset2D 181 . cuMemFree. unsigned int count ). cuMemGetAddressRange. cuMemAllocHost. cuMemAllocPitch. or 32-bit values to the specified value value. unsigned int value. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. unsigned short value. unsigned int count ). unsigned int count ). unsigned char value. cuMemFreeHost. asynchronous launches.8.23 cuMemset NAME cuMemset . cuArrayGetDescriptor. cuMemAlloc. CUresult cuMemsetD16(CUdeviceptr dstDevPtr. cuArrayCreate. SEE ALSO cuMemGetInfo.2.initializes device memory SYNOPSIS CUresult cuMemsetD8(CUdeviceptr dstDevPtr. DESCRIPTION Sets the memory range of count 8-.

unsigned int height ). cuArrayDestroy. cuMemAllocHost. These functions perform fastest when the pitch is one that has been passed back by cuMemAllocPitch(). cuArrayGetDescriptor. cuMemGetAddressRange. asynchronous launches. 16-. cuMemFreeHost. cuMemFree.24 cuMemset2D NAME cuMemset2D . or 32-bit values to the specified value value. unsigned int dstPitch. unsigned int height ).2. cuMemAlloc. CUresult cuMemsetD2D16(CUdeviceptr dstDevPtr.initializes device memory SYNOPSIS CUresult cuMemsetD2D8(CUdeviceptr dstDevPtr. unsigned int width. unsigned int value. unsigned int dstPitch. cuArrayCreate. and dstPitch specifies the number of bytes between each row. SEE ALSO cuMemGetInfo. unsigned short value. unsigned int dstPitch. DESCRIPTION Sets the 2D memory range of width 8-. unsigned int width. CUresult cuMemsetD2D32(CUdeviceptr dstDevPtr. unsigned int height ). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. unsigned char value. height specifies the number of rows to set. cuMemAllocPitch. unsigned int width. cuMemset 182 .8.

ExecutionControl. StreamManagement.2. ModuleManagement. Direct3dInteroperability 183 . EventManagement. OpenGlInteroperability.9 TextureReferenceManagement NAME Texture Reference Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. TextureReferenceManagement. MemoryManagement. DeviceManagement. ContextManagement. cuTexRefCreate cuTexRefDestroy cuTexRefGetAddress cuTexRefGetAddressMode cuTexRefGetArray cuTexRefGetFilterMode cuTexRefGetFlags cuTexRefGetFormat cuTexRefSetAddress cuTexRefSetAddressMode cuTexRefSetArray cuTexRefSetFilterMode cuTexRefSetFlags cuTexRefSetFormat SEE ALSO Initialization.

etc. cuTexRefSetArray. cuTexRefGetAddressMode. Other texture reference functions are used to specify the format and interpretation (addressing. cuTexRefGetAddress. cuTexRefGetFormat. the application must call cuTexRefSetArray() or cuTexRefSetAddress() to associate the reference with allocated memory. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetFilterMode. filtering. the application should call cuParamSetTexRef(). cuTexRefSetFlags.) to be used when the memory is read through this texture reference. DESCRIPTION Creates a texture reference and returns its handle in *texRef. cuTexRefGetFlags 184 . To associate the texture reference with a texture ordinal for a given function.1 cuTexRefCreate NAME cuTexRefCreate .2. asynchronous launches.9. cuTexRefGetFilterMode. SEE ALSO cuTexRefDestroy.creates a texture-reference SYNOPSIS CUresult cuTexRefCreate(CUtexref* texRef). cuTexRefSetAddressMode. Once created. cuTexRefGetArray. cuTexRefSetAddress. cuTexRefSetFormat.

cuTexRefSetFormat. cuTexRefSetArray. cuTexRefGetArray. cuTexRefSetAddressMode. cuTexRefGetFlags 185 . DESCRIPTION Destroys the texture reference.2. cuTexRefGetAddress. cuTexRefGetAddressMode. cuTexRefSetFlags. cuTexRefSetFilterMode. SEE ALSO cuTexRefCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.2 cuTexRefDestroy NAME cuTexRefDestroy . cuTexRefSetAddress. cuTexRefGetFormat.9.destroys a texture-reference SYNOPSIS CUresult cuTexRefDestroy(CUtexref texRef). cuTexRefGetFilterMode. asynchronous launches.

cuTexRefSetArray. cuTexRefSetFlags. cuTexRefSetFilterMode.3 cuTexRefGetAddress NAME cuTexRefGetAddress .9.2. cuTexRefSetAddressMode. cuTexRefGetFlags 186 . or returns CUDA_ERROR_INVALID_VA if the texture reference is not bound to any device memory range. cuTexRefDestroy.gets the address associated with a texture-reference SYNOPSIS CUresult cuTexRefGetAddress(CUdeviceptr* devPtr. cuTexRefSetAddress. cuTexRefSetFormat. cuTexRefGetArray. cuTexRefGetFormat. asynchronous launches. SEE ALSO cuTexRefCreate. cuTexRefGetFilterMode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. CUtexref texRef). cuTexRefGetAddressMode. DESCRIPTION Returns in *devPtr the base address bound to the texture reference texRef.

cuTexRefSetAddressMode. cuTexRefDestroy. asynchronous launches. cuTexRefGetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefSetFlags. cuTexRefSetFilterMode.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode . cuTexRefSetArray. DESCRIPTION Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef. cuTexRefGetAddress. Currently the only valid values for dim are 0 and 1. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode. cuTexRefGetArray. cuTexRefSetFormat.2. cuTexRefSetAddress. int dim). cuTexRefGetFormat.9. cuTexRefGetFlags 187 . CUtexref texRef.

cuTexRefGetAddressMode. cuTexRefSetFilterMode. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. cuTexRefSetFlags.2. or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array. cuTexRefGetFormat.5 cuTexRefGetArray NAME cuTexRefGetArray . cuTexRefSetFormat. cuTexRefSetAddress. CUtexref texRef). cuTexRefGetFlags 188 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetArray.gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. cuTexRefGetAddress. cuTexRefDestroy. SEE ALSO cuTexRefCreate. cuTexRefGetFilterMode. cuTexRefSetAddressMode.9. asynchronous launches.

cuTexRefDestroy. cuTexRefSetArray. cuTexRefSetAddress. cuTexRefSetAddressMode. cuTexRefGetFormat. DESCRIPTION Returns in *mode the filtering mode of the texture reference texRef.6 cuTexRefGetFilterMode NAME cuTexRefGetFilterMode .2. cuTexRefSetFormat.gets the filter-mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetFilterMode(CUfilter_mode* mode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetAddressMode. CUtexref texRef). cuTexRefSetFilterMode. cuTexRefGetAddress.9. SEE ALSO cuTexRefCreate. asynchronous launches. cuTexRefSetFlags. cuTexRefGetArray. cuTexRefGetFlags 189 .

cuTexRefGetAddress.7 cuTexRefGetFlags NAME cuTexRefGetFlags . cuTexRefSetAddress. cuTexRefGetAddressMode. cuTexRefGetFormat 190 . asynchronous launches. cuTexRefSetFlags. CUtexref texRef). SEE ALSO cuTexRefCreate. cuTexRefDestroy. cuTexRefSetFormat.gets the flags used by a texture-reference SYNOPSIS CUresult cuTexRefGetFlags(unsigned int* flags.2. cuTexRefSetFilterMode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetAddressMode.9. cuTexRefGetFilterMode. cuTexRefSetArray. DESCRIPTION Returns in *flags the flags of the texture reference texRef. cuTexRefGetArray.

cuTexRefGetFlags 191 .2. cuTexRefSetAddressMode. cuTexRefGetAddress. cuTexRefGetArray. If format or numPackedComponents is null. cuTexRefDestroy.8 cuTexRefGetFormat NAME cuTexRefGetFormat . cuTexRefSetFilterMode. DESCRIPTION Returns in *format and *numPackedComponents the format and number of components of the CUDA array bound to the texture reference texRef. SEE ALSO cuTexRefCreate. cuTexRefSetFormat. CUtexref texRef). int* numPackedComponents. cuTexRefGetAddressMode.gets the format used by a texture-reference SYNOPSIS CUresult cuTexRefGetFormat(CUarray_format* format. cuTexRefSetFlags. cuTexRefSetArray. cuTexRefSetAddress.9. asynchronous launches. cuTexRefGetFilterMode. it will be ignored. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetAddress() passes back a byte offset in *byteOffset that must be applied to texture fetches in order to read from the desired memory. cuTexRefSetFlags. cuTexRefSetFilterMode. cuTexRefSetArray. cuTexRefGetAddress. Any previous address or CUDA array state associated with the texture reference is superseded by this function. cuTexRefDestroy.9. If the device memory pointer was returned from cuMemAlloc(). cuTexRefGetArray. asynchronous launches. SEE ALSO cuTexRefCreate. Since the hardware enforces an alignment requirement on texture base addresses. the offset is guaranteed to be 0 and NULL may be passed as the ByteOffset parameter. DESCRIPTION Binds a linear address range to the texture reference texRef. CUtexref texRef. cuTexRefGetFlags 192 . cuTexRefGetFormat. This offset must be divided by the texel size and passed to kernels that read from the texture so they can be applied to the tex1Dfetch() function. Any memory previously bound to texRef is unbound.2.binds an address as a texture-reference SYNOPSIS CUresult cuTexRefSetAddress(unsigned int* byteOffset. cuTexRefSetAddressMode.9 cuTexRefSetAddress NAME cuTexRefSetAddress . cuTexRefGetAddressMode. cuTexRefSetFormat. int bytes). cuTexRefGetFilterMode. CUdeviceptr devPtr.

If dim is zero. DESCRIPTION Specifies the addressing mode mode for the given dimension of the texture reference texRef.10 cuTexRefSetAddressMode NAME cuTexRefSetAddressMode . SEE ALSO cuTexRefCreate.2. cuTexRefGetFormat. cuTexRefDestroy. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. the second. int dim. CU_TR_ADDRESS_MODE_MIRROR = 2. cuTexRefGetAddressMode. cuTexRefSetFilterMode. CUaddress_mode mode). Note that this call has no effect if texRef is bound to linear memory. CUaddress_mode is defined as such: typedef enum CUaddress_mode_enum { CU_TR_ADDRESS_MODE_WRAP = 0. cuTexRefGetArray. asynchronous launches. cuTexRefSetFormat. cuTexRefGetFlags 193 . and so on. the addressing mode is applied to the first parameter of the functions used to fetch from the texture.set the addressing mode for a texture-reference SYNOPSIS CUresult cuTexRefSetAddressMode(CUtexref texRef. cuTexRefSetAddress. if dim is 1.9. cuTexRefSetArray. CU_TR_ADDRESS_MODE_CLAMP = 1. } CUaddress_mode. cuTexRefSetFlags. cuTexRefGetAddress. cuTexRefGetFilterMode.

9. cuTexRefGetFlags 194 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetAddress. Any CUDA array previously bound to texRef is unbound. cuTexRefGetAddressMode. asynchronous launches. cuTexRefGetAddress.2. cuTexRefDestroy. cuTexRefGetFormat.binds an array to a texture-reference SYNOPSIS CUresult cuTexRefSetArray(CUtexref texRef. SEE ALSO cuTexRefCreate. cuTexRefSetFormat.11 cuTexRefSetArray NAME cuTexRefSetArray . CUarray array. cuTexRefGetFilterMode. cuTexRefGetArray. cuTexRefSetFilterMode. Any previous address or CUDA array state associated with the texture reference is superseded by this function. flags must be set to CU_TRSA_OVERRIDE_FORMAT. unsigned int flags). cuTexRefSetFlags. cuTexRefSetAddressMode. DESCRIPTION Binds the CUDA array array to the texture reference texRef.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.2. cuTexRefGetFlags 195 . cuTexRefGetArray.9. asynchronous launches. CUfilter_mode_enum is defined as such: typedef enum CUfilter_mode_enum { CU_TR_FILTER_MODE_POINT = 0. cuTexRefDestroy. SEE ALSO cuTexRefCreate. DESCRIPTION Specifies the filtering mode mode to be used when reading memory through the texture reference texRef. cuTexRefSetFlags. cuTexRefSetArray. cuTexRefGetAddress. cuTexRefSetAddressMode. Note that this call has no effect if texRef is bound to linear memory. cuTexRefSetFormat. cuTexRefGetFilterMode. CU_TR_FILTER_MODE_LINEAR = 1 } CUfilter_mode.12 cuTexRefSetFilterMode NAME cuTexRefSetFilterMode .sets the mode for a texture-reference SYNOPSIS CUresult cuTexRefSetFilterMode(CUtexref texRef. cuTexRefSetAddress. CUfilter_mode mode). cuTexRefGetFormat. cuTexRefGetAddressMode.

SEE ALSO cuTexRefCreate. unsigned int Flags). The valid flags are: • CU_TRSF_READ_AS_INTEGER.0) reference the entire breadth of the array dimension RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetAddress. cuTexRefSetAddressMode. • CU_TRSF_NORMALIZED_COORDINATES. cuTexRefSetAddress. DESCRIPTION Specifies optional flags to control the behavior of data returned through the texture reference. asynchronous launches. cuTexRefSetFormat. cuTexRefGetAddressMode. cuTexRefSetFilterMode. cuTexRefDestroy.9. Instead. cuTexRefGetFilterMode. which suppresses the default behavior of having the texture promote integer data to floating point data in the range [0. which suppresses the default behavior of having the texture coordinates range from [0. cuTexRefGetArray.sets flags for a texture-reference SYNOPSIS CUresult cuTexRefSetFlags(CUtexref texRef. cuTexRefSetArray. 1]. cuTexRefGetFlags 196 . Dim) where Dim is the width or height of the CUDA array.13 cuTexRefSetFlags NAME cuTexRefSetFlags . cuTexRefGetFormat. 1.2. the texture coordinates [0.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetAddress.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef.14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefDestroy. cuTexRefGetAddress. cuTexRefSetFlags. format and numPackedComponents are exactly analogous to the Format and NumChannels members of the CUDA_ARRAY_DESCRIPTOR structure: They specify the format of each component and the number of components per array element. cuTexRefSetAddressMode. cuTexRefSetFilterMode.2. CUarray_format format. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef. SEE ALSO cuTexRefCreate. cuTexRefGetArray. asynchronous launches. cuTexRefGetAddressMode. cuTexRefGetFilterMode.9. cuTexRefGetFlags 197 . cuTexRefSetArray. cuTexRefGetFormat.

OpenGLInteroperability. StreamManagement. DeviceManagement. TextureReferenceManagement.2. ExecutionControl. ModuleManagement. EventManagement. Direct3dInteroperability 198 . cuGLCtxCreate cuGLInit cuGLMapBufferObject cuGLRegisterBufferObject cuGLUnmapBufferObject cuGLUnregisterBufferObject SEE ALSO Initialization.10 OpenGlInteroperability NAME OpenGL Interoperability DESCRIPTION This section describes the low-level CUDA driver application programming interface. MemoryManagement. ContextManagement.

1 cuGLCtxCreate NAME cuGLCtxCreate . cuGLInit cuGLRegisterBufferObject. It may fail if the needed OpenGL driver facilities are not available. unsigned int Flags. It must be called before performing any other OpenGL interoperability operations.2. CUdevice device). asynchronous launches. and associates the CUDA context with the calling thread.10. cuGLUnmapBufferObject. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuGLUnregisterBufferObject 199 . see cuCtxCreate. initializes OpenGL interoperability. DESCRIPTION Creates a new CUDA context.create a CUDA context for interoperability with OpenGL SYNOPSIS CUresult cuGLCtxCreate(CUcontext *pCtx. SEE ALSO cuCtxCreate. For usage of the Flags parameter. cuGLMapBufferObject.

asynchronous launches. SEE ALSO cuGLCtxCreate.10.initializes GL interoperability SYNOPSIS CUresult cuGLInit(void). cuGLRegisterBufferObject. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuGLUnmapBufferObject. It may fail if the needed OpenGL driver facilities are not available. cuGLMapBufferObject. cuGLUnregisterBufferObject 200 .2 cuGLInit NAME cuGLInit . DESCRIPTION Initializes OpenGL interoperability. It must be called before performing any other OpenGL interoperability operations.2.

cuGLUnregisterBufferObject 201 . cuGLUnmapBufferObject. unsigned int* size.10. SEE ALSO cuGLCtxCreate. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_MAP_FAILED Note that this function may also return error codes from previous. cuGLInit.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr. cuGLRegisterBufferObject. GLuint bufferObj).3 cuGLMapBufferObject NAME cuGLMapBufferObject .2. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of the current CUDA context and returns in *devPtr and *size the base pointer and size of the resulting mapping.

cuGLMapBufferObject. This function must be called before CUDA can map the buffer object.4 cuGLRegisterBufferObject NAME cuGLRegisterBufferObject . While it is registered. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. cuGLUnmapBufferObject.10. DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. SEE ALSO cuGLCtxCreate. cuGLInit. cuGLUnregisterBufferObject 202 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_ALREADY_MAPPED Note that this function may also return error codes from previous.registers a GL buffer object SYNOPSIS CUresult cuGLRegisterBufferObject(GLuint bufferObj).2. asynchronous launches.

2. cuGLMapBufferObject. cuGLInit. asynchronous launches. DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA. cuGLUnregisterBufferObject 203 . cuGLRegisterBufferObject. SEE ALSO cuGLCtxCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.10.unmaps a GL buffer object SYNOPSIS CUresult cuGLUnmapBufferObject(GLuint bufferObj).5 cuGLUnmapBufferObject NAME cuGLUnmapBufferObject .

asynchronous launches. cuGLInit. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA.6 cuGLUnregisterBufferObject NAME cuGLUnregisterBufferObject .10. cuGLUnmapBufferObject 204 . cuGLMapBufferObject.2.unregister a GL buffer object SYNOPSIS CUresult cuGLUnregisterBufferObject(GLuint bufferObj). SEE ALSO cuGLCtxCreate. cuGLRegisterBufferObject.

2. They should not be used in new development. TextureReferenceManagement.11 Direct3dInteroperability NAME Direct3D Interoperability DESCRIPTION This section describes Direct3D interoperability in the the low-level CUDA driver application programming interface. cuD3D9GetDevice cuD3D9CtxCreate cuD3D9GetDirect3DDevice cuD3D9RegisterResource cuD3D9UnregisterResource cuD3D9MapResources cuD3D9UnmapResources cuD3D9ResourceGetSurfaceDimensions cuD3D9ResourceSetMapFlags cuD3D9ResourceGetMappedPointer cuD3D9ResourceGetMappedSize cuD3D9ResourceGetMappedPitch As of CUDA 2. DeviceManagement.0 the following functions are deprecated. OpenGLInteroperability. Direct3dInteroperability 205 . ContextManagement. ExecutionControl. StreamManagement. cuD3D9Begin cuD3D9End cuD3D9MapVertexBuffer cuD3D9RegisterVertexBuffer cuD3D9UnmapVertexBuffer cuD3D9UnregisterVertexBuffer SEE ALSO Initialization. MemoryManagement. ModuleManagement. EventManagement.

gets the device number for an adapter SYNOPSIS CUresult cuD3D9GetDevice(CUdevice* dev. cuD3D9ResourceSetMapFlags. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_VALUE CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. DESCRIPTION Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier(). cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize.1 cuD3D9GetDevice NAME cuD3D9GetDevice . cuD3D9UnregisterResource. cuD3D9UnmapResources.2. cuD3D9RegisterResource. SEE ALSO cuD3D9CtxCreate. asynchronous launches. cuD3D9GetDirect3DDevice. cuD3D9MapResources.11. If no device on the adapter with name adapterName is CUDA-compatible then the call will fail. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceGetMappedPitch 206 . const char* adapterName).

this call will increase the internal reference count on pDxDevice. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9ResourceGetSurfaceDimensions. cuD3D9RegisterResource. The CUcontext created will be returned in *pCtx.create a CUDA context for interoperability with Direct3D SYNOPSIS CUresult cuD3D9CtxCreate(CUcontext* pCtx. and associates the created CUDA context with the calling thread. For usage of the Flags parameter. IDirect3DDevice9* pDxDevice). If pCuDevice is non-NULL then the CUdevice on which this CUDA context was created will be returned in *pCuDevice. DESCRIPTION Creates a new CUDA context. cuD3D9ResourceGetMappedPitch 207 . Direct3D resources from this device may be registered and mapped through the lifetime of this CUDA context. This reference count will be decremented upon destruction of this context through cuCtxDestroy. This context will function only until its Direct3D device is destroyed. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuD3D9ResourceSetMapFlags. cuD3D9GetDirect3DDevice. see cuCtxCreate. enables interoperability for that context with the Direct3D device pDxDevice.2 cuD3D9CtxCreate NAME cuD3D9CtxCreate . On success. SEE ALSO cuD3D9GetDevice. CUdevice* pCuDevice.2. unsigned int Flags.11. cuD3D9MapResources cuD3D9UnmapResources. cuD3D9UnregisterResource. asynchronous launches.

11. cuD3D9ResourceGetSurfaceDimensions. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. cuD3D9CtxCreate. asynchronous launches. cuD3D9ResourceSetMapFlags.get the Direct3D device against which the current CUDA context was created SYNOPSIS CUresult cuD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice). cuD3D9MapResources. cuD3D9ResourceGetMappedPitch 208 . cuD3D9UnregisterResource.2. cuD3D9UnmapResources. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize.3 cuD3D9GetDirect3DDevice NAME cuD3D9GetDirect3DDevice . cuD3D9RegisterResource. DESCRIPTION Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cuD3D9CtxCreate.

• CU_D3D9_REGISTER_FLAGS_NONE: Specifies that CUDA will access this resource through a CUdeviceptr. • Resources allocated as shared may not be registered with CUDA. and cuD3D9ResourceGetMappedPitch respectively. • IDirect3DVertexBuffer9: No notes. • IDirect3DSurface9: Only stand-alone objects of type IDirect3DSurface9 may be explicitly shared. The pointer. To access individual surfaces associated with a texture. The type of pResource must be one of the following. or 4 channels of 8. 209 . unsigned int Flags). This call is potentially high-overhead and should not be called every frame in interactive applications. 16. • Textures which are not of a format which is 1. cuD3D9ResourceGetMappedSize.2. 2. DESCRIPTION Registers the Direct3D resource pResource for access by CUDA.11. • Any resources allocated in D3DPOOL_SYSTEMMEM may not be registered with CUDA.register a Direct3D resource for access by CUDA SYNOPSIS CUresult cuD3D9RegisterResource(IDirect3DResource9* pResource. This reference count will be decremented when this resource is unregistered through cuD3D9UnregisterResource. individual mipmap levels and faces of cube maps may not be registered directly. Not all Direct3D resources of the above types may be used for interoperability with CUDA. • The primary rendertarget may not be registered with CUDA. The Flags argument specifies the mechanism through which CUDA will access the Direct3D resource. The following are some limitations.4 cuD3D9RegisterResource NAME cuD3D9RegisterResource . one must register the base texture object. This option is valid for all resource types. If this call is successful then the application will be able to map and unmap this resource until it is unregistered through cuD3D9UnregisterResource. • IDirect3DBaseTexture9: When a texture is registered all surfaces associated with the all mipmap levels of all faces of the texture will be accessible to CUDA. or 32-bit integer or floating-point data cannot be shared. size. In particular. this call will increase the internal reference count on pResource. The following value is allowed. • IDirect3DIndexBuffer9: No notes. Also on success. and pitch for each subresource of this resource may be queried through cuD3D9ResourceGetMappedPointer.

cuD3D9UnregisterResource. cuD3D9ResourceGetSurfaceDimensions. cuD3D9GetDirect3DDevice. If pResource cannot be registered then CUDA_ERROR_UNKNOWN is returned. cuD3D9UnmapResources. cuD3D9CtxCreate. If Direct3D interoperability is not initialized on this context then CUDA_ERROR_INVALID_CONTEXT is returned.• Surfaces of depth or stencil formats cannot be shared. cuD3D9ResourceGetMappedPitch 210 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceSetMapFlags. cuD3D9MapResources.g. If pResource is of incorrect type (e. asynchronous launches. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. is a non-stand-alone IDirect3DSurface9) or is already registered then CUDA_ERROR_INVALID_HANDLE is returned.

cuD3D9ResourceSetMapFlags. asynchronous launches. SEE ALSO cuD3D9GetDevice.unregister a Direct3D resource SYNOPSIS CUresult cuD3D9UnregisterResource(IDirect3DResource9* pResource). cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again.11. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.5 cuD3D9UnregisterResource NAME cuD3D9UnregisterResource . If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9RegisterResource. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetMappedPitch 211 . cuD3D9UnmapResources. cuD3D9ResourceGetSurfaceDimensions.2. cuD3D9CtxCreate. cuD3D9MapResources.

If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then CUDA_ERROR_INVALID_HANDLE is returned. Direct3D should not access any resources while they are mapped by CUDA.map Direct3D resources for access by CUDA SYNOPSIS CUresult cuD3D9MapResources(unsigned int count. cuD3D9ResourceSetMapFlags. cuD3D9ResourceGetSurfaceDimensions.2. cuD3D9CtxCreate. SEE ALSO cuD3D9GetDevice. cuD3D9UnregisterResource. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. The resources in ppResources may be accessed in CUDA kernels until they are unmapped. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. If an application does so the results are undefined. This function provides the synchronization guarantee that any Direct3D calls issued before cuD3D9MapResources will complete before any CUDA kernels issued after cuD3D9MapResources begin. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetMappedPitch 212 .11. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ALREADY_MAPPED CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuD3D9RegisterResource. cuD3D9UnmapResources. If any of ppResources are presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned. asynchronous launches.6 cuD3D9MapResources NAME cuD3D9MapResources . IDirect3DResource9 **ppResources).

2.11.7

cuD3D9UnmapResources

NAME
cuD3D9UnmapResources - unmap Direct3D resources

SYNOPSIS
CUresult cuD3D9UnmapResources(unsigned int count, IDirect3DResource9** ppResources);

DESCRIPTION
Unmaps the count Direct3D resources in ppResources. This function provides the synchronization guarantee that any CUDA kernels issued before cuD3D9UnmapResources will complete before any Direct3D calls issued after cuD3D9UnmapResources begin. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then CUDA_ERROR_INVALID_HANDLE is returned. If any of ppResources are not presently mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9ResourceGetSurfaceDimensions, cuD3D9ResourceSetMapFlags, cuD3D9ResourceGetMappedP cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

213

2.11.8

cuD3D9ResourceSetMapFlags

NAME
cuD3D9ResourceSetMapFlags - set usage flags for mapping a Direct3D resource

SYNOPSIS
CUresult cuD3D9ResourceSetMapFlags(IDirect3DResource9 *pResource, unsigned int Flags);

DESCRIPTION
Set flags for mapping the Direct3D resource pResource. Changes to flags will take effect the next time pResource is mapped. The Flags argument may be any of the following. • CU_D3D9_MAPRESOURCE_FLAGS_NONE: Specifies no hints about how this resource will be used. It is therefore assumed that this resource will be read from and written to by CUDA kernels. This is the default value. • CU_D3D9_MAPRESOURCE_FLAGS_READONLY: Specifies that CUDA kernels which access this resource will not write to this resource. • CU_D3D9_MAPRESOURCE_FLAGS_WRITEDISCARD: Specifies that CUDA kernels which access this resource will not read from this resource and will write over the entire contents of the resource, so none of the data previously stored in the resource will be preserved. If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ALREADY_MAPPED Note that this function may also return error codes from previous, asynchronous launches.

214

SEE ALSO

cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9UnmapResources, cuD3D9ResourceGetSurfaceDimensions, cuD3D9ResourceGetMappedPointe cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

215

2.11.9

cuD3D9ResourceGetSurfaceDimensions

NAME
cuD3D9ResourceGetSurfaceDimensions - get the dimensions of a registered surface

SYNOPSIS
CUresult cuD3D9ResourceGetSurfaceDimensions(unsigned int* pWidth, unsigned int* pHeight, unsigned int *pDepth, IDirect3DResource9* pResource, unsigned int Face, unsigned int Level);

DESCRIPTION
Returns in *pWidth, *pHeight, and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. Because anti-aliased surfaces may have multiple samples per pixel it is possible that the dimensions of a resource will be an integer factor larger than the dimensions reported by the Direct3D runtime. The parameters pWidth, pHeight, and pDepth are optional. For 2D surfaces, the value returned in *pDepth will be 0. If pResource is not of type IDirect3DBaseTexture9 or IDirect3DSurface9 or if pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9UnmapResources, cuD3D9ResourceSetMapFlags, cuD3D9ResourceGetMappedPointer, cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

216

At present only mipmap level 0 is supported. DESCRIPTION Returns in *pDevPtr the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. If Face is invalid then CUDA_ERROR_INVALID_V is returned. unsigned int Face. 217 . If pResource is not mapped then CUDA_ERROR_NOT_MAPPED is returned. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. asynchronous launches.2. unsigned int Level). For all other types Level must be 0. For all other types Face must be 0. IDirect3DResource9* pResource. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVA is returned. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. If Level is invalid then CUDA_ERROR_INVALID_VALUE is returned.get a pointer through which to access a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedPointer(CUdeviceptr* pDevPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. The value set in pDevPtr may change every time that pResource is mapped.11.10 cuD3D9ResourceGetMappedPointer NAME cuD3D9ResourceGetMappedPointer .

cuD3D9ResourceSetMapFlags. cuD3D9MapResources. cuD3D9UnregisterResource. cuD3D9UnmapResources. cuD3D9ResourceGetMappedSize. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceGetMappedPitch 218 . cuD3D9GetDirect3DDevice.SEE ALSO cuD3D9GetDevice. cuD3D9CtxCreate. cuD3D9RegisterResource.

2. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned.11. cuD3D9CtxCreate. cuD3D9ResourceGetMappedPointer. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. IDirect3DResource9* pResource. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetMappedPitch 219 . unsigned int Level). cuD3D9UnmapResources. The value set in pSize may change every time that pResource is mapped.11 cuD3D9ResourceGetMappedSize NAME cuD3D9ResourceGetMappedSize . cuD3D9RegisterResource. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. unsigned int Face. cuD3D9GetDirect3DDevice.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedSize(unsigned int* pSize. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. cuD3D9ResourceSetMapFlags. asynchronous launches. cuD3D9MapResources. cuD3D9UnregisterResource. cuD3D9ResourceGetSurfaceDimensions.

If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level.12 cuD3D9ResourceGetMappedPitch NAME cuD3D9ResourceGetMappedPitch . unsigned int* pPitchSlice. unsigned int Level). For a 2D surface the byte offset of the sample of at position x.get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedPitch(unsigned int* pPitch.2. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. asynchronous launches.11.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. The values set in pPitch and pPitchSlice may change every time that pResource is mapped. IDirect3DResource pResource. unsigned int Face.y from the base pointer of the surface is If pResource is not of type IDirect3DBaseTexture9 or one of its sub-types or if pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. 220 .y.

SEE ALSO cuD3D9GetDevice. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetMappedSize 221 . cuD3D9UnmapResources. cuD3D9MapResources. cuD3D9UnregisterResource. cuD3D9ResourceSetMapFlags. cuD3D9RegisterResource. cuD3D9CtxCreate. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceGetMappedPointer.

2 and higher. 64-bit atomic operations are only supported on devices of compute capability 1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1.1 and higher. BitwiseFunctions 222 .3 AtomicFunctions NAME Atomic Functions DESCRIPTION Atomic functions can only be used in device functions. SEE ALSO ArithmeticFunctions.

1 ArithmeticFunctions NAME Arithmetic Functions DESCRIPTION This section describes the atomic arithmetic functions.3. atomicAdd atomicSub atomicExch atomicMin atomicMax atomicInc atomicDec atomicCAS SEE ALSO BitwiseFunctions 223 .

atomicInc. These three operations are performed in one atomic transaction. unsigned int atomicAdd(unsigned int* address. atomicDec. The function returns old. 64-bit atomic operations are only supported on devices of compute capability 1. SEE ALSO atomicSub. unsigned long long int val). NOTES 32-bit atomic operations are only supported on devices of compute capability 1. int val).1 and higher. unsigned int val). and stores the result back to global memory at the same address. atomicCAS 224 .1 atomicAdd NAME atomicAdd . unsigned long long int atomicAdd(unsigned long long int* address.2 and higher.atomic addition SYNOPSIS int atomicAdd(int* address. DESCRIPTION Reads the 32. computes (old + val).or 64-bit word old located at the address address in global memory. atomicMin.3. atomicMax. atomicExch.1.

atomicExch. atomicCAS 225 .3. int val). and stores the result back to global memory at the same address. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. atomicMax. The function returns old. unsigned int val).atomic subtraction SYNOPSIS int atomicSub(int* address.1 and higher.val). atomicDec. unsigned int atomicSub(unsigned int* address. SEE ALSO atomicAdd. atomicMin. computes (old . NOTES Atomic operations are only supported on devices of compute capability 1.1. These three operations are performed in one atomic transaction.2 atomicSub NAME atomicSub . atomicInc.

atomic exchange SYNOPSIS int atomicExch(int* address.3 atomicExch NAME atomicExch . DESCRIPTION Reads the 32. SEE ALSO atomicAdd. These two operations are performed in one atomic transaction.or 64-bit word old located at the address address in global memory and stores val back to global memory at the same address.1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. unsigned long long int val). 64-bit atomic operations are only supported on devices of compute capability 1. unsigned int val). atomicCAS 226 .1 and higher. atomicMin. atomicInc.3. atomicMax. unsigned int atomicExch(unsigned int* address. unsigned long long int atomicExch(unsigned long long int* address. The function returns old. atomicSub.2 and higher. int val). atomicDec.

atomicSub. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. atomicExch. atomicInc. computes the minimum of old and val. unsigned int atomicMin(unsigned int* address. and stores the result back to global memory at the same address. NOTES Atomic operations are only supported on devices of compute capability 1. int val). unsigned int val). These three operations are performed in one atomic transaction.1.4 atomicMin NAME atomicMin . atomicCAS 227 . atomicMax. atomicDec.atomic minimum SYNOPSIS int atomicMin(int* address. The function returns b<old>.3. SEE ALSO atomicAdd.1 and higher.

unsigned int val). SEE ALSO atomicAdd. The function returns old.1. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. atomicSub.1 and higher. unsigned int atomicMax(unsigned int* address. atomicMin. atomicDec. int val). These three operations are performed in one atomic transaction. computes the maximum of old and val.5 atomicMax NAME atomicMax . and stores the result back to global memory at the same address.atomic maximum SYNOPSIS int atomicMax(int* address. atomicInc. NOTES Atomic operations are only supported on devices of compute capability 1. atomicCAS 228 . atomicExch.3.

These three operations are performed in one atomic transaction. atomicSub. and stores the result back to global memory at the same address. NOTES Atomic operations are only supported on devices of compute capability 1.6 atomicInc NAME atomicInc .1.3. atomicExch. computes ((old >= val) ? 0 : (old+1)). atomicDec. atomicCAS 229 . atomicMin. unsigned int val).atomic increment SYNOPSIS unsigned int atomicInc(unsigned int* address. atomicMax.1 and higher. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. SEE ALSO atomicAdd. The function returns old.

atomic decrement SYNOPSIS unsigned int atomicDec(unsigned int* address. atomicCAS 230 . NOTES Atomic operations are only supported on devices of compute capability 1. unsigned int val).1 and higher. atomicExch. These three operations are performed in one atomic transaction. SEE ALSO atomicAdd. and stores the result back to global memory at the same address. atomicSub. atomicMax. DESCRIPTION Reads the 32-bit word old located at the address address in global memory.1. atomicInc. atomicMin. The function returns old.3.7 atomicDec NAME atomicDec . computes (((old == 0) .

unsigned int atomicCAS(unsigned int* address. atomicInc. computes (old == compare ? val : old).or 64-bit word old located at the address address in global memory. atomicExch. SEE ALSO atomicAdd. The function returns old (Compare And Swap). 64-bit atomic operations are only supported on devices of compute capability 1. DESCRIPTION Reads the 32. atomicMin. These three operations are performed in one atomic transaction. unsigned int compare.8 atomicCAS NAME atomicCAS .1 and higher. atomicMax. unsigned long long int val). unsigned int val). unsigned long long int compare. unsigned long long int atomicCAS(unsigned long long int* address.atomic compare-and-swap SYNOPSIS int atomicCAS(int* address.3. int val).2 and higher. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. atomicDec 231 . int compare.1. and stores the result back to global memory at the same address. atomicSub.

3.2

BitwiseFunctions

NAME
Bitwise Functions

DESCRIPTION
This section describes the atomic bitwise functions. atomicAnd atomicOr atomicXor

SEE ALSO
ArithmeticFunctions

232

3.2.1

atomicAnd

NAME
atomicAnd - atomic bitwise-and

SYNOPSIS
int atomicAnd(int* address, int val); unsigned int atomicAnd(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old & val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicOr, atomicXor

233

3.2.2

atomicOr

NAME
atomicOr - atomic bitwise-or

SYNOPSIS
int atomicOr(int* address, int val); unsigned int atomicOr(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old , and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicXor

234

3.2.3

atomicXor

NAME
atomicXor - atomic bitwise-xor

SYNOPSIS
int atomicXor(int* address, int val); unsigned int atomicXor(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old ˆ val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicOr

235

66 cudaChooseDevice.Index ArithmeticFunctions. 229 atomicMax. 206 cuD3D9GetDirect3DDevice. 19 cudaEventSynchronize. 89 cudaD3D9ResourceSetMapFlags. 57 cudaGetDevice. 81 cudaD3D9MapResources. 152 cuArrayDestroy. 84 cudaEventCreate. 73 cudaGLUnmapBufferObject. 222 atomicInc. 27 cudaFreeArray. 224 atomicAnd. 8 cudaConfigureCall. 23 cudaEventQuery. 220 cuD3D9ResourceGetMappedPointer. 20 cudaEventRecord. 90 cudaD3D9ResourceGetMappedSize. 230 atomicExch. 80 cudaD3D9UnmapResources. 235 BitwiseFunctions. 79 cudaD3D9GetDirect3DDevice. 87 cudaD3D9SetDirect3DDevice. 92 cudaD3D9ResourceGetMappedPointer. 118 cuCtxPushCurrent. 37 cudaMemcpy3D. 22 cudaEventElapsedTime. 227 atomicOr. 52 cudaMemcpyArrayToArray. 59 cudaBindTexture HL. 44 cudaGetSymbolSize. 233 atomicCAS. 56 cudaCreateChannelDesc HL. 28 cudaMallocHost. 6 cudaGetErrorString. 157 cuCtxAttach. 119 cuCtxSynchronize. 46 cudaMalloc3DArray. 30 cudaMallocPitch. 85 cudaD3D9RegisterResource. 120 cuD3D9CtxCreate. 64 cudaD3D9GetDevice. 74 cudaGLSetGLDevice. 225 atomicXor. 82 cudaD3D9ResourceGetMappedPitch. 62 cudaGetTextureReference. 70 cudaMalloc. 45 cudaGetTextureAlignmentOffset. 209 cuD3D9ResourceGetMappedPitch. 207 cuD3D9GetDevice. 156 cuArrayGetDescriptor. 213 cuD3D9UnregisterResource. 226 AtomicFunctions. 29 cudaFreeHost. 34 cudaMemcpy2D. 228 atomicMin. 217 cuD3D9ResourceGetMappedSize. 75 cudaGLRegisterBufferObject. 97 cudaGetLastError. 77 cudaLaunch. 18 cudaEventDestroy. 39 cudaMemcpy2DToArray. 95 cudaGetSymbolAddress. 219 cuD3D9ResourceGetSurfaceDimensions. 216 cuD3D9ResourceSetMapFlags. 35 cudaMemcpy2DArrayToArray. 25 cudaMalloc3D. 116 cuCtxGetDevice. 21 cudaFree. 158 cuArrayCreate. 43 236 . 31 cudaGetChannelDesc. 26 cudaMemcpy. 223 atomicAdd. 154 cuArray3DGetDescriptor. 38 cudaMemcpyFromSymbol. 232 ContextManagement. 111 cuArray3DCreate. 40 cudaMemcpyFromArray. 214 cuD3D9UnmapResources. 212 cuD3D9RegisterResource. 117 cuCtxPopCurrent. 86 cudaD3D9UnregisterResource. 76 cudaGLUnregisterBufferObject. 60 cudaBindTextureToArray HL. 69 cudaCreateChannelDesc. 231 atomicDec. 41 cudaMemcpy2DFromArray. 115 cuCtxDetach. 65 cudaBindTextureToArray. 58 cudaGLMapBufferObject. 211 cudaBindTexture. 208 cuD3D9MapResources. 113 cuCtxDestroy. 3 cudaGetDeviceProperties. 5 cudaGetDeviceCount. 48 cudaMallocArray. 91 cudaD3D9ResourceGetSurfaceDimensions. 112 cuCtxCreate. 234 atomicSub.

24 237 . 106 cuDeviceGetName. 141 ExecutionControl RT. 107 cuDeviceGetProperties. 16 cudaStreamQuery. 94 EventManagement. 122 cuModuleGetGlobal. 140 cuFuncSetBlockShape. 127 cuModuleUnload. 188 cuTexRefGetFilterMode. 181 cuMemset2D. 67 cuDeviceComputeCapability. 137 cuEventQuery. 191 cuTexRefSetAddress. 186 cuTexRefGetAddressMode. 187 cuTexRefGetArray. 197 DeviceManagement. 103 cuDeviceGetAttribute. 164 cuMemGetAddressRange. 142 cuLaunchGrid. 4 cudaSetupArgument. 200 cuGLMapBufferObject. 123 cuModuleGetTexRef. 148 cuStreamCreate. 149 cuFuncSetSharedSize. 151 MemoryManagement RT. 204 cuInit. 180 cuMemFree. 192 cuTexRefSetAddressMode. 130 cuStreamDestroy. 71 cudaStreamCreate. 10 cudaUnbindTexture. 190 cuTexRefGetFormat. 195 cuTexRefSetFlags. 15 cudaThreadExit. 176 cuMemcpyDtoD. 135 cuEventDestroy. 177 cuMemcpyDtoH. 63 Initialization. 146 cuParamSeti. 184 cuTexRefDestroy. 104 cuDeviceGetCount. 185 cuTexRefGetAddress. 150 cuGLCtxCreate. 50 cudaSetDevice. 203 cuGLUnregisterBufferObject. 136 cuEventElapsedTime. 170 cuMemcpyAtoA. 139 cuEventSynchronize. 166 cuMemset. 182 cuModuleGetFunction. 163 cuMemFreeHost. 99 LowLevelApi. 101 DeviceManagement RT. 201 cuGLRegisterBufferObject. 161 cuMemcpy2D. 125 cuModuleLoadData. 202 cuGLUnmapBufferObject. 61 cudaUnbindTexture HL. 165 cuMemGetInfo. 126 cuModuleLoadFatBinary. 196 cuTexRefSetFormat. 11 cudaThreadSynchronize. 78 DriverApiReference. 205 Direct3dInteroperability RT. 14 cudaStreamSynchronize. 2 Direct3dInteroperability. 132 cuStreamSynchronize. 33 cudaMemset3D. 98 ErrorHandling RT. 193 cuTexRefSetArray. 55 MemoryManagement. 174 cuMemcpyAtoH. 175 cuMemcpyDtoA. 17 ExecutionControl. 147 cuParamSetSize. 189 cuTexRefGetFlags. 108 cuDeviceTotalMem.cudaMemcpyToArray. 178 cuMemcpyHtoA. 13 cudaStreamDestroy. 134 EventManagement RT. 32 cudaMemset2D. 42 cudaMemset. 145 cuParamSetv. 128 cuParamSetf. 194 cuTexRefSetFilterMode. 110 cuEventCreate. 167 cuMemcpy3D. 102 cuDeviceGet. 143 cuMemAlloc. 100 cuLaunch. 68 HighLevelApi. 199 cuGLInit. 36 cudaMemcpyToSymbol. 173 cuMemcpyAtoD. 138 cuEventRecord. 160 cuMemAllocPitch. 144 cuParamSetTexRef. 124 cuModuleLoad. 131 cuStreamQuery. 179 cuMemcpyHtoD. 159 cuMemAllocHost. 133 cuTexRefCreate.

198 OpenGlInteroperability RT. 12 TextureReferenceManagement. 1 StreamManagement. 183 TextureReferenceManagement RT. 54 ThreadManagement RT.ModuleManagement. 129 StreamManagement RT. 72 RuntimeApiReference. 121 OpenGlInteroperability. 9 238 .

Sign up to vote on this title
UsefulNot useful