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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

size_t* pitch. 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. Due to pitch alignment restrictions in the hardware. cudaMallocHost. SEE ALSO cudaMalloc.5. The pitch returned in *pitch by cudaMallocPitch() is the width in bytes of the allocation. 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. cudaFreeHost 26 . used to compute addresses within the 2D array.2 cudaMallocPitch NAME cudaMallocPitch .1.allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr. 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. cudaFreeArray. cudaMallocArray. Given the row and column of an array element of type T. cudaFree. asynchronous launches. The intended usage of pitch is as a separate parameter of the allocation. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column. For allocations of 2D arrays. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch(). size_t widthInBytes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 . cudaMemset2D.SEE ALSO cudaMemset.

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

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

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

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

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

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

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

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

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

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

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

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

and w. }. y. 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. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. cudaChannelFormatKindUnsigned. y.cudaCreateChannelDesc HL NAME cudaCreateChannelDesc . SEE ALSO 64 . w. z. asynchronous launches.High-level texture API SYNOPSIS template < class T > struct cudaChannelFormatDesc cudaCreateChannelDesc <T >(). enum cudaChannelFormatKind f. DESCRIPTION Returns a channel descriptor with format f and number of bits of each component x. cudaChannelFormatKindFloat. z.

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

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

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

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

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

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

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

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

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

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

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

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

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

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

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

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

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

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

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

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

SEE ALSO

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

79

1.9.2

cudaD3D9SetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

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

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

SEE ALSO

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

80

1.9.3

cudaD3D9GetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

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

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

SEE ALSO

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

81

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

cuDeviceGetName. SEE ALSO cuDeviceGetAttribute. cuDeviceGet.2.2. asynchronous launches.returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major. CUdevice dev). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. int* minor.1 cuDeviceComputeCapability NAME cuDeviceComputeCapability . cuDeviceGetProperties. cuDeviceGetCount. DESCRIPTION Returns in *major and *minor the major and minor revision numbers that define the compute capability of device dev. cuDeviceTotalMem 102 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuCtxDetach. cuCtxAttach. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent().2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. cuCtxPushCurrent 118 . cuCtxPopCurrent() passes back the context handle in *pctx. this function makes that context current to the CPU thread again. asynchronous launches.6 cuCtxPopCurrent NAME cuCtxPopCurrent . Floating contexts may be destroyed by calling cuCtxDestroy().3. DESCRIPTION Pops the current CUDA context from the CPU thread. cuCtxDestroy. SEE ALSO cuCtxCreate.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(). 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. CUDA contexts have a usage count of 1 upon creation. If successful.

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

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

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

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

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

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

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

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

5. unsigned int flags).2.create a stream SYNOPSIS CUresult cuStreamCreate(CUstream* stream. DESCRIPTION Creates a stream. cuStreamSynchronize. SEE ALSO cuStreamQuery. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous.1 cuStreamCreate NAME cuStreamCreate . cuStreamDestroy 130 . asynchronous launches. At present. 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.2 cuStreamDestroy NAME cuStreamDestroy .destroys a stream SYNOPSIS CUresult cuStreamDestroy(CUstream stream).5. DESCRIPTION Destroys the stream. cuStreamQuery. cuStreamSynchronize 131 . asynchronous launches. SEE ALSO cuStreamCreate.2.

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

4 cuStreamSynchronize NAME cuStreamSynchronize . cuStreamQuery. cuStreamDestroy 133 . asynchronous launches.5.block until a stream’s tasks are completed SYNOPSIS CUresult cuStreamSynchronize(CUstream stream). DESCRIPTION Blocks until the device has completed all operations in the 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.2. SEE ALSO cuStreamCreate.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuTexRefGetFilterMode. 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. cuTexRefGetFlags 197 .9. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef. CUarray_format format. cuTexRefSetAddress. cuTexRefSetFilterMode.2. cuTexRefGetAddress. asynchronous launches.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. cuTexRefDestroy. cuTexRefGetArray. cuTexRefGetAddressMode. cuTexRefSetAddressMode.14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefSetArray. SEE ALSO cuTexRefCreate. cuTexRefGetFormat. cuTexRefSetFlags.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.11.7

cuD3D9UnmapResources

NAME
cuD3D9UnmapResources - unmap Direct3D resources

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

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

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

SEE ALSO

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

213

2.11.8

cuD3D9ResourceSetMapFlags

NAME
cuD3D9ResourceSetMapFlags - set usage flags for mapping a Direct3D resource

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

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

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

214

SEE ALSO

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

215

2.11.9

cuD3D9ResourceGetSurfaceDimensions

NAME
cuD3D9ResourceGetSurfaceDimensions - get the dimensions of a registered surface

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

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

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

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

216

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3.2

BitwiseFunctions

NAME
Bitwise Functions

DESCRIPTION
This section describes the atomic bitwise functions. atomicAnd atomicOr atomicXor

SEE ALSO
ArithmeticFunctions

232

3.2.1

atomicAnd

NAME
atomicAnd - atomic bitwise-and

SYNOPSIS
int atomicAnd(int* address, int val); unsigned int atomicAnd(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old & val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicOr, atomicXor

233

3.2.2

atomicOr

NAME
atomicOr - atomic bitwise-or

SYNOPSIS
int atomicOr(int* address, int val); unsigned int atomicOr(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old , and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicXor

234

3.2.3

atomicXor

NAME
atomicXor - atomic bitwise-xor

SYNOPSIS
int atomicXor(int* address, int val); unsigned int atomicXor(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old ˆ val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicOr

235

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

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

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

Sign up to vote on this title
UsefulNot useful