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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaEventElapsedTime 19 .2 cudaEventRecord NAME cudaEventRecord . 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. cudaEventQuery() and/or cudaEventSynchronize() must be used to determine when the event has actually been recorded. CUstream stream ) DESCRIPTION Records an event. If cudaEventRecord() has previously been called and the event has not been recorded yet. it is recorded after all preceding operations in the CUDA context have been completed. cudaEventQuery. SEE ALSO cudaEventCreate. Since this operation is asynchronous. the event is recorded after all preceding operations in the stream have been completed. cudaEventDestroy. cudaEventSynchronize. asynchronous launches. otherwise. If stream is non-zero.records an event SYNOPSIS cudaError_t cudaEventRecord( cudaEvent_t event.4.1.

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

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

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

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

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

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

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

5. no operation is performed.3 cudaFree NAME cudaFree . cudaFreeArray. If devPtr is 0. asynchronous launches. cudaFreeHost 27 . an error is returned. Otherwise. cudaMallocArray. cudaMallocPitch. or if cudaFree(devPtr) has already been called before. SEE ALSO cudaMalloc.frees memory on the GPU SYNOPSIS cudaError_t cudaFree(void* devPtr) DESCRIPTION Frees the memory space pointed to by devPtr. cudaMallocHost.1. 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. cudaFree() returns cudaErrorInvalidDevicePointer in case of failure.

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

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

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

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

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

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

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

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

const void* src. cudaMemcpy2D. cudaMemcpy2DArrayToArray. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyToArrayAsync(struct cudaArray* dstArray. SEE ALSO cudaMemcpy.1. cudaMemcpyHostToDevice. cudaMemcpyFromArray. 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.5. 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. dstY). asynchronous launches. size_t dstY. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. const void* src. size_t count. cudaMemcpyToSymbol. enum cudaMemcpyKind kind. cudaMemcpyToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument.12 cudaMemcpyToArray NAME cudaMemcpyToArray .copies data between host and device SYNOPSIS cudaError_t cudaMemcpyToArray(struct cudaArray* dstArray. size_t dstY. cudaMemcpyArrayToArray. cudaMemcpy2DToArray. cudaMemcpy2DFromArray. cudaMemcpyFromSymbol 36 . where kind is one of cudaMemcpyHostToHost. size_t count. or cudaMemcpyDeviceToDevice. size_t dstX. cudaMemcpyDeviceToHost. size_t dstX.

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

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

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

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

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

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

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

20 cudaGetSymbolAddress NAME cudaGetSymbolAddress . If symbol cannot be found. or if symbol is not declared in global memory space.1. symbol can either be a variable that resides in global memory space. SEE ALSO cudaGetSymbolSize 44 . 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.finds the address associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolAddress(void** devPtr. naming a variable that resides in global memory space.5. const T& symbol) DESCRIPTION Returns in *devPtr the address of symbol symbol on the device. *devPtr is unchanged and an error is returned. asynchronous launches. or it can be a character string.

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMemset2D. cudaMalloc3D 51 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaError 96 .SEE ALSO cudaGetErrorString.

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

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

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

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

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

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

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

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

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

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

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

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

cuDeviceGet. cuDeviceGetAttribute. SEE ALSO cuDeviceComputeCapability. cuDeviceGetName. cuDeviceTotalMem 109 .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. asynchronous launches. cuDeviceGetCount.

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

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

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

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

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

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

4 cuCtxDetach NAME cuCtxDetach . and must be current to the calling thread. cuCtxPopCurrent 116 . cuCtxDestroy. The context must be a handle that was passed back by cuCtxCreate() or cuCtxAttach(). SEE ALSO cuCtxCreate. cuCtxPushCurrent. asynchronous launches. cuCtxAttach.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.2. and destroys the context if the usage count goes to 0.3. DESCRIPTION Decrements the usage count of the context.

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

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

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

cuCtxGetDevice 120 . 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. cuCtxDetach.8 cuCtxSynchronize NAME cuCtxSynchronize .block for a context’s tasks to complete SYNOPSIS CUresult cuCtxSynchronize(void).2. SEE ALSO cuCtxCreate. cuCtxAttach. asynchronous launches.3.

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

If no function of that name exists. cuModuleLoadData. cuModuleLoadFatBinary. cuModuleUnload. 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. DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod. const char* funcname). CUmodule mod.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func.4. cuModuleGetTexRef 122 . cuModuleGetGlobal.1 cuModuleGetFunction NAME cuModuleGetFunction . SEE ALSO cuModuleLoad. asynchronous launches. cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND.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_NOT_FOUND Note that this function may also return error codes from previous. Both parameters devPtr and bytes are optional. const char* globalname).2. cuModuleLoadFatBinary.4. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND. it is ignored. If one of them is null. cuModuleUnload. DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod.2 cuModuleGetGlobal NAME cuModuleGetGlobal . asynchronous launches. cuModuleGetFunction.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr. CUmodule mod. cuModuleGetTexRef 123 . SEE ALSO cuModuleLoad. If no variable of that name exists. cuModuleLoadData. unsigned int* bytes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . SEE ALSO cuFuncSetBlockShape. cuLaunch.7. unsigned int bytes).2. cuParamSetTexRef. cuParamSetf. asynchronous launches. cuParamSetv. cuParamSeti. 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.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. cuLaunchGrid 150 .

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

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

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

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

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

cuArrayGetDescriptor. cuMemset. cuMemAllocHost. SEE ALSO cuMemGetInfo.3 cuArrayDestroy NAME cuArrayDestroy . DESCRIPTION Destroys the CUDA array array. 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. cuArrayCreate.8. cuMemset2D 156 .2. cuMemFree. cuMemGetAddressRange. cuMemAllocPitch. cuMemAlloc. asynchronous launches.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array). cuMemFreeHost.

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

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

6 cuMemAlloc NAME cuMemAlloc . cuArrayDestroy. The allocated memory is suitably aligned for any kind of variable. cuArrayGetDescriptor. DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. cuMemAllocHost. cuMemGetAddressRange. cuMemFree. unsigned int count). SEE ALSO cuMemGetInfo.2. The memory is not cleared. asynchronous launches. cuMemAllocPitch. If count is 0. cuMemAlloc() 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_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuMemset2D 159 .8. cuMemFreeHost.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. cuMemset. 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. DESCRIPTION Allocates count bytes of host memory that is page-locked and accessible to the device. asynchronous launches.8. As a result. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc(). cuMemset2D 160 . Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance. cuArrayDestroy. cuArrayGetDescriptor. since it reduces the amount of memory available to the system for paging.2. unsigned int count). this function is best used sparingly to allocate staging areas for data exchange between host and device. Since the memory can be accessed directly by the device. cuMemAllocPitch. cuMemFreeHost. cuMemAlloc. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cuMemcpy().allocates page-locked host memory SYNOPSIS CUresult cuMemAllocHost(void** hostPtr. SEE ALSO cuMemGetInfo. cuArrayCreate.7 cuMemAllocHost NAME cuMemAllocHost . cuMemset. cuMemFree. cuMemGetAddressRange.

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cuMemcpyHtoD. cuMemcpyAtoA. unsigned int count). CUarray srcArray. 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 srcIndex. asynchronous launches.2.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.16 cuMemcpyAtoD NAME cuMemcpyAtoD . cuMemcpyDtoA. cuMemcpyDtoH. dstDevPtr specifies the base pointer of the destination and must be naturally aligned with the CUDA array elements. cuMemcpyDtoD. cuMemcpyAtoH. cuMemcpyHtoA.8. srcArray and srcIndex specify the CUDA array handle and the index (in array elements) of the array element where the copy is to begin. cuMemcpy2D 174 .

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

cuMemcpyAtoH. cuMemcpy2D 176 . 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). srcDevPtr specifies the base pointer of the source. cuMemcpyAtoD. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. unsigned int dstIndex. SEE ALSO cuMemcpyHtoD. cuMemcpyAtoA.8. DESCRIPTION Copies from device memory to a 1D CUDA array. cuMemcpyHtoA.2.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray.18 cuMemcpyDtoA NAME cuMemcpyDtoA . CUdeviceptr srcDevPtr. count specifies the number of bytes to copy. cuMemcpyDtoD. cuMemcpyDtoH.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefDestroy. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef. cuTexRefGetAddressMode. cuTexRefGetFormat. cuTexRefSetArray. SEE ALSO cuTexRefCreate. 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.9. cuTexRefSetAddressMode. cuTexRefGetFilterMode. CUarray_format format. cuTexRefSetAddress. 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. cuTexRefGetArray.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. asynchronous launches. cuTexRefSetFilterMode. cuTexRefGetFlags 197 .2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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