NVIDIA CUDA Compute Unified Device Architecture

Reference Manual

Version 2.0
June 2008

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

cudaGetDeviceCount

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

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

1.3

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

1.4

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

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

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

1.5

MemoryManagement RT 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9

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

cudaMallocArray

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

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

i

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

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

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

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

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

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

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

1.7

ExecutionControl RT 1.7.1 1.7.2 1.7.3

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

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

1.8

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

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

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

1.9

Direct3dInteroperability RT 1.9.1 1.9.2 1.9.3 1.9.4 cudaD3D9GetDevice

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

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

1.9.5 1.9.6 1.9.7 1.9.8 1.9.9

cudaD3D9UnregisterResource cudaD3D9MapResources

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

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

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

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

1.9.10 cudaD3D9ResourceGetMappedPointer 1.9.11 cudaD3D9ResourceGetMappedSize

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

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

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

DeviceManagement 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7

cuDeviceComputeCapability

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

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

2.3

ContextManagement 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8

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

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

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

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

2.4

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

iii

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

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

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

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

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

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

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

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

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

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

maxGridSize[3] is the maximum sizes of each dimension of a grid. maxThreadsPerBlock is the maximum number of threads per block. texture base addresses that are aligned to textureAlignment bytes do not need an offset applied to texture fetches. cudaSetDevice. textureAlignment is the alignment requirement.memPitch is the maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cudaMallocPitch(). asynchronous launches. totalConstMem is the total amount of constant memory available on the device in bytes. 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. maxThreadsDim[3] is the maximum sizes of each dimension of a block. cudaChooseDevice 7 . or 0 if not. SEE ALSO cudaGetDeviceCount. major. multiProcessorCount is the number of multiprocessors on the device. minor are the major and minor revision numbers defining the device’s compute capability. clockRate is the clock frequency in kilohertz. cudaGetDevice.

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

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

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 . cudaThreadSynchronize() returns an error if one of the preceding tasks failed. SEE ALSO cudaThreadExit 10 .2.1. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. asynchronous launches.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaFree. 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.1 cudaMalloc NAME cudaMalloc .1. The memory is not cleared.allocate memory on the GPU SYNOPSIS cudaError_t cudaMalloc( void** devPtr. cudaFreeArray. asynchronous launches. cudaFreeHost 25 . The allocated memory is suitably aligned for any kind of variable.5. cudaMalloc() returns cudaErrorMemoryAllocation in case of failure. SEE ALSO cudaMallocPitch. cudaMallocArray. cudaMallocHost.

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

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

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

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

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

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

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

5. This function performs fastest when the pitch is one that has been passed back by cudaMallocPitch(). asynchronous launches.1. size_t pitch. int value. including any padding added to the end of each row.9 cudaMemset2D NAME cudaMemset2D . pitch is the width in memory in bytes of the 2D array 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 height ) DESCRIPTION Sets to the specified value value a matrix (height rows of width bytes each) pointed to by dstPtr. size_t width. SEE ALSO cudaMemset.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset2D( void* dstPtr.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 .SEE ALSO cudaMemset. cudaMemset2D.

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

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

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

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

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

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

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. const char* symbol) DESCRIPTION Returns in *texRef the structure associated to the texture reference defined by symbol symbol. cudaBindTexture. cudaBindTextureToArray.cudaGetTextureReference NAME cudaGetTextureReference . cudaGetChannelDesc. cudaUnbindTexture. asynchronous launches. cudaGetTextureAlignmentOffset 58 . SEE ALSO cudaCreateChannelDesc.

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

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

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

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

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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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. cudaGLMapBufferObject. cudaGLRegisterBufferObject.1. asynchronous launches.OpenGL interoperability SYNOPSIS cudaError_t cudaGLUnregisterBufferObject(GLuint bufferObj).8. SEE ALSO cudaGLSetGLDevice. cudaGLUnmapBufferObject 77 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaError 96 .SEE ALSO cudaGetErrorString.

DESCRIPTION Returns a message string from an error code.2 cudaGetErrorString NAME cudaGetErrorString .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.1.

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

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

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

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

cuDeviceGetProperties. cuDeviceGetName. CUdevice dev).1 cuDeviceComputeCapability NAME cuDeviceComputeCapability . int* minor. SEE ALSO cuDeviceGetAttribute. asynchronous launches. cuDeviceGet.returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major. cuDeviceGetCount. 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. cuDeviceTotalMem 102 .2.2.

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

• 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. DESCRIPTION Returns in *value the integer value of the attribute attrib on device dev. this amount is shared by all thread blocks simultaneously resident on a multiprocessor. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_Z: maximum z-dimension of a grid. The supported attributes are: • CU_DEVICE_ATTRIBUTE_MAX_THREADS_PER_BLOCK: maximum number of threads per block. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Y: maximum y-dimension of a block. • CU_DEVICE_ATTRIBUTE_TEXTURE_ALIGNMENT: alignment requirement. • CU_DEVICE_ATTRIBUTE_MAX_REGISTERS_PER_BLOCK: maximum number of 32-bit registers available to a thread block. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Z: maximum z-dimension of a block. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_X: maximum x-dimension of a block. • CU_DEVICE_ATTRIBUTE_MULTIPROCESSOR_COUNT: number of multiprocessors on the device. CUdevice_attribute attrib. or 0 if not. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_X: maximum x-dimension of a grid.3 cuDeviceGetAttribute NAME cuDeviceGetAttribute .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. texture base addresses aligned to textureAlign bytes do not need an offset applied to texture fetches. 104 .2. • CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK: maximum amount of shared memory available to a thread block in bytes. • CU_DEVICE_ATTRIBUTE_CLOCK_RATE: clock frequency in kilohertz. this number is shared by all thread blocks simultaneously resident on a multiprocessor.returns information about the device SYNOPSIS CUresult cuDeviceGetAttribute(int* value. • CU_DEVICE_ATTRIBUTE_TOTAL_CONSTANT_MEMORY: total amount of constant memory available on the device in bytes. CUdevice dev).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

7. unsigned int bytes).9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . SEE ALSO cuFuncSetBlockShape. cuParamSetf. cuLaunch. cuParamSetSize. cuParamSetTexRef. cuParamSetv. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuLaunchGrid 150 . cuParamSeti.2. asynchronous launches. 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.

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

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

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

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

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

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

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

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

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

cuMemAlloc.7 cuMemAllocHost NAME cuMemAllocHost . 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. cuMemGetAddressRange. asynchronous launches.8. cuMemFree. cuMemset. cuArrayDestroy. cuMemAllocPitch. unsigned int count). cuArrayCreate. Since the memory can be accessed directly by the device. cuArrayGetDescriptor. SEE ALSO cuMemGetInfo. As a result. cuMemFreeHost. Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance. 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. cuMemset2D 160 . since it reduces the amount of memory available to the system for paging.2. this function is best used sparingly to allocate staging areas for data exchange between host and device. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc().

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

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

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

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

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

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

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

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

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

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

srcDevice. For device pointers. the bytes per row. srcY and srcZ specify the base address of the source data for the copy. srcXInBytes must be evenly divisible by the array element size. height and depth of the 3D copy being performed. • WidthInBytes. If srcMemoryType is CU_MEMORYTYPE_HOST. dstHost and dstPitch specify the (host) base address of the destination data. For device pointers. srcArray specifies the handle of the source data. the base address is void* dstStart = (void*)((char*)dstHost+(dstZ*dstHeight+dstY)*dstPitch + dstXInBytes). srcPitch and srcHeight specify the (host) base address of the source data. srcPitch and srcHeight specify the (device) base address of the source data. srcDevice. srcArray is ignored. srcPitch and srcHeight are ignored. 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. CU_MEMORYTYPE_DEVICE = 0x02. dstHost. the bytes per row. the bytes per row. Height and Depth specify the width (in bytes). dstArray is ignored. Any pitches must be greater than or equal to WidthInBytes. dstDevice and dstPitch specify the (device) base address of the destination data. the starting address is void* Start = (void*)((char*)srcHost+(srcZ*srcHeight+srcY)*srcPitch + srcXInBytes).CU_MEMORYTYPE_HOST = 0x01. If srcMemoryType is CU_MEMORYTYPE_DEVICE. The srcLOD and dstLOD members of the CUDA_MEMCPY3D structure must be set to 0. dstXInBytes must be evenly divisible by the array element size. dstY and dstZ specify the base address of the destination data for the copy. For CUDA arrays. If dstMemoryType is CU_MEMORYTYPE_DEVICE. dstPitch and dstHeight are ignored. the starting address is CUdeviceptr dstStart = dstDevice+(dstZ*dstHeight+dstY)*dstPitch+dstXInBytes. • srcXInBytes. If dstMemoryType is CU_MEMORYTYPE_ARRAY. cuMemcpy3DAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. CU_MEMORYTYPE_ARRAY = 0x03 } CUmemorytype. the starting address is CUdeviceptr Start = srcDevice+(srcZ*srcHeight+srcY)*srcPitch+srcXInBytes. and the height of each 2D slice of the 3D array. the bytes per row. and the height of each 2D slice of the 3D array. For host pointers. If dstMemoryType is CU_MEMORYTYPE_HOST. 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. srcHost. For host pointers. • dstXInBytes. dstArray specifies the handle of the destination data. and the height of each 2D slice of the 3D array. srcHost. If srcMemoryType is CU_MEMORYTYPE_ARRAY. srcArray is ignored. For CUDA arrays.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful