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

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

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

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

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

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

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

cudaSetDevice. cudaGetDeviceProperties. cudaChooseDevice 3 .1 cudaGetDeviceCount NAME cudaGetDeviceCount . RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. Since this device will be able to emulate all hardware features.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. If there is no such device. this device will report major and minor compute capability versions of 9999. cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode.1.0 that are available for execution. SEE ALSO cudaGetDevice. asynchronous launches.1.

1. SEE ALSO cudaGetDeviceCount. cudaChooseDevice 4 .1.2 cudaSetDevice NAME cudaSetDevice . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. cudaGetDeviceProperties. asynchronous launches.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. cudaGetDevice.

3 cudaGetDevice NAME cudaGetDevice . SEE ALSO cudaGetDeviceCount. cudaChooseDevice 5 . cudaGetDeviceProperties.1. cudaSetDevice. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.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.

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

SEE ALSO cudaGetDeviceCount. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. major. textureAlignment is the alignment requirement. maxThreadsPerBlock is the maximum number of threads per block. maxThreadsDim[3] is the maximum sizes of each dimension of a block. maxGridSize[3] is the maximum sizes of each dimension of a grid. cudaSetDevice. 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. totalConstMem is the total amount of constant memory available on the device in bytes. multiProcessorCount is the number of multiprocessors on the device. asynchronous launches. cudaChooseDevice 7 . cudaGetDevice. texture base addresses that are aligned to textureAlignment bytes do not need an offset applied to texture fetches.memPitch is the maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cudaMallocPitch(). clockRate is the clock frequency in kilohertz. or 0 if not.

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

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

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

RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. asynchronous launches.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.2 cudaThreadExit NAME cudaThreadExit .2.1. SEE ALSO cudaThreadSynchronize 11 . Any subsequent API call reinitializes the runtime. cudaThreadExit() is implicitly called on host thread exit.

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

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

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

3. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.1. cudaStreamQuery 15 .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.3 cudaStreamSynchronize NAME cudaStreamSynchronize . SEE ALSO cudaStreamCreate. asynchronous launches. cudaStreamDestroy.

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

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

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

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

asynchronous launches. cudaEventRecord. cudaEventElapsedTime 20 .4. 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. or cudaErrorNotReady if not. the function returns cudaErrorInvalidValue.3 cudaEventQuery NAME cudaEventQuery .query if an event has been recorded SYNOPSIS cudaError_t cudaEventQuery( cudaEvent_t event ) DESCRIPTION Returns cudaSuccess if the event has actually been recorded.1. cudaEventSynchronize. cudaEventDestroy. If cudaEventRecord() has not been called on this event.

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

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

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

OpenGL Interoperability. Error Handling 24 .5 MemoryManagement RT NAME Memory Management DESCRIPTION This section describes the CUDA runtime application programming interface. Texture Reference Management. Thread Management. Event Management. Execution Management. Memory 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.1. Direct3D Interoperability. Stream Management.

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

cudaFreeArray. The pitch returned in *pitch by cudaMallocPitch() is the width in bytes of the allocation. SEE ALSO cudaMalloc. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch(). Due to pitch alignment restrictions in the hardware. 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.1. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. size_t* pitch.5. cudaFree. Given the row and column of an array element of type T. For allocations of 2D arrays. cudaMallocHost. cudaFreeHost 26 . 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. size_t widthInBytes. used to compute addresses within the 2D array.2 cudaMallocPitch NAME cudaMallocPitch .allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr. 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). cudaMallocArray. The intended usage of pitch is as a separate parameter of the allocation. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column.

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

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. y. asynchronous launches. }. cudaChannelFormatKindUnsigned. cudaFreeArray. cudaMallocHost. z. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. w. const struct cudaChannelFormatDesc* desc. cudaFree. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. enum cudaChannelFormatKind f. SEE ALSO cudaMalloc. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned.5.1. cudaFreeHost 28 . cudaChannelFormatKindFloat. cudaMallocPitch. size_t width.allocate an array on the GPU SYNOPSIS cudaError_t cudaMallocArray( struct cudaArray** array.4 cudaMallocArray NAME cudaMallocArray .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

kind can be either cudaMemcpyDeviceToHost or cudaMemcpyDeviceToDevice. size_t count. naming a variable that resides in global or constant memory space. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidSymbol cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous.copies data from GPU to host memory SYNOPSIS template < class T > cudaError_t cudaMemcpyFromSymbol( void *dst. cudaMemcpyFromArray. cudaMemcpy2DArrayToArray. symbol can either be a variable that resides in global or constant memory space.19 cudaMemcpyFromSymbol NAME cudaMemcpyFromSymbol . cudaMemcpy2DToArray. or it can be a character string. cudaMemcpyArrayToArray. cudaMemcpyToArray. SEE ALSO cudaMemcpy. cudaMemcpy2DFromArray. cudaMemcpyToSymbol 43 . const T& symbol. asynchronous launches. cudaMemcpy2D. 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. size_t offset.1. The memory areas may not overlap.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. If symbol cannot be found. naming a variable that resides in global memory space. or it can be a character string. or if symbol is not declared in global memory space.20 cudaGetSymbolAddress NAME cudaGetSymbolAddress . symbol can either be a variable that resides in global memory space. *devPtr is unchanged and an error is returned.1. SEE ALSO cudaGetSymbolSize 44 .5.finds the address associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolAddress(void** devPtr. asynchronous launches.

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

size_t depth. which are equivalent to the width and height extent parameters provided by the programmer during allocation. 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 .1. 46 . or 3D memory objects on the GPU SYNOPSIS struct cudaPitchedPtr { void *ptr. The returned cudaPitchedPtr contains additional fields xsize and ysize. 2D. For allocations of 2D. asynchronous launches. The function may pad the allocation to ensure hardware alignment requirements are met. it is highly recommended that programmers perform allocations using cudaMalloc3D() or cudaMallocPitch().5. size_t pitch. size_t xsize. size_t height. the logical width and height of the allocation. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous.allocates logical 1D. }. 3D objects. The pitch returned in the pitch field of the pitchedDevPtr is the width in bytes of the allocation. cudaError_t cudaMalloc3D( struct cudaPitchedPtr* pitchDevPtr. Due to alignment restrictions in the hardware. struct cudaExtent { size_t width. }. 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).

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

For instance. cudaError_t cudaMalloc3DArray( struct cudaArray** arrayPtr. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. 2048). cudaMalloc3DArray is able to allocate 1D. asynchronous launches. a degenerate 2D array allows for significantly more linear storage than a 1D array. 65536). 48 . For 3D arrays valid extents are {(1. (1.5. • A 3D array is allocate if all three extents are non-zero. cudaChannelFormatKindFloat. size_t height. const struct cudaChannelFormatDesc* desc. enum cudaChannelFormatKind f. }. 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. or 3D arrays. 32768). }. 8192). 0} . y. 0.23 cudaMalloc3DArray NAME cudaMalloc3DArray . For 1D arrays valid extents are {(1. size_t depth. 2048). 2D. 2048)}. (1. 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.allocate an array on the GPU SYNOPSIS struct cudaExtent { size_t width. • A 2D array is allocated if only the depth extent is zero. • A 1D array is allocated if the height and depth extent are both zero. 0}. cudaChannelFormatKindUnsigned. w. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. For 2D arrays valid extents are {(1. z. (1.1.

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

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

cudaMemset2D.SEE ALSO cudaMemset. cudaMalloc3D 51 .

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

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

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

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 .1.

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

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

cudaGetTextureAlignmentOffset 58 . cudaBindTexture. SEE ALSO cudaCreateChannelDesc. cudaGetChannelDesc. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidTexture Note that this function may also return error codes from previous. cudaUnbindTexture. cudaBindTextureToArray.cudaGetTextureReference NAME cudaGetTextureReference . 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.

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

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

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

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

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 .6.1.

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

enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTexture( size_t* offset. SEE ALSO 65 . binds size bytes of the memory area pointed to by devPtr to texture reference texRef.cudaBindTexture HL NAME cudaBindTexture . const void* devPtr. desc describes how the memory is interpreted when fetching values from the texture.High-level texture API SYNOPSIS template < class T. readMode E<gt>& texRef. int dim. readMode >& texRef. dim. const void* devPtr. The channel descriptor is inherited from the texture reference type. int dim. template E<lt> 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. Any memory previously bound to texRef is unbound. const struct texture < T. size_t size = UINT_MAX). The offset parameter is an optional byte offset as with the low-level cudaBindTexture() function. size_t size = UINT_MAX) DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to texture reference texRef. const struct texture E<lt> T. const struct cudaChannelFormatDesc& desc. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTexture(size_t* offset. asynchronous launches. dim.

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

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

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

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

naming a function that executes on the device.2 cudaLaunch NAME cudaLaunch . asynchronous launches.7.1. cudaLaunch() must be preceded by a call to cudaConfigureCall() since it pops the data that was pushed by cudaConfigureCall() from the execution stack. or it can be a character string. entry must be declared as a __global__ function. SEE ALSO cudaConfigureCall. cudaSetupArgument 70 . 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. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration Note that this function may also return error codes from previous.

size_t offset) template < class T > cudaError_t cudaSetupArgument(T arg. asynchronous launches.1. 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. cudaSetupArgument() must be preceded by a call to cudaConfigureCall(). SEE ALSO cudaConfigureCall. The arguments are stored in the top of the execution stack. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. size_t count.configure a device-launch SYNOPSIS cudaError_t cudaSetupArgument(void* arg.7.3 cudaSetupArgument NAME cudaSetupArgument . cudaLaunch 71 .

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

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

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

8. cudaGLRegisterBufferObject. 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. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMapBufferObjectFailed Note that this function may also return error codes from previous.3 cudaGLMapBufferObject NAME cudaGLMapBufferObject . GLuint bufferObj). cudaGLUnmapBufferObject. asynchronous launches.1.OpenGL interoperability SYNOPSIS cudaError_t cudaGLMapBufferObject(void** devPtr. cudaGLUnregisterBufferObject 75 .

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

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

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

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

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

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

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

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

It is therefore assumed that this resource will be read from and written to by CUDA kernels. Changes to flags will take effect the next time pResource is mapped. If pResource is presently mapped for access by CUDA then cudaErrorUnknown is returned. 87 . This is the default value. • cudaD3D9MapFlagsNone: Specifies no hints about how this resource will be used.8 cudaD3D9ResourceSetMapFlags NAME cudaD3D9ResourceSetMapFlags .9. unsigned int Flags). The Flags argument may be any of the following.1. • cudaD3D9MapFlagsReadOnly: Specifies that CUDA kernels which access this resource will not write to this resource. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. • 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. If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. asynchronous launches. 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. DESCRIPTION Set flags for mapping the Direct3D resource pResource.

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

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

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

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

If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. size_t* pPitchSlice.9. The values set in pPitch and pPitchSlice may change every time that pResource is mapped. IDirect3DResource9* pResource. For a 2D surface the byte offset of the sample of at position x. 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. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x.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.y. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. unsigned int Level). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.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. asynchronous launches. 92 . For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer.12 cudaD3D9ResourceGetMappedPitch NAME cudaD3D9ResourceGetMappedPitch .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. unsigned int Face.

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

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

10.1.1 cudaGetLastError NAME cudaGetLastError .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. 95 .

cudaError 96 .SEE ALSO cudaGetErrorString.

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

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

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

asynchronous launches. SEE ALSO 100 . the Flags parameters must be 0. 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.initialize the CUDA driver API SYNOPSIS CUresult cuInit( unsigned int Flags ). If cuInit() has not been called. DESCRIPTION Initializes the driver API and must be called before any other function from the driver API. Currently.2.1.1 cuInit NAME cuInit . any function from the driver API will return CUDA_ERROR_NOT_INITIALIZED.

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

asynchronous launches. cuDeviceGet.2. 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. cuDeviceTotalMem 102 .returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major. cuDeviceGetCount. SEE ALSO cuDeviceGetAttribute. cuDeviceGetName.1 cuDeviceComputeCapability NAME cuDeviceComputeCapability .2. DESCRIPTION Returns in *major and *minor the major and minor revision numbers that define the compute capability of device dev. int* minor. CUdevice dev). cuDeviceGetProperties.

int ordinal).returns a device-handle SYNOPSIS CUresult cuDeviceGet(CUdevice* dev. cuDeviceGetName. cuDeviceGetCount. SEE ALSO cuDeviceComputeCapability. cuDeviceGetProperties. cuDeviceTotalMem 103 . cuDeviceGetCount()-1]. DESCRIPTION Returns in *dev a device handle given an ordinal in the range [0.2. cuDeviceGetAttribute.2. 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 cuDeviceGet NAME cuDeviceGet . asynchronous launches.

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

asynchronous launches. SEE ALSO cuDeviceComputeCapability. cuDeviceGetCount. cuDeviceGet. 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. cuDeviceTotalMem 105 . cuDeviceGetProperties.

cuDeviceGetName. cuDeviceTotalMem 106 . cuDeviceGetProperties. SEE ALSO cuDeviceComputeCapability. DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. cuDeviceGetCount() returns 0. cuDeviceGet. cuDeviceGetAttribute. asynchronous launches.0 that are available for execution.returns the number of compute-capable devices SYNOPSIS CUresult cuDeviceGetCount(int* count).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.4 cuDeviceGetCount NAME cuDeviceGetCount . If there is no such device.2.

5 cuDeviceGetName NAME cuDeviceGetName .2. CUdevice dev).2. int len. cuDeviceGetAttribute.returns an identifier string SYNOPSIS CUresult cuDeviceGetName(char* name. cuDeviceGetProperties. cuDeviceTotalMem 107 . SEE ALSO cuDeviceComputeCapability. 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. cuDeviceGetCount. DESCRIPTION Returns an ASCII string identifying the device dev in the NULL-terminated string pointed to by name. len specifies the maximum length of the string that may be returned. asynchronous launches. cuDeviceGet.

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

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. cuDeviceTotalMem 109 . cuDeviceGetAttribute. cuDeviceGet.

7 cuDeviceTotalMem NAME cuDeviceTotalMem . DESCRIPTION Returns in *bytes the total amount of memory available on the device dev in bytes. cuDeviceGetProperties 110 . cuDeviceGet. cuDeviceGetCount.returns the total amount of memory on the device SYNOPSIS CUresult cuDeviceTotalMem( unsigned int* bytes. CUdevice dev ). SEE ALSO cuDeviceComputeCapability.2. asynchronous launches. cuDeviceGetAttribute.2. 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. cuDeviceGetName.

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

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.1 cuCtxAttach NAME cuCtxAttach .increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx.2. cuCtxSynchronize 112 . the Flags parameter must be 0. unsigned int Flags). asynchronous launches. cuCtxGetDevice. 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. cuCtxDetach. SEE ALSO cuCtxCreate. cuCtxAttach() fails if there is no context current to the thread. Currently.3.

but can increase the performance of CPU threads performing work in parallel with the GPU. otherwise CUDA will not yield while waiting for results and actively spin on the processor. • CU_CTX_SCHED_YIELD: Instruct CUDA to yield its thread when waiting for results from the GPU. If a context is already current to the thread. asynchronous launches.create a CUDA context SYNOPSIS CUresult cuCtxCreate(CUcontext* pCtx. DESCRIPTION Creates a new CUDA context and associates it with the calling thread.3.2. This can decrease latency when waiting for the GPU. 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. If C > P then CUDA will yield to other OS threads when waiting for the GPU. • CU_CTX_SCHED_SPIN: Instruct CUDA to actively spin when waiting for results from the GPU. CUdevice dev). unsigned int Flags. it is supplanted by the newly created context and may be restored by a subsequent call to cuCtxPopCurrent().2 cuCtxCreate NAME cuCtxCreate . 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. 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 context is created with a usage count of 1 and the caller of cuCtxCreate() must call cuCtxDestroy() or cuCtxDetach() when done using the context. but may lower the performance of CPU threads if they are performing work in parallel with the CUDA thread. 113 . The Flags parameter is described below. • CU_CTX_SCHED_AUTO: The default value if the Flags parameter is zero. This can increase latency when waiting for the GPU.

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

destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). 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. or the context is current to any CPU thread other than the current one.3. this function fails. cuCtxPopCurrent 115 .3 cuCtxDestroy NAME cuCtxDestroy . If the context usage count is not equal to 1. cuCtxAttach. cuCtxPushCurrent.2. Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function. SEE ALSO cuCtxCreate. cuCtxDetach. DESCRIPTION Destroys the given CUDA context.

4 cuCtxDetach NAME cuCtxDetach . SEE ALSO cuCtxCreate. cuCtxPopCurrent 116 .decrement a context’s usage-count SYNOPSIS CUresult cuCtxDetach(CUcontext ctx). 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. asynchronous launches. and destroys the context if the usage count goes to 0. DESCRIPTION Decrements the usage count of the context. cuCtxAttach.3. The context must be a handle that was passed back by cuCtxCreate() or cuCtxAttach().2. cuCtxDestroy. cuCtxPushCurrent.

2.3.5 cuCtxGetDevice NAME cuCtxGetDevice . 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. SEE ALSO cuCtxCreate.return device-ID for current context SYNOPSIS CUresult cuCtxGetDevice(CUdevice* device). DESCRIPTION Returns in *device the ordinal of the current context’s device. cuCtxAttach. cuCtxDetach. cuCtxSynchronize 117 .

Floating contexts may be destroyed by calling cuCtxDestroy(). cuCtxDestroy. CUDA contexts have a usage count of 1 upon creation.3. The CUDA context must have a usage count of 1. DESCRIPTION Pops the current CUDA context from the CPU thread. If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent(). cuCtxAttach. If successful. cuCtxDetach.6 cuCtxPopCurrent NAME cuCtxPopCurrent . SEE ALSO cuCtxCreate. cuCtxPushCurrent 118 . the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach().pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx). this function makes that context current to the CPU thread again. cuCtxPopCurrent() passes back the context handle in *pctx. asynchronous launches.2. 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.

asynchronous launches. cuCtxDestroy.e.2." i. so all CUDA functions that operate on the current context are affected.3. cuCtxDetach. DESCRIPTION Pushes the given context onto the CPU thread’s stack of current contexts. cuCtxPopCurrent 119 . 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. Contexts are made to float by calling cuCtxPopCurrent(). cuCtxAttach.attach floating context to CPU thread SYNOPSIS CUresult cuCtxPushCurrent(CUcontext ctx).7 cuCtxPushCurrent NAME cuCtxPushCurrent . not attached to any thread. The specified context becomes the CPU thread’s current context. The previous current context may be made current again by calling cuCtxDestroy() or cuCtxPopCurrent(). SEE ALSO cuCtxCreate. The context must be "floating.

DESCRIPTION Blocks until the device has completed all preceding requested tasks. 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. cuCtxSynchronize() returns an error if one of the preceding tasks failed. asynchronous launches. cuCtxGetDevice 120 .8 cuCtxSynchronize NAME cuCtxSynchronize . cuCtxDetach. cuCtxAttach.2. SEE ALSO cuCtxCreate.block for a context’s tasks to complete SYNOPSIS CUresult cuCtxSynchronize(void).3.

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

cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND.1 cuModuleGetFunction NAME cuModuleGetFunction .2. cuModuleLoadFatBinary. cuModuleGetGlobal. cuModuleUnload. DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod. cuModuleLoadData. cuModuleGetTexRef 122 .4. If no function of that name exists. const char* funcname). CUmodule mod. 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.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func.

SEE ALSO cuModuleLoad.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr. CUmodule mod. Both parameters devPtr and bytes are optional. cuModuleUnload. it is ignored. DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod. If no variable of that name exists.2.2 cuModuleGetGlobal NAME cuModuleGetGlobal . If one of them is null. 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. asynchronous launches. cuModuleLoadFatBinary. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND.4. cuModuleGetTexRef 123 . unsigned int* bytes. const char* globalname). cuModuleGetFunction.

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

DESCRIPTION Unloads a module mod from the current context.7 cuModuleUnload NAME cuModuleUnload . cuModuleGetTexRef 128 .4. 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. SEE ALSO cuModuleLoad.unloads a module SYNOPSIS CUresult cuModuleUnload(CUmodule mod). cuModuleGetFunction. cuModuleGetGlobal. asynchronous launches. cuModuleLoadData. cuModuleLoadFatBinary.

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

asynchronous launches.create a stream SYNOPSIS CUresult cuStreamCreate(CUstream* stream. unsigned int flags).5.1 cuStreamCreate NAME cuStreamCreate . cuStreamDestroy 130 . At present. DESCRIPTION Creates a stream. cuStreamSynchronize. flags is required to be 0. SEE ALSO cuStreamQuery.2. 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.

DESCRIPTION Destroys the stream. asynchronous launches.2. cuStreamQuery. SEE ALSO cuStreamCreate. 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.destroys a stream SYNOPSIS CUresult cuStreamDestroy(CUstream stream).2 cuStreamDestroy NAME cuStreamDestroy . cuStreamSynchronize 131 .5.

5.3 cuStreamQuery NAME cuStreamQuery . cuStreamSynchronize.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. cuStreamDestroy 132 . SEE ALSO cuStreamCreate. asynchronous launches. DESCRIPTION Returns CUDA_SUCCESS if all operations in the stream have completed.determine status of a compute stream SYNOPSIS CUresult cuStreamQuery(CUstream stream). or CUDA_ERROR_NOT_READY if not.

cuStreamQuery. SEE ALSO cuStreamCreate.5.2.4 cuStreamSynchronize NAME cuStreamSynchronize . DESCRIPTION Blocks until the device has completed all operations in the stream. 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.block until a stream’s tasks are completed SYNOPSIS CUresult cuStreamSynchronize(CUstream stream). cuStreamDestroy 133 . asynchronous launches.

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

At present. cuEventElapsedTime 135 . 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. cuEventSynchronize.6.1 cuEventCreate NAME cuEventCreate . unsigned int flags). asynchronous launches.creates an event SYNOPSIS CUresult cuEventCreate(CUevent* event. SEE ALSO cuEventRecord. cuEventQuery.2. cuEventDestroy. flags is required to be 0.

asynchronous launches.6.2 cuEventDestroy NAME cuEventDestroy . DESCRIPTION Destroys the event. SEE ALSO cuEventCreate.destroys an event SYNOPSIS CUresult cuEventDestroy(CUevent event). 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. cuEventQuery. cuEventSynchronize.2. cuEventRecord. cuEventElapsedTime 136 .

3 cuEventElapsedTime NAME cuEventElapsedTime . SEE ALSO cuEventCreate. If either event has been recorded with a non-zero stream. CUevent start.6. cuEventRecord. asynchronous launches. If either event has not been recorded yet. 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 Computes the elapsed time between two events (in milliseconds with a resolution of around 0.5 microseconds).computes the elapsed time between two events SYNOPSIS CUresult cuEventDestroy(float* time. cuEventDestroy 137 . the result is undefined. cuEventSynchronize. cuEventQuery. this function returns CUDA_ERROR_INVALID_VALUE. CUevent end).2.

6.queries an event’s status SYNOPSIS CUresult cuEventQuery(CUevent event). cuEventRecord.4 cuEventQuery NAME cuEventQuery . asynchronous launches.2. If cuEventRecord() has not been called on this event. SEE ALSO cuEventCreate. cuEventDestroy. 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. cuEventElapsedTime 138 . cuEventSynchronize. or CUDA_ERROR_NOT_READY if not. DESCRIPTION Returns CUDA_SUCCESS if the event has actually been recorded.

this function returns CUDA_ERROR_INVALID_VALUE. cuEventDestroy. 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 CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. cuEventElapsedTime 139 .2. cuEventQuery. Since this operation is asynchronous. cuEventQuery() and/or cuEventSynchronize() must be used to determine when the event has actually been recorded.5 cuEventRecord NAME cuEventRecord . CUstream stream). otherwise.6. it is recorded after all preceding operations in the CUDA context have been completed. DESCRIPTION Records an event. If cuEventRecord() has previously been called and the event has not been recorded yet. If stream is non-zero. the event is recorded after all preceding operations in the stream have been completed. cuEventSynchronize.records an event SYNOPSIS CUresult cuEventRecord(CUevent event.

DESCRIPTION Blocks until the event has actually been recorded.6. If cuEventRecord() has not been called on this event. cuEventRecord. cuEventElapsedTime 140 . the function returns CUDA_ERROR_INVALID_VALUE. cuEventDestroy.6 cuEventSynchronize NAME cuEventSynchronize .2.waits for an event to complete SYNOPSIS CUresult cuEventSynchronize(CUevent event). asynchronous launches. 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. cuEventQuery. SEE ALSO cuEventCreate.

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

asynchronous launches. cuParamSeti. cuParamSetf. 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. The block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). cuParamSetTexRef.7.1 cuLaunch NAME cuLaunch . DESCRIPTION Invokes the kernel func on a 1ÃŮ1 grid of blocks. SEE ALSO cuFuncSetBlockShape. cuParamSetv.2. cuLaunchGrid 142 . cuParamSetSize. cuFuncSetSharedSize.launches a CUDA function SYNOPSIS CUresult cuLaunch(CUfunction func).

CUstream stream). int grid_height. int grid_width. Each block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). int grid_width. cuParamSetTexRef.launches a CUDA function SYNOPSIS CUresult cuLaunchGrid(CUfunction func. asynchronous launches. cuParamSetf. cuLaunch 143 . cuParamSeti. cuParamSetSize.7. SEE ALSO cuFuncSetBlockShape. cuLaunchGridAsync() can optionally be associated to a stream by passing a non-zero stream argument.2 cuLaunchGrid NAME cuLaunchGrid . DESCRIPTION Invokes the kernel on a grid_width x grid_height grid of blocks. 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. CUresult cuLaunchGridAsync(CUfunction func. cuFuncSetSharedSize. cuParamSetv.2. int grid_height).

cuParamSetf. cuParamSeti. cuLaunchGrid 144 . cuParamSetv. cuFuncSetSharedSize. asynchronous launches.7.3 cuParamSetSize NAME cuParamSetSize . 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 through numbytes the total size in bytes needed by the function parameters of function func. unsigned int numbytes).2. cuParamSetTexRef. cuLaunch.sets the parameter-size for the function SYNOPSIS CUresult cuParamSetSize(CUfunction func. SEE ALSO cuFuncSetBlockShape.

cuLaunchGrid 145 .4 cuParamSetTexRef NAME cuParamSetTexRef . cuParamSetv. cuParamSetf. cuParamSetSize.2. cuParamSeti. int texunit. asynchronous launches. cuFuncSetSharedSize. SEE ALSO cuFuncSetBlockShape.7.adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(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. the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT. CUtexref texRef). DESCRIPTION Makes the CUDA array or linear memory bound to the texture reference texRef available to a device program as a texture. cuLaunch. In this version of CUDA.

SEE ALSO cuFuncSetBlockShape. cuParamSetSize.5 cuParamSetf NAME cuParamSetf . cuParamSetv. DESCRIPTION Sets a floating point parameter that will be specified the next time the kernel corresponding to func will be invoked. cuLaunchGrid 146 . cuFuncSetSharedSize. asynchronous launches.7.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. cuLaunch. int offset. offset is a byte offset. cuParamSetTexRef. cuParamSeti.adds a floating-point parameter to the function’s argument list SYNOPSIS CUresult cuParamSetf(CUfunction func. float value).

7.2. cuParamSetf. cuFuncSetSharedSize. cuParamSetTexRef. cuParamSetv. cuLaunch. cuLaunchGrid 147 .6 cuParamSeti NAME cuParamSeti . int offset. unsigned int value).adds an integer parameter to the function’s argument list SYNOPSIS CUresult cuParamSeti(CUfunction func. cuParamSetSize. 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. offset is a byte offset. DESCRIPTION Sets an integer parameter that will be specified the next time the kernel corresponding to func will be invoked.

cuParamSetSize. cuLaunch. cuParamSetf. cuParamSetTexRef. offset is a byte offset. SEE ALSO cuFuncSetBlockShape.2. int offset. cuParamSeti. asynchronous launches. cuFuncSetSharedSize. DESCRIPTION Copies an arbitrary amount of data into the parameter space of the kernel corresponding to func.7. cuLaunchGrid 148 .7 cuParamSetv NAME cuParamSetv . void* ptr. unsigned int numbytes).adds arbitrary data to the function’s argument list SYNOPSIS CUresult cuParamSetv(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.

cuParamSetSize. DESCRIPTION Specifies the X. cuLaunchGrid 149 . cuParamSetf.8 cuFuncSetBlockShape NAME cuFuncSetBlockShape .7. 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. cuLaunch. cuParamSetv. SEE ALSO cuFuncSetSharedSize.2. int y. int z). cuParamSetTexRef. cuParamSeti. Y and Z dimensions of the thread blocks that are created when the kernel given by func is launched. int x.sets the block-dimensions for the function SYNOPSIS CUresult cuFuncSetBlockShape(CUfunction func. asynchronous launches.

asynchronous launches.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . cuLaunch. SEE ALSO cuFuncSetBlockShape. cuParamSetf. unsigned int bytes). cuParamSetSize. 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.7. cuLaunchGrid 150 .sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. 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.2. cuParamSetv. cuParamSetTexRef. cuParamSeti.

2. ContextManagement. DeviceManagement. ModuleManagement. StreamManagement. EventManagement. MemoryManagement.8 MemoryManagement NAME Memory Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. Direct3dInteroperability 151 . 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. TextureReferenceManagement. ExecutionControl. OpenGlInteroperability.

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

desc.Height = 1.Format = CU_AD_FORMAT_FLOAT. desc. cuArrayGetDescriptor. • Description for a width x height CUDA array of 64-bit.Height = height. desc. cuMemset. cuMemset2D 153 .Height = height.FormatFlags = CU_AD_FORMAT_HALF.desc. cuMemAllocPitch.NumChannels = 4. cuMemAlloc. cuMemAllocHost. desc.Width = width.Width = 2048.Width = width. desc. cuMemGetAddressRange.Height = 64. desc. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY_DESCRIPTOR desc. desc. desc.NumChannels = 1. cuArrayDestroy. 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.Width = 64. cuMemFree. desc.NumChannels = 2. desc. desc. SEE ALSO cuMemGetInfo. asynchronous launches. desc. desc. cuMemFreeHost.NumChannels = 1. desc. each of which is two 8-bit unsigned chars: CUDA_ARRAY_DESCRIPTOR arrayDesc. • Description for a width x height CUDA array of 16-bit elements.FormatFlags = CU_AD_FORMAT_UNSIGNED_INTS.

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

Format = CU_AD_FORMAT_FLOAT. • Description for a width x height x depth CUDA array of 64-bit. 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. cuMemGetAddressRange. cuMemAllocHost.• Description for a CUDA array of 2048 floats: CUDA_ARRAY3D_DESCRIPTOR desc. desc. desc.Width = width.Depth = 0.NumChannels = 1.Height = 64.Depth = depth. desc. desc. desc. desc. cuMemFree. desc.Height = 0. cuMemFreeHost. desc. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc.FormatFlags = CU_AD_FORMAT_HALF. desc. desc. desc. cuArray3DGetDescriptor. desc. desc. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY3D_DESCRIPTOR desc.Format = CU_AD_FORMAT_FLOAT. SEE ALSO cuMemGetInfo. cuMemAllocPitch.Width = 2048.Height = height. cuMemAlloc. desc.Width = 64.Depth = 0.NumChannels = 4. desc. asynchronous launches.NumChannels = 1. cuArrayDestroy 155 .

cuArrayCreate. DESCRIPTION Destroys the CUDA array array. cuMemGetAddressRange. cuMemAlloc.2. cuMemFreeHost. cuMemAllocHost. SEE ALSO cuMemGetInfo. cuMemset2D 156 . cuMemset.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array).8. cuMemFree.3 cuArrayDestroy NAME cuArrayDestroy . cuMemAllocPitch. 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_ARRAY_IS_MAPPED Note that this function may also return error codes from previous. cuArrayGetDescriptor.

It is useful for subroutines that have been passed a CUDA array. cuArray3DCreate. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array. but need to know the CUDA array parameters for validation or other purposes.get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc.2. cuArray3DGetDescriptor. 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. cuArrayDestroy 157 .8. asynchronous launches. SEE ALSO cuArrayCreate.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor .

5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor . asynchronous launches.get a 3D CUDA array descriptor SYNOPSIS CUresult cuArray3DGetDescriptor(CUDA_ARRAY3D_DESC *arrayDesc. but need to know the CUDA array parameters for validation or other purposes. cuArrayGetDescriptor. DESCRIPTION Returns in *arrayDesc a descriptor containing information on the format and dimensions of the CUDA array array. cuArrayDestroy 158 . CUarray array).8. 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. It is useful for subroutines that have been passed a CUDA array. cuArray3DCreate.2. SEE ALSO cuArrayCreate.

2. cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. The memory is not cleared. The allocated memory is suitably aligned for any kind of variable. cuMemFree.8. cuMemset. cuMemAllocHost. cuMemAllocPitch. cuArrayDestroy. DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. cuMemGetAddressRange. cuMemset2D 159 . unsigned int count). SEE ALSO cuMemGetInfo.6 cuMemAlloc NAME cuMemAlloc . cuArrayGetDescriptor. If count is 0. cuMemFreeHost.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. cuArrayCreate. 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.

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

DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. For allocations of 2D arrays. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * Pitch) + Column. elementSizeBytes specifies the size of the largest reads and writes that will be performed on the memory range. 8 or 16 (since coalesced memory transactions are not possible on other data sizes). unsigned int height. but possibly at reduced speed. asynchronous launches. elementSizeBytes may be 4.allocates device memory SYNOPSIS CUresult cuMemAllocPitch(CUdeviceptr* devPtr. If elementSizeBytes is smaller than the actual read/write size of a kernel. 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.8 cuMemAllocPitch NAME cuMemAllocPitch .2. The intended usage of pitch is as a separate parameter of the allocation. 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). Due to alignment restrictions in the hardware.8. unsigned int elementSizeBytes). unsigned int* pitch. used to compute addresses within the 2D 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_OUT_OF_MEMORY Note that this function may also return error codes from previous. unsigned int widthInBytes. Given the row and column of an array element of type T. The pitch returned in *pitch by cuMemAllocPitch() is the width in bytes of the allocation. it is recommended that programmers consider performing pitch allocations using cuMemAllocPitch(). The pitch returned by cuMemAllocPitch() is guaranteed to work with cuMemcpy2D() under all circumstances. the kernel will run correctly. 161 .

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

9 cuMemFree NAME cuMemFree . asynchronous launches. cuMemAlloc.2. cuArrayGetDescriptor.8. cuArrayCreate. cuMemFreeHost. SEE ALSO cuMemGetInfo.frees device memory SYNOPSIS CUresult cuMemFree(CUdeviceptr devPtr). DESCRIPTION Frees the memory space pointed to by 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. cuMemGetAddressRange. which must have been returned by a previous call to cuMemMalloc() or cuMemMallocPitch(). cuMemset. cuArrayDestroy. cuMemAllocPitch. cuMemset2D 163 . cuMemAllocHost.

cuMemGetAddressRange. cuMemAlloc. SEE ALSO cuMemGetInfo. 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. which must have been returned by a previous call to cuMemAllocHost(). cuArrayCreate. cuMemset2D 164 . cuArrayDestroy. cuArrayGetDescriptor. cuMemAllocHost. cuMemFree. cuMemAllocPitch. cuMemset.2.8.10 cuMemFreeHost NAME cuMemFreeHost . DESCRIPTION Frees the memory space pointed to by hostPtr. asynchronous launches.frees page-locked host memory SYNOPSIS CUresult cuMemFreeHost(void* hostPtr).

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. cuMemAllocPitch. it is ignored. cuMemset2D 165 . SEE ALSO cuMemGetInfo. cuMemset. If one of them is null.2. cuMemAllocHost. Both parameters basePtr and size are optional. DESCRIPTION Returns the base address in *basePtr and size and *size of the allocation by cuMemAlloc() or cuMemAllocPitch() that contains the input pointer devPtr. CUdeviceptr devPtr). asynchronous launches.11 cuMemGetAddressRange NAME cuMemGetAddressRange . cuArrayCreate. unsigned int* size. cuArrayDestroy. cuArrayGetDescriptor. cuMemFree.get information on memory allocations SYNOPSIS CUresult cuMemGetAddressRange(CUdeviceptr* basePtr. cuMemFreeHost. cuMemAlloc.

2. cuMemset2D 166 . cuMemGetAddressRange. cuMemFree. cuArrayCreate.gets free and total memory SYNOPSIS CUresult cuMemGetInfo(unsigned int* free. asynchronous launches. the free and total amount of memory available for allocation by the CUDA 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. SEE ALSO cuMemAlloc. cuArrayGetDescriptor.8.12 cuMemGetInfo NAME cuMemGetInfo . cuMemset. cuMemFreeHost. unsigned int* total). DESCRIPTION Returns in *free and *total respectively. in bytes. cuMemAllocPitch. cuMemAllocHost. cuArrayDestroy.

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

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

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

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

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

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

count is the number of bytes to be copied. cuMemcpy2D 173 . dstArray and srcArray specify the handles of the destination and source CUDA arrays for the copy. they are not byte offsets.copies memory from Array to Array SYNOPSIS CUresult cuMemcpyAtoA(CUarray dstArray. but the elements must be the same size. DESCRIPTION Copies from one 1D CUDA array to another. respectively.15 cuMemcpyAtoA NAME cuMemcpyAtoA . cuMemcpyDtoD. cuMemcpyAtoD. dstIndex and srcIndex specify the destination and source indices into the CUDA array.8. The size of the elements in the CUDA arrays need not be the same format. cuMemcpyDtoA. These values are in the range [0. unsigned int count). SEE ALSO cuMemcpyHtoD. 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. cuMemcpyHtoA. CUarray srcArray. cuMemcpyAtoH. asynchronous launches. cuMemcpyDtoH. unsigned int dstIndex.2. and count must be evenly divisible by that size. Width-1] for the CUDA array. unsigned int srcIndex.

CUarray srcArray. cuMemcpyDtoA. srcArray and srcIndex specify the CUDA array handle and the index (in array elements) of the array element where the copy is to begin. unsigned int srcIndex.16 cuMemcpyAtoD NAME cuMemcpyAtoD . cuMemcpyDtoD. asynchronous launches. cuMemcpyAtoH. cuMemcpyHtoA. SEE ALSO cuMemcpyHtoD. cuMemcpyAtoA. dstDevPtr specifies the base pointer of the destination and must be naturally aligned with the CUDA array elements.8. cuMemcpy2D 174 . unsigned int count).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. cuMemcpyDtoH.copies memory from Array to Device SYNOPSIS CUresult cuMemcpyAtoD(CUdeviceptr dstDevPtr. DESCRIPTION Copies from a 1D CUDA array to device memory. count specifies the number of bytes to copy and must be evenly divisible by the array element size.

CUarray srcArray. cuMemcpyDtoH.copies memory from Array to Host SYNOPSIS CUresult cuMemcpyAtoH(void* dstHostPtr. SEE ALSO cuMemcpyHtoD. cuMemcpyDtoA. cuMemcpyAtoHAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. unsigned int srcIndex.8. CUarray srcArray. asynchronous launches. CUresult cuMemcpyAtoHAsync(void* dstHostPtr.2. cuMemcpyDtoD. unsigned int count). srcArray and srcIndex specify the CUDA array handle and starting index of the source data. cuMemcpyAtoA. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.17 cuMemcpyAtoH NAME cuMempcyAtoH . DESCRIPTION Copies from a 1D CUDA array to host memory. unsigned int srcIndex. cuMemcpy2D 175 . count specifies the number of bytes to copy. CUstream stream). cuMemcpyHtoA. unsigned int count. dstHostPtr specifies the base pointer of the destination. cuMemcpyAtoD. 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. cuMemcpyAtoH. asynchronous launches. count specifies the number of bytes to copy. cuMemcpyAtoD. unsigned int dstIndex.18 cuMemcpyDtoA NAME cuMemcpyDtoA . 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. cuMemcpyAtoA. SEE ALSO cuMemcpyHtoD.8. cuMemcpyDtoH. DESCRIPTION Copies from device memory to a 1D CUDA array. cuMemcpy2D 176 . unsigned int count). dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. srcDevPtr specifies the base pointer of the source. cuMemcpyDtoD.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray. CUdeviceptr srcDevPtr. cuMemcpyHtoA.

2. dstDevice and srcDevPtr are the base pointers of the destination and source. cuMemcpyAtoD.8. cuMemcpyDtoA. 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. unsigned int count).copies memory from Device to Device SYNOPSIS CUresult cuMemcpyDtoD(CUdeviceptr dstDevPtr. DESCRIPTION Copies from device memory to device memory. cuMemcpyDtoH. cuMemcpyHtoA. cuMemcpyAtoA. cuMemcpyAtoH. count specifies the number of bytes to copy. SEE ALSO cuMemcpyHtoD.19 cuMemcpyDtoD NAME cuMemcpyDtoD . CUdeviceptr srcDevPtr. cuMemcpy2D 177 . respectively.

copies memory from Device to Host SYNOPSIS CUresult cuMemcpyDtoH(void* dstHostPtr. asynchronous launches. dstHostPtr and srcDevPtrspecify the base addresses of the source and destination. cuMemcpyAtoD. unsigned int count). cuMemcpyDtoA. MemcpyDtoHAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. SEE ALSO cuMemcpyHtoD. CUdeviceptr srcDevPtr. CUresult cuMemcpyDtoHAsync(void* dstHostPtr. cuMemcpy2D 178 . cuMemcpyHtoA. DESCRIPTION Copies from device to host 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. cuMemcpyDtoD.20 cuMemcpyDtoH NAME cuMemcpyDtoH . CUdeviceptr srcDevPtr. cuMemcpyAtoH.8. unsigned int count. cuMemcpyAtoA.2. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. countspecifies the number of bytes to copy. CUstream stream). respectively.

21 cuMemcpyHtoA NAME cuMemcpyHtoA . cuMemcpy2D 179 . asynchronous launches. const void *srcHostPtr. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. SEE ALSO cuMemcpyHtoD. cuMemcpyDtoH. unsigned int dstIndex. unsigned int dstIndex. cuMemcpyAtoA. cuMemcpyHtoAAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument.copies memory from Host to Array SYNOPSIS CUresult cuMemcpyHtoA(CUarray dstArray. cuMemcpyAtoD. cuMemcpyDtoA. CUresult cuMemcpyHtoAAsync(CUarray dstArray. DESCRIPTION Copies from host memory to a 1D CUDA array. CUstream stream). srcHostPtr specify the base addresse of the source. cuMemcpyAtoH. const void *srcHostPtr. count specifies the number of bytes to copy. cuMemcpyDtoD.2.8. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. 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. unsigned int count).

cuMemcpyHtoDAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. CUstream stream). const void *srcHostPtr. respectively. cuMemcpyDtoA. CUresult cuMemcpyHtoDAsync(CUdeviceptr dstDevPtr.8.copy memory from Host to Device SYNOPSIS CUresult cuMemcpyHtoD(CUdeviceptr dstDevPtr. cuMemcpyHtoA. 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. cuMemcpy2D 180 . const void *srcHostPtr. unsigned int count). DESCRIPTION Copies from host memory to device memory. cuMemcpyAtoH. cuMemcpyAtoD. count specifies the number of bytes to copy. cuMemcpyAtoA. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.2. unsigned int count. SEE ALSO cuMemcpyDtoH.22 cuMemcpyHtoD NAME cuMemcpyHtoD . dstDevPtr and srcHostPtr specify the base addresses of the destination and source. cuMemcpyDtoD. asynchronous launches.

16-. unsigned int count ). cuArrayCreate. cuMemset2D 181 . SEE ALSO cuMemGetInfo.2. unsigned int count ). or 32-bit values to the specified value value. cuMemGetAddressRange. unsigned int value. DESCRIPTION Sets the memory range of count 8-. asynchronous launches. 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 count ). cuMemAlloc. cuMemFreeHost. unsigned char value. cuArrayGetDescriptor. CUresult cuMemsetD16(CUdeviceptr dstDevPtr.8. cuMemAllocHost. cuMemAllocPitch. unsigned short value. cuArrayDestroy. cuMemFree.initializes device memory SYNOPSIS CUresult cuMemsetD8(CUdeviceptr dstDevPtr.23 cuMemset NAME cuMemset . CUresult cuMemsetD32(CUdeviceptr dstDevPtr.

asynchronous launches. cuMemFree. cuArrayGetDescriptor. cuMemAlloc. cuMemGetAddressRange. unsigned int dstPitch. unsigned short value. unsigned int dstPitch. unsigned int dstPitch. CUresult cuMemsetD2D16(CUdeviceptr dstDevPtr. unsigned int height ).2. These functions perform fastest when the pitch is one that has been passed back by cuMemAllocPitch(). 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 the 2D memory range of width 8-. cuArrayCreate. and dstPitch specifies the number of bytes between each row. cuMemAllocPitch. unsigned int width. 16-. unsigned int width.24 cuMemset2D NAME cuMemset2D .8. or 32-bit values to the specified value value.initializes device memory SYNOPSIS CUresult cuMemsetD2D8(CUdeviceptr dstDevPtr. CUresult cuMemsetD2D32(CUdeviceptr dstDevPtr. unsigned int width. height specifies the number of rows to set. unsigned int value. cuMemAllocHost. cuMemset 182 . unsigned int height ). cuMemFreeHost. cuArrayDestroy. unsigned int height ). unsigned char value. SEE ALSO cuMemGetInfo.

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

cuTexRefGetAddressMode. SEE ALSO 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. asynchronous launches. cuTexRefGetArray.) to be used when the memory is read through this texture reference. the application must call cuTexRefSetArray() or cuTexRefSetAddress() to associate the reference with allocated memory.2. the application should call cuParamSetTexRef().1 cuTexRefCreate NAME cuTexRefCreate . filtering. cuTexRefSetAddressMode. DESCRIPTION Creates a texture reference and returns its handle in *texRef.creates a texture-reference SYNOPSIS CUresult cuTexRefCreate(CUtexref* texRef). cuTexRefGetFilterMode. etc. cuTexRefSetFilterMode. cuTexRefSetAddress. cuTexRefGetFlags 184 . Once created. cuTexRefSetFormat. cuTexRefSetFlags. Other texture reference functions are used to specify the format and interpretation (addressing. To associate the texture reference with a texture ordinal for a given function. cuTexRefGetFormat. cuTexRefSetArray. cuTexRefGetAddress.9.

destroys a texture-reference SYNOPSIS CUresult cuTexRefDestroy(CUtexref texRef). cuTexRefSetAddress. cuTexRefSetFilterMode. cuTexRefGetFormat. cuTexRefGetAddress.9. SEE ALSO cuTexRefCreate. cuTexRefGetFilterMode. cuTexRefGetFlags 185 . cuTexRefSetArray. cuTexRefGetAddressMode. cuTexRefSetFlags.2 cuTexRefDestroy NAME 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. DESCRIPTION Destroys the texture reference. cuTexRefSetFormat. asynchronous launches. cuTexRefGetArray. cuTexRefSetAddressMode.2.

3 cuTexRefGetAddress NAME cuTexRefGetAddress . cuTexRefSetFlags.2. cuTexRefSetFormat.gets the address associated with a texture-reference SYNOPSIS CUresult cuTexRefGetAddress(CUdeviceptr* devPtr. 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. cuTexRefGetAddressMode. CUtexref texRef).9. asynchronous launches. cuTexRefGetArray. SEE ALSO cuTexRefCreate. DESCRIPTION Returns in *devPtr the base address bound to the texture reference texRef. or returns CUDA_ERROR_INVALID_VA if the texture reference is not bound to any device memory range. cuTexRefGetFlags 186 . cuTexRefGetFormat. cuTexRefSetFilterMode. cuTexRefSetArray. cuTexRefSetAddressMode. cuTexRefSetAddress. cuTexRefGetFilterMode.

CUtexref texRef. cuTexRefGetFormat. cuTexRefGetAddress. DESCRIPTION Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef.2. asynchronous launches. cuTexRefSetArray.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode. 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. cuTexRefGetFlags 187 . cuTexRefSetFormat. cuTexRefGetFilterMode. cuTexRefGetArray. cuTexRefSetAddressMode. cuTexRefSetFilterMode. cuTexRefSetFlags.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode . cuTexRefSetAddress. cuTexRefDestroy. Currently the only valid values for dim are 0 and 1.9. int dim).

cuTexRefGetAddress. cuTexRefSetAddress. 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 cuTexRefCreate. cuTexRefSetFormat. cuTexRefGetFilterMode. cuTexRefSetAddressMode. cuTexRefSetArray. cuTexRefGetAddressMode.9. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. cuTexRefSetFilterMode. cuTexRefDestroy.2.5 cuTexRefGetArray NAME cuTexRefGetArray . cuTexRefGetFormat. CUtexref texRef).gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. cuTexRefSetFlags. asynchronous launches. cuTexRefGetFlags 188 . or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array.

cuTexRefGetFlags 189 .2. cuTexRefGetAddress. asynchronous launches. cuTexRefSetFilterMode. cuTexRefSetAddressMode. cuTexRefGetArray. cuTexRefDestroy. cuTexRefSetFlags. CUtexref 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. SEE ALSO cuTexRefCreate. cuTexRefSetAddress. cuTexRefSetArray.6 cuTexRefGetFilterMode NAME cuTexRefGetFilterMode . cuTexRefGetFormat. cuTexRefSetFormat.gets the filter-mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetFilterMode(CUfilter_mode* mode.9. cuTexRefGetAddressMode. DESCRIPTION Returns in *mode the filtering mode of the texture reference texRef.

9.7 cuTexRefGetFlags NAME cuTexRefGetFlags . cuTexRefSetFlags. 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. CUtexref texRef).gets the flags used by a texture-reference SYNOPSIS CUresult cuTexRefGetFlags(unsigned int* flags. cuTexRefSetAddress. cuTexRefSetAddressMode. asynchronous launches. cuTexRefGetFormat 190 . cuTexRefGetFilterMode. cuTexRefSetFilterMode. cuTexRefSetArray. cuTexRefSetFormat. SEE ALSO cuTexRefCreate. cuTexRefDestroy. cuTexRefGetArray. DESCRIPTION Returns in *flags the flags of the texture reference texRef. cuTexRefGetAddressMode.2.

cuTexRefSetAddressMode.gets the format used by a texture-reference SYNOPSIS CUresult cuTexRefGetFormat(CUarray_format* format. 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. it will be ignored. cuTexRefSetFormat. int* numPackedComponents. cuTexRefGetArray. SEE ALSO cuTexRefCreate. asynchronous launches. If format or numPackedComponents is null. DESCRIPTION Returns in *format and *numPackedComponents the format and number of components of the CUDA array bound to the texture reference texRef. cuTexRefDestroy. cuTexRefGetFlags 191 . cuTexRefSetArray. CUtexref texRef). cuTexRefGetFilterMode. cuTexRefSetFilterMode. cuTexRefGetAddress.2.8 cuTexRefGetFormat NAME cuTexRefGetFormat .9. cuTexRefGetAddressMode. cuTexRefSetFlags.

Since the hardware enforces an alignment requirement on texture base addresses.2.9 cuTexRefSetAddress NAME cuTexRefSetAddress . cuTexRefSetArray. cuTexRefSetFlags. DESCRIPTION Binds a linear address range to the texture reference texRef. asynchronous launches. cuTexRefGetFormat. If the device memory pointer was returned from cuMemAlloc().9. 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. int bytes). cuTexRefGetFilterMode. cuTexRefGetArray. cuTexRefSetAddress() passes back a byte offset in *byteOffset that must be applied to texture fetches in order to read from the desired memory. SEE ALSO cuTexRefCreate. cuTexRefSetAddressMode. cuTexRefSetFormat. cuTexRefGetAddress. Any previous address or CUDA array state associated with the texture reference is superseded by this function.binds an address as a texture-reference SYNOPSIS CUresult cuTexRefSetAddress(unsigned int* byteOffset. CUdeviceptr devPtr. cuTexRefGetFlags 192 . cuTexRefSetFilterMode. the offset is guaranteed to be 0 and NULL may be passed as the ByteOffset parameter. cuTexRefDestroy. 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. CUtexref texRef.

cuTexRefGetAddress. cuTexRefGetFlags 193 . DESCRIPTION Specifies the addressing mode mode for the given dimension of the texture reference texRef.9. cuTexRefGetArray. cuTexRefSetFilterMode. the addressing mode is applied to the first parameter of the functions used to fetch from the texture. 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. cuTexRefGetFilterMode. CU_TR_ADDRESS_MODE_MIRROR = 2. cuTexRefSetArray. CUaddress_mode is defined as such: typedef enum CUaddress_mode_enum { CU_TR_ADDRESS_MODE_WRAP = 0. CU_TR_ADDRESS_MODE_CLAMP = 1. Note that this call has no effect if texRef is bound to linear memory. cuTexRefGetAddressMode.2. CUaddress_mode mode). cuTexRefSetFlags. If dim is zero. asynchronous launches. cuTexRefSetAddress. } CUaddress_mode. cuTexRefSetFormat.10 cuTexRefSetAddressMode NAME cuTexRefSetAddressMode . cuTexRefGetFormat. int dim. if dim is 1. SEE ALSO cuTexRefCreate. and so on. the second.set the addressing mode for a texture-reference SYNOPSIS CUresult cuTexRefSetAddressMode(CUtexref texRef.

cuTexRefGetFlags 194 . cuTexRefGetAddress. cuTexRefGetFormat. cuTexRefGetArray. cuTexRefGetFilterMode. asynchronous launches. Any previous address or CUDA array state associated with the texture reference is superseded by this function. cuTexRefSetAddressMode. cuTexRefDestroy. flags must be set to CU_TRSA_OVERRIDE_FORMAT. 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 flags). cuTexRefSetAddress. cuTexRefGetAddressMode.9. SEE ALSO cuTexRefCreate. cuTexRefSetFilterMode. CUarray array. cuTexRefSetFlags. DESCRIPTION Binds the CUDA array array to the texture reference texRef.11 cuTexRefSetArray NAME cuTexRefSetArray .2. cuTexRefSetFormat. Any CUDA array previously bound to texRef is unbound.binds an array to a texture-reference SYNOPSIS CUresult cuTexRefSetArray(CUtexref texRef.

cuTexRefSetFlags. cuTexRefGetFilterMode. cuTexRefDestroy. cuTexRefGetArray. DESCRIPTION Specifies the filtering mode mode to be used when reading memory through the texture reference texRef. cuTexRefGetFormat.sets the mode for a texture-reference SYNOPSIS CUresult cuTexRefSetFilterMode(CUtexref texRef. cuTexRefSetAddressMode. CU_TR_FILTER_MODE_LINEAR = 1 } CUfilter_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. cuTexRefGetFlags 195 . Note that this call has no effect if texRef is bound to linear memory.2. cuTexRefGetAddress. CUfilter_mode mode). cuTexRefSetArray.12 cuTexRefSetFilterMode NAME cuTexRefSetFilterMode . CUfilter_mode_enum is defined as such: typedef enum CUfilter_mode_enum { CU_TR_FILTER_MODE_POINT = 0. SEE ALSO cuTexRefCreate. cuTexRefGetAddressMode. cuTexRefSetFormat.9. asynchronous launches. cuTexRefSetAddress.

1. cuTexRefSetFilterMode. cuTexRefSetArray.sets flags for a texture-reference SYNOPSIS CUresult cuTexRefSetFlags(CUtexref texRef. cuTexRefGetArray. Instead.2.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. DESCRIPTION Specifies optional flags to control the behavior of data returned through the texture reference. cuTexRefSetAddress. cuTexRefGetFormat. unsigned int Flags). cuTexRefGetFlags 196 . which suppresses the default behavior of having the texture coordinates range from [0. which suppresses the default behavior of having the texture promote integer data to floating point data in the range [0. The valid flags are: • CU_TRSF_READ_AS_INTEGER. the texture coordinates [0. Dim) where Dim is the width or height of the CUDA array. • CU_TRSF_NORMALIZED_COORDINATES. cuTexRefGetFilterMode. SEE ALSO cuTexRefCreate. 1].13 cuTexRefSetFlags NAME cuTexRefSetFlags . cuTexRefSetAddressMode. cuTexRefGetAddress. cuTexRefSetFormat. cuTexRefGetAddressMode. cuTexRefDestroy. asynchronous launches.9.

14 cuTexRefSetFormat NAME cuTexRefSetFormat . SEE ALSO cuTexRefCreate. cuTexRefGetAddress. cuTexRefSetFlags. cuTexRefSetAddressMode.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. CUarray_format format. asynchronous launches. cuTexRefGetArray. cuTexRefSetAddress. cuTexRefSetArray. cuTexRefGetAddressMode. cuTexRefSetFilterMode. cuTexRefGetFilterMode.9. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef. cuTexRefGetFormat. cuTexRefDestroy.2. cuTexRefGetFlags 197 . 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. 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. StreamManagement. ExecutionControl.10 OpenGlInteroperability NAME OpenGL Interoperability DESCRIPTION This section describes the low-level CUDA driver application programming interface. EventManagement. ContextManagement. OpenGLInteroperability. MemoryManagement. TextureReferenceManagement. Direct3dInteroperability 198 . cuGLCtxCreate cuGLInit cuGLMapBufferObject cuGLRegisterBufferObject cuGLUnmapBufferObject cuGLUnregisterBufferObject SEE ALSO Initialization. ModuleManagement. DeviceManagement.

initializes OpenGL interoperability.1 cuGLCtxCreate NAME cuGLCtxCreate .2. 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. CUdevice device).create a CUDA context for interoperability with OpenGL SYNOPSIS CUresult cuGLCtxCreate(CUcontext *pCtx. DESCRIPTION Creates a new CUDA context. cuGLUnmapBufferObject. see cuCtxCreate. unsigned int Flags. and associates the CUDA context with the calling thread.10. SEE ALSO cuCtxCreate. cuGLUnregisterBufferObject 199 . It must be called before performing any other OpenGL interoperability operations. cuGLMapBufferObject. For usage of the Flags parameter. cuGLInit cuGLRegisterBufferObject. asynchronous launches. It may fail if the needed OpenGL driver facilities are not available.

asynchronous launches.2. SEE ALSO cuGLCtxCreate. It must be called before performing any other OpenGL interoperability operations.2 cuGLInit NAME cuGLInit . It may fail if the needed OpenGL driver facilities are not available. cuGLUnmapBufferObject. cuGLRegisterBufferObject.10. DESCRIPTION Initializes OpenGL interoperability. cuGLUnregisterBufferObject 200 .initializes GL interoperability SYNOPSIS CUresult cuGLInit(void). 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. cuGLMapBufferObject.

cuGLUnregisterBufferObject 201 . 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. unsigned int* size.10. SEE ALSO cuGLCtxCreate. asynchronous launches.2. 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.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr. cuGLInit. cuGLUnmapBufferObject. cuGLRegisterBufferObject.3 cuGLMapBufferObject NAME cuGLMapBufferObject . GLuint bufferObj).

4 cuGLRegisterBufferObject NAME cuGLRegisterBufferObject . asynchronous launches. DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. cuGLInit. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. While it is registered.10. SEE ALSO cuGLCtxCreate. This function must be called before CUDA can map the buffer object. cuGLMapBufferObject. cuGLUnmapBufferObject.2. 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.unmaps a GL buffer object SYNOPSIS CUresult cuGLUnmapBufferObject(GLuint bufferObj). 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. cuGLMapBufferObject.5 cuGLUnmapBufferObject NAME cuGLUnmapBufferObject . cuGLUnregisterBufferObject 203 . cuGLInit. SEE ALSO cuGLCtxCreate. cuGLRegisterBufferObject.10. asynchronous launches. DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA.

6 cuGLUnregisterBufferObject NAME cuGLUnregisterBufferObject .unregister a GL buffer object SYNOPSIS CUresult cuGLUnregisterBufferObject(GLuint bufferObj). 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.10. SEE ALSO cuGLCtxCreate. cuGLRegisterBufferObject. asynchronous launches. DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA. cuGLMapBufferObject. cuGLInit. cuGLUnmapBufferObject 204 .

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

cuD3D9UnregisterResource. const char* adapterName).2. cuD3D9ResourceGetMappedPitch 206 . cuD3D9RegisterResource. cuD3D9UnmapResources. SEE ALSO cuD3D9CtxCreate. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceSetMapFlags.gets the device number for an adapter SYNOPSIS CUresult cuD3D9GetDevice(CUdevice* dev.11. cuD3D9MapResources. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. 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. cuD3D9GetDirect3DDevice. asynchronous launches.1 cuD3D9GetDevice NAME cuD3D9GetDevice . If no device on the adapter with name adapterName is CUDA-compatible then the call will fail. DESCRIPTION Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier().

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

cuD3D9CtxCreate. cuD3D9ResourceSetMapFlags. cuD3D9UnmapResources. cuD3D9MapResources. cuD3D9RegisterResource.11.get the Direct3D device against which the current CUDA context was created SYNOPSIS CUresult cuD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice).2. SEE ALSO cuD3D9GetDevice. 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. cuD3D9ResourceGetMappedPitch 208 . cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. asynchronous launches. DESCRIPTION Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cuD3D9CtxCreate. cuD3D9UnregisterResource.3 cuD3D9GetDirect3DDevice NAME cuD3D9GetDirect3DDevice .

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

cuD3D9ResourceSetMapFlags. cuD3D9CtxCreate. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. If pResource is of incorrect type (e. asynchronous launches. cuD3D9UnmapResources. If Direct3D interoperability is not initialized on this context then CUDA_ERROR_INVALID_CONTEXT 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_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.• Surfaces of depth or stencil formats cannot be shared.g. cuD3D9ResourceGetMappedPitch 210 . is a non-stand-alone IDirect3DSurface9) or is already registered then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9UnregisterResource. SEE ALSO cuD3D9GetDevice. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetSurfaceDimensions. If pResource cannot be registered then CUDA_ERROR_UNKNOWN is returned. cuD3D9MapResources.

asynchronous launches. cuD3D9ResourceGetSurfaceDimensions.2.unregister a Direct3D resource SYNOPSIS CUresult cuD3D9UnregisterResource(IDirect3DResource9* pResource).11. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned.5 cuD3D9UnregisterResource NAME cuD3D9UnregisterResource . cuD3D9CtxCreate. cuD3D9RegisterResource. 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. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again. SEE ALSO cuD3D9GetDevice. cuD3D9UnmapResources. cuD3D9ResourceGetMappedPitch 211 . cuD3D9GetDirect3DDevice. cuD3D9ResourceSetMapFlags. cuD3D9MapResources.

The resources in ppResources may be accessed in CUDA kernels until they are unmapped. 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. 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.6 cuD3D9MapResources NAME cuD3D9MapResources .map Direct3D resources for access by CUDA SYNOPSIS CUresult cuD3D9MapResources(unsigned int count. If an application does so the results are undefined. IDirect3DResource9 **ppResources). cuD3D9CtxCreate.11. cuD3D9ResourceGetMappedPitch 212 . asynchronous launches. cuD3D9UnregisterResource. If any of ppResources are presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned. Direct3D should not access any resources while they are mapped by CUDA. cuD3D9RegisterResource.2. This function provides the synchronization guarantee that any Direct3D calls issued before cuD3D9MapResources will complete before any CUDA kernels issued after cuD3D9MapResources begin. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceSetMapFlags. cuD3D9UnmapResources. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. cuD3D9GetDirect3DDevice.

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

If Face is invalid then CUDA_ERROR_INVALID_V 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_NOT_MAPPED Note that this function may also return error codes from previous. If Level is invalid then CUDA_ERROR_INVALID_VALUE is returned. If pResource is not mapped then CUDA_ERROR_NOT_MAPPED is returned.11. The value set in pDevPtr may change every time that pResource is mapped. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. For all other types Level must be 0. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVA is returned. If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. DESCRIPTION Returns in *pDevPtr the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. At present only mipmap level 0 is supported.10 cuD3D9ResourceGetMappedPointer NAME cuD3D9ResourceGetMappedPointer . IDirect3DResource9* pResource. unsigned int Face. unsigned int Level).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.2. asynchronous launches. For all other types Face must be 0. 217 .

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

11 cuD3D9ResourceGetMappedSize NAME cuD3D9ResourceGetMappedSize . 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.11. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. cuD3D9CtxCreate. cuD3D9GetDirect3DDevice. cuD3D9ResourceSetMapFlags. cuD3D9MapResources.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedSize(unsigned int* pSize. cuD3D9UnmapResources.2. If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. cuD3D9ResourceGetSurfaceDimensions. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. unsigned int Level). asynchronous launches. The value set in pSize may change every time that pResource is mapped. unsigned int Face. cuD3D9ResourceGetMappedPointer. cuD3D9UnregisterResource. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9RegisterResource. IDirect3DResource9* pResource. cuD3D9ResourceGetMappedPitch 219 . SEE ALSO cuD3D9GetDevice.

The values set in pPitch and pPitchSlice may change every time that pResource is mapped. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.11.y. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. asynchronous launches. IDirect3DResource pResource.2.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. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows.12 cuD3D9ResourceGetMappedPitch NAME cuD3D9ResourceGetMappedPitch . If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. unsigned int Level). unsigned int* pPitchSlice. 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.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.get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedPitch(unsigned int* pPitch. 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. 220 . unsigned int Face. For a 2D surface the byte offset of the sample of at position x. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer.

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

1 and higher.2 and higher. BitwiseFunctions 222 . SEE ALSO ArithmeticFunctions. 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.3 AtomicFunctions NAME Atomic Functions DESCRIPTION Atomic functions can only be used in device functions.

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful