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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

asynchronous launches.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 . int value. SEE ALSO cudaMemset2D.8 cudaMemset NAME cudaMemset .initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset( void* devPtr.5.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 .SEE ALSO cudaMemset. cudaMemset2D.

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

entry must be declared as a __global__ function. SEE ALSO cudaConfigureCall.launches a device function SYNOPSIS template < class T > cudaError_t cudaLaunch(T entry) DESCRIPTION Launches the function entry on the device.2 cudaLaunch NAME cudaLaunch . entry can either be a function that executes 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. naming a function that executes on the device.1. or it can be a character string.7. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration Note that this function may also return error codes from previous. cudaSetupArgument 70 .

size_t offset) template < class T > cudaError_t cudaSetupArgument(T arg. SEE ALSO cudaConfigureCall. cudaLaunch 71 . 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(). size_t count.3 cudaSetupArgument NAME cudaSetupArgument .1. asynchronous launches. 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.configure a device-launch SYNOPSIS cudaError_t cudaSetupArgument(void* arg. which starts at offset 0. The arguments are stored in the top of the execution stack.7.

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

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

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. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotInitialized Note that this function may also return error codes from previous. While it is registered. cudaGLUnregisterBufferObject 74 . cudaGLUnmapBufferObject. cudaGLMapBufferObject. SEE ALSO cudaGLSetGLDevice.OpenGL interoperability SYNOPSIS cudaError_t cudaGLRegisterBufferObject(GLuint bufferObj) DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA.8.1. asynchronous launches.2 cudaGLRegisterBufferObject NAME cudaGLRegisterBufferObject .

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

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

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

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

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

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

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

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

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

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

SEE ALSO

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

79

1.9.2

cudaD3D9SetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

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

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

SEE ALSO

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

80

1.9.3

cudaD3D9GetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

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

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

SEE ALSO

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

81

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

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

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

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

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

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

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

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

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

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

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. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL.12 cudaD3D9ResourceGetMappedPitch NAME cudaD3D9ResourceGetMappedPitch . unsigned int Face. The values set in pPitch and pPitchSlice may change every time that pResource is mapped. unsigned int Level). If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. IDirect3DResource9* pResource. asynchronous launches. For a 2D surface the byte offset of the sample of at position x. 92 .1. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows.y.9. size_t* pPitchSlice. 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.get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedPitch(size_t* pPitch. y*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 cudaD3D9ResourceGetMappedPointer.

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.1 cuCtxAttach NAME cuCtxAttach .3. cuCtxSynchronize 112 . asynchronous launches. 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.increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx. the Flags parameter must be 0. cuCtxAttach() fails if there is no context current to the thread. SEE ALSO cuCtxCreate. cuCtxGetDevice. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. Currently. unsigned int Flags). cuCtxDetach.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.11.7

cuD3D9UnmapResources

NAME
cuD3D9UnmapResources - unmap Direct3D resources

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

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

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

SEE ALSO

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

213

2.11.8

cuD3D9ResourceSetMapFlags

NAME
cuD3D9ResourceSetMapFlags - set usage flags for mapping a Direct3D resource

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

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

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

214

SEE ALSO

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

215

2.11.9

cuD3D9ResourceGetSurfaceDimensions

NAME
cuD3D9ResourceGetSurfaceDimensions - get the dimensions of a registered surface

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

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

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

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

216

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful