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

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

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

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

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

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

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

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

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

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

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

major. deviceOverlap is 1 if the device can concurrently copy memory between host and device while executing a kernel. or 0 if not. multiProcessorCount is the number of multiprocessors on the device. clockRate is the clock frequency in kilohertz. cudaGetDevice. textureAlignment is the alignment requirement. cudaSetDevice. maxThreadsDim[3] is the maximum sizes of each dimension of a block. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. cudaChooseDevice 7 .memPitch is the maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cudaMallocPitch(). SEE ALSO cudaGetDeviceCount. maxThreadsPerBlock is the maximum number of threads per block. 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. totalConstMem is the total amount of constant memory available on the device in bytes. asynchronous launches.

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

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

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.1. asynchronous launches.1 cudaThreadSynchronize NAME cudaThreadSynchronize .2. cudaThreadSynchronize() returns an error if one of the preceding tasks failed. SEE ALSO cudaThreadExit 10 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMemset2D. cudaMalloc3D 51 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaD3D9ResourceGetSurfaceDimensions. SEE ALSO cudaD3D9GetDevice.9. cudaD3D9ResourceGetMappedSize. 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. cudaD3D9SetDirect3DDevice.unmap Direct3D resources SYNOPSIS cudaError_t cudaD3D9UnmapResources(unsigned int count. cudaD3D9ResourceGetMappedPitch 86 . DESCRIPTION Unmaps the count Direct3D resources in ppResources. cudaD3D9GetDirect3DDevice. cudaD3D9ResourceSetMa cudaD3D9ResourceGetMappedPointer. cudaD3D9RegisterResource. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.7 cudaD3D9UnmapResources NAME cudaD3D9UnmapResources . asynchronous launches. If any of ppResources are not presently mapped for access by CUDA then cudaErrorUnknown is returned. cudaD3D9MapResources. cudaD3D9UnregisterResource.1. IDirect3DResource9** ppResources).

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

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

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

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

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

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

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

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

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. 95 .10.1 cudaGetLastError NAME cudaGetLastError . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.1.

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

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

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

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

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

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

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

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

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

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

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

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

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

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

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

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

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

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

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

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

127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuMemAllocPitch. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuArrayDestroy. If count is 0. unsigned int count). cuMemFreeHost. The allocated memory is suitably aligned for any kind of variable. cuMemGetAddressRange.6 cuMemAlloc NAME cuMemAlloc . asynchronous launches. The memory is not cleared. cuMemAllocHost. cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. cuArrayGetDescriptor. cuMemFree. cuMemset2D 159 .8. SEE ALSO cuMemGetInfo. 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. cuArrayCreate. cuMemset.2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

asynchronous launches. cuTexRefGetAddressMode. cuTexRefGetAddress. cuTexRefSetFlags. cuTexRefGetArray. CUarray_format format. SEE ALSO cuTexRefCreate. cuTexRefSetAddressMode.14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefGetFlags 197 . format and numPackedComponents are exactly analogous to the Format and NumChannels members of the CUDA_ARRAY_DESCRIPTOR structure: They specify the format of each component and the number of components per array element.9. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. cuTexRefSetAddress.2. cuTexRefSetFilterMode. 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. cuTexRefGetFilterMode. cuTexRefDestroy. cuTexRefSetArray.

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

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

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

unsigned int* size.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr. cuGLUnmapBufferObject. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of the current CUDA context and returns in *devPtr and *size the base pointer and size of the resulting mapping. asynchronous launches.2. cuGLInit. cuGLUnregisterBufferObject 201 . 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. GLuint bufferObj).10. cuGLRegisterBufferObject. SEE ALSO cuGLCtxCreate.3 cuGLMapBufferObject NAME cuGLMapBufferObject .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

64-bit atomic operations are only supported on devices of compute capability 1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1.3 AtomicFunctions NAME Atomic Functions DESCRIPTION Atomic functions can only be used in device functions. BitwiseFunctions 222 .2 and higher.1 and higher. 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.

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

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

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

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

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

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

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

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

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

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

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

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