NVIDIA CUDA Compute Unified Device Architecture

Reference Manual

Version 2.0
June 2008

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

cudaGetDeviceCount

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

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

1.3

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

1.4

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

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

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

1.5

MemoryManagement RT 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9

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

cudaMallocArray

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

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

i

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

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

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

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

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

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

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

1.7

ExecutionControl RT 1.7.1 1.7.2 1.7.3

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

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

1.8

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

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

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

1.9

Direct3dInteroperability RT 1.9.1 1.9.2 1.9.3 1.9.4 cudaD3D9GetDevice

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

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

1.9.5 1.9.6 1.9.7 1.9.8 1.9.9

cudaD3D9UnregisterResource cudaD3D9MapResources

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

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

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

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

1.9.10 cudaD3D9ResourceGetMappedPointer 1.9.11 cudaD3D9ResourceGetMappedSize

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

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

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

DeviceManagement 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7

cuDeviceComputeCapability

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

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

2.3

ContextManagement 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8

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

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

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

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

2.4

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

iii

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaEventCreate. If cudaEventRecord() has not been called on this event.wait for an event to be recorded SYNOPSIS cudaError_t cudaEventSynchronize( cudaEvent_t event ) DESCRIPTION Blocks until the event has actually been recorded.4 cudaEventSynchronize NAME cudaEventSynchronize .4. cudaEventQuery. the function returns cudaErrorInvalidValue.1. cudaEventElapsedTime 21 . cudaEventRecord. asynchronous launches. cudaEventDestroy. RETURN VALUE Relevant return values: cudaSuccess 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 Note that this function may also return error codes from previous.5 cudaEventDestroy NAME cudaEventDestroy . SEE ALSO cudaEventCreate. cudaEventQuery.destroys an event-object SYNOPSIS cudaError_t cudaEventDestroy( cudaEvent_t event ) DESCRIPTION Destroys the event-object. cudaEventElapsedTime 22 . cudaEventSynchronize.4. asynchronous launches.1.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. size_t count. cudaMemcpy2DFromArray.18 cudaMemcpyToSymbol NAME cudaMemcpyToSymbol . kind can be either cudaMemcpyHostToDevice or cudaMemcpyDeviceToDevice. cudaMemcpy2D.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. naming a variable that resides in global or constant memory space. const void* src. SEE ALSO cudaMemcpy. The memory areas may not overlap. cudaMemcpyFromArray. cudaMemcpy2DArrayToArray. cudaMemcpyToArray. or it can be a character string. symbol can either be a variable that resides in global or constant memory space. cudaMemcpyArrayToArray.5. size_t offset. cudaMemcpy2DToArray. asynchronous launches. 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 .

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

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

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMalloc3D 51 . cudaMemset2D.

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

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

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

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

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

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

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

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. cudaGetTextureReference. cudaUnbindTexture. SEE ALSO cudaCreateChannelDesc. asynchronous launches. const struct cudaArray* array. cudaGetChannelDesc.cudaBindTextureToArray NAME cudaBindTextureToArray . const struct cudaChannelFormatDesc* desc). DESCRIPTION Binds the CUDA array array to the texture reference texRef. cudaGetTextureAlignmentOffset 60 .Low-level texture API SYNOPSIS cudaError_t cudaBindTextureToArray( const struct textureReference* texRef. desc describes how the memory is interpreted when fetching values from the texture. cudaBindTexture.

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaGLUnmapBufferObject. cudaGLUnregisterBufferObject 74 .8. This function must be called before CUDA can map the buffer object.1. asynchronous launches. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. SEE ALSO cudaGLSetGLDevice. While it is registered. 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. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotInitialized Note that this function may also return error codes from previous.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

10. 95 .1 cudaGetLastError NAME cudaGetLastError . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.returns the last error from a run-time call SYNOPSIS cudaError_t cudaGetLastError( void ) DESCRIPTION Returns the last error that was returned from any of the runtime calls in the same host thread and resets it to cudaSuccess.1.

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called. The CUDA context must have a usage count of 1. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent(). cuCtxPopCurrent() passes back the context handle in *pctx. CUDA contexts have a usage count of 1 upon creation. cuCtxDetach. If successful.6 cuCtxPopCurrent NAME cuCtxPopCurrent . cuCtxPushCurrent 118 . cuCtxAttach.pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx). the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach(). SEE ALSO cuCtxCreate.3. DESCRIPTION Pops the current CUDA context from the CPU thread.2. Floating contexts may be destroyed by calling cuCtxDestroy(). cuCtxDestroy. asynchronous launches. this function makes that context current to the CPU thread again. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuEventQuery. this function returns CUDA_ERROR_INVALID_VALUE. cuEventRecord. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. If either event has not been recorded yet.2.3 cuEventElapsedTime NAME cuEventElapsedTime . cuEventDestroy 137 . DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0.6. the result is undefined. SEE ALSO cuEventCreate.computes the elapsed time between two events SYNOPSIS CUresult cuEventDestroy(float* time. cuEventSynchronize. CUevent end).5 microseconds). If either event has been recorded with a non-zero stream. CUevent start.

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

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

cuEventQuery.waits for an event to complete SYNOPSIS CUresult cuEventSynchronize(CUevent event). DESCRIPTION Blocks until the event has actually been recorded.6. cuEventDestroy.2. cuEventElapsedTime 140 . cuEventRecord. the function returns CUDA_ERROR_INVALID_VALUE. asynchronous launches.6 cuEventSynchronize NAME cuEventSynchronize . 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 Note that this function may also return error codes from previous. If cuEventRecord() has not been called on this event.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuMemAlloc. asynchronous launches.2. cuArrayCreate. cuMemGetAddressRange. cuMemFree.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array). cuMemFreeHost. cuMemAllocPitch.8. cuMemset2D 156 . SEE ALSO cuMemGetInfo. cuArrayGetDescriptor. cuMemAllocHost. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ARRAY_IS_MAPPED Note that this function may also return error codes from previous. DESCRIPTION Destroys the CUDA array array. cuMemset.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_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuArray3DGetDescriptor.2. It is useful for subroutines that have been passed a CUDA array. SEE ALSO cuArrayCreate.8.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor . cuArray3DCreate. asynchronous launches.get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc. cuArrayDestroy 157 . CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array. but need to know the CUDA array parameters for validation or other purposes.

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

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

2. SEE ALSO cuMemGetInfo. cuMemset2D 160 .7 cuMemAllocHost NAME cuMemAllocHost . cuMemFree. cuMemAllocPitch. this function is best used sparingly to allocate staging areas for data exchange between host and device. cuMemFreeHost.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. cuMemGetAddressRange. cuArrayGetDescriptor. As a result. cuMemAlloc. cuArrayCreate. DESCRIPTION Allocates count bytes of host memory that is page-locked and accessible to the device. since it reduces the amount of memory available to the system for paging. cuArrayDestroy. asynchronous launches. Since the memory can be accessed directly by the device. unsigned int count). 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 cuMemcpy(). cuMemset. Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance.8.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

count specifies the number of bytes to copy. cuMemcpyAtoD. cuMemcpyDtoH. unsigned int dstIndex. SEE ALSO cuMemcpyHtoD.8. cuMemcpyAtoH.18 cuMemcpyDtoA NAME cuMemcpyDtoA . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. srcDevPtr specifies the base pointer of the source. unsigned int count). cuMemcpyHtoA. cuMemcpyDtoD. cuMemcpy2D 176 . dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. cuMemcpyAtoA. DESCRIPTION Copies from device memory to a 1D CUDA array. asynchronous launches.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray. CUdeviceptr srcDevPtr.2.

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

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

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

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

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

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

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

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

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

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

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

CUtexref texRef). cuTexRefSetFlags. cuTexRefGetAddress.5 cuTexRefGetArray NAME cuTexRefGetArray .2. cuTexRefGetAddressMode. cuTexRefSetFormat. cuTexRefSetArray.gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. cuTexRefGetFilterMode. cuTexRefSetFilterMode. asynchronous launches. cuTexRefDestroy. cuTexRefGetFlags 188 . or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array. cuTexRefSetAddressMode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetFormat. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. SEE ALSO cuTexRefCreate.9. cuTexRefSetAddress.

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

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

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

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

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

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

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

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

cuTexRefSetAddress. asynchronous launches. CUarray_format format. cuTexRefSetArray.2. cuTexRefSetFilterMode. cuTexRefGetFlags 197 . cuTexRefDestroy. cuTexRefGetFormat. cuTexRefSetAddressMode. format and numPackedComponents are exactly analogous to the Format and NumChannels members of the CUDA_ARRAY_DESCRIPTOR structure: They specify the format of each component and the number of components per array element.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. cuTexRefSetFlags. cuTexRefGetAddressMode. SEE ALSO cuTexRefCreate. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef. cuTexRefGetFilterMode. cuTexRefGetArray.9.14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefGetAddress. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

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

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

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

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_MAP_FAILED Note that this function may also return error codes from previous. SEE ALSO cuGLCtxCreate. cuGLInit. asynchronous launches. cuGLRegisterBufferObject.3 cuGLMapBufferObject NAME cuGLMapBufferObject .10. unsigned int* size. 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. cuGLUnmapBufferObject. cuGLUnregisterBufferObject 201 . GLuint bufferObj).maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr.2.

asynchronous launches. While it is registered. DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. cuGLUnregisterBufferObject 202 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_ALREADY_MAPPED Note that this function may also return error codes from previous. This function must be called before CUDA can map the buffer object. cuGLUnmapBufferObject. cuGLInit. cuGLMapBufferObject. SEE ALSO cuGLCtxCreate.2.10.4 cuGLRegisterBufferObject NAME cuGLRegisterBufferObject .registers a GL buffer object SYNOPSIS CUresult cuGLRegisterBufferObject(GLuint bufferObj). the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1 and higher.2 and higher. BitwiseFunctions 222 . SEE ALSO ArithmeticFunctions. 64-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. NOTES 32-bit atomic operations are only supported on devices of compute capability 1.

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

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

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

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

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

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

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

unsigned int val).7 atomicDec NAME atomicDec . atomicInc. atomicExch.1. atomicCAS 230 . atomicMin. These three operations are performed in one atomic transaction. 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.1 and higher. atomicSub.atomic decrement SYNOPSIS unsigned int atomicDec(unsigned int* address. The function returns old. computes (((old == 0) .3. DESCRIPTION Reads the 32-bit word old located at the address address in global memory.

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful