NVIDIA CUDA Compute Unified Device Architecture

Reference Manual

Version 2.0
June 2008

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

cudaGetDeviceCount

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

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

1.3

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

1.4

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

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

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

1.5

MemoryManagement RT 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9

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

cudaMallocArray

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

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

i

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

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

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

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

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

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

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

1.7

ExecutionControl RT 1.7.1 1.7.2 1.7.3

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

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

1.8

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

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

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

1.9

Direct3dInteroperability RT 1.9.1 1.9.2 1.9.3 1.9.4 cudaD3D9GetDevice

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

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

1.9.5 1.9.6 1.9.7 1.9.8 1.9.9

cudaD3D9UnregisterResource cudaD3D9MapResources

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

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

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

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

1.9.10 cudaD3D9ResourceGetMappedPointer 1.9.11 cudaD3D9ResourceGetMappedSize

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

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

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

DeviceManagement 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7

cuDeviceComputeCapability

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

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

2.3

ContextManagement 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8

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

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

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

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

2.4

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

iii

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

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

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

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

These wrappers can be used from C++ code and can be compiled with any C++ compiler. The high-level API (cuda_runtime. Texture Reference Management.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. Execution Management. Thread Management. using overloading. references and default arguments. It wraps some of the low level API routines. and device functions.h) is a C-style interface that does not require compiling with nvcc. Direct3D Interoperability.h) is a C++-style interface built on top of the low-level API. Memory Management. SEE ALSO Device Management. These wrappers require the use of nvcc because they depend on code being generated by the compiler. Stream Management. textures. The low-level API (cuda_runtime_api. the execution configuration syntax to invoke kernels is only available in source code compiled with nvcc. OpenGL Interoperability. Event Management. Error Handling 1 . For example.

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

cudaChooseDevice 3 . cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. Since this device will be able to emulate all hardware features. cudaGetDeviceProperties.1.1.returns the number of compute-capable devices SYNOPSIS cudaError_t cudaGetDeviceCount( int* count ) DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. cudaSetDevice.0 that are available for execution. asynchronous launches.1 cudaGetDeviceCount NAME cudaGetDeviceCount . SEE ALSO cudaGetDevice. this device will report major and minor compute capability versions of 9999. If there is no such device.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

a height in rows. }. 50 . cudaError_t cudaMemset3D( struct cudaPitchedPtr dstPitchPtr. size_t ysize. extents with height equal to the ysize of dstPitchPtr will perform faster than when the hieght is shorter than the ysize. size_t xsize. asynchronous launches. Secondarily. size_t pitch. while the ysize field specifies the height of each 2D slice in rows. 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 struct cudaPitchedPtr { void *ptr.1. struct cudaExtent extent ) DESCRIPTION Initializes each element of a 3D array to the specified value value.5. The extents of the initialized region are specified as a width in bytes. }. and a depth in slices. size_t depth. int value. This function performs fastest when the dstPitchPtr has been allocated by cudaMalloc3D(). The object to initialize is defined by dstPitchPtr. Extents with width greater than or equal to the xsize of dstPitchPtr may perform significantly faster than extents narrower than the xsize.24 cudaMemset3D NAME cudaMemset3D . The pitch field of dstPitchPtr is the width in memory in bytes of the 3D array pointed to by dstPitchPtr. struct cudaExtent { size_t width. size_t height. The xsize field specifies the logical width of each row in bytes. including any padding added to the end of each row.

cudaMemset2D.SEE ALSO cudaMemset. cudaMalloc3D 51 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

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

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

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

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

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

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

SEE ALSO

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

79

1.9.2

cudaD3D9SetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

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

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

SEE ALSO

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

80

1.9.3

cudaD3D9GetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

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

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

SEE ALSO

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

81

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

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

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

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

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

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

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

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

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

cudaD3D9UnregisterResource. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. asynchronous launches.1. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. unsigned int Face. cudaD3D9MapResources. 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. If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. cudaD3D9ResourceGetMappedPitch 91 . cudaD3D9GetDirect3DDevice.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. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags.11 cudaD3D9ResourceGetMappedSize NAME cudaD3D9ResourceGetMappedSize . cudaD3D9SetDirect3DDevice. unsigned int Level). cudaD3D9UnmapResources. cudaD3D9RegisterResource. cudaD3D9ResourceGetMappedPointer. If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. SEE ALSO cudaD3D9GetDevice. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. IDirect3DResource9* pResource.9.

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

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

cuDeviceGetAttribute.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. cuDeviceGetCount. cuDeviceGetName. SEE ALSO cuDeviceComputeCapability. cuDeviceTotalMem 109 . cuDeviceGet.

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

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

cuCtxAttach() fails if there is no context current to the thread. cuCtxSynchronize 112 . DESCRIPTION Increments the usage count of the context and passes back a context handle in *pCtx that must be passed to cuCtxDetach() when the application is done with the context.1 cuCtxAttach NAME cuCtxAttach . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.3. cuCtxGetDevice. the Flags parameter must be 0.2. asynchronous launches.increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx. cuCtxDetach. SEE ALSO cuCtxCreate. unsigned int Flags). Currently.

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

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

2. cuCtxPopCurrent 115 . DESCRIPTION Destroys the given CUDA context. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuCtxCreate.3. this function fails. asynchronous launches. cuCtxPushCurrent. cuCtxAttach. 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.3 cuCtxDestroy NAME cuCtxDestroy . cuCtxDetach. or the context is current to any CPU thread other than the current one.destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx).

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

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

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

The previous current context may be made current again by calling cuCtxDestroy() or cuCtxPopCurrent().2. cuCtxDetach. DESCRIPTION Pushes the given context onto the CPU thread’s stack of current contexts. 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. not attached to any thread. so all CUDA functions that operate on the current context are affected.e. cuCtxPopCurrent 119 .3." i. SEE ALSO cuCtxCreate. The context must be "floating.attach floating context to CPU thread SYNOPSIS CUresult cuCtxPushCurrent(CUcontext ctx).7 cuCtxPushCurrent NAME cuCtxPushCurrent . The specified context becomes the CPU thread’s current context. cuCtxAttach. Contexts are made to float by calling cuCtxPopCurrent(). cuCtxDestroy. asynchronous launches.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int z).7. cuParamSeti.2. DESCRIPTION Specifies the X. cuLaunch.8 cuFuncSetBlockShape NAME cuFuncSetBlockShape . SEE ALSO cuFuncSetSharedSize. asynchronous launches. int y. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuParamSetSize. int x. cuParamSetf. cuParamSetTexRef. cuParamSetv.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. cuLaunchGrid 149 .

cuParamSetSize. cuParamSetf. asynchronous launches.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. cuParamSetTexRef.7.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . 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. 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. cuLaunch. unsigned int bytes).2. cuLaunchGrid 150 . SEE ALSO cuFuncSetBlockShape. cuParamSeti. cuParamSetv.

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

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

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

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

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

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

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

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

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

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

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

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

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

CUdeviceptr devPtr). cuMemFree.2. asynchronous launches.8.get information on memory allocations SYNOPSIS CUresult cuMemGetAddressRange(CUdeviceptr* basePtr. 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. unsigned int* size. cuArrayGetDescriptor. SEE ALSO cuMemGetInfo. cuArrayDestroy. If one of them is null. cuMemset2D 165 . Both parameters basePtr and size are optional. cuMemFreeHost. 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. cuArrayCreate. cuMemAllocPitch. cuMemAlloc.11 cuMemGetAddressRange NAME cuMemGetAddressRange . it is ignored.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuTexRefSetArray. cuTexRefGetFormat. cuTexRefDestroy. Currently the only valid values for dim are 0 and 1. cuTexRefSetFlags.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode . DESCRIPTION Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef. cuTexRefGetFlags 187 . SEE ALSO cuTexRefCreate. cuTexRefSetAddressMode. cuTexRefSetFilterMode. cuTexRefSetAddress.9. cuTexRefGetAddress. cuTexRefSetFormat. CUtexref texRef. cuTexRefGetArray.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode. cuTexRefGetFilterMode.2. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. 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. cuTexRefGetFormat. cuTexRefSetArray.5 cuTexRefGetArray NAME cuTexRefGetArray . CUtexref texRef). asynchronous launches. cuTexRefGetFilterMode. cuTexRefGetAddressMode. cuTexRefSetFormat. cuTexRefSetFilterMode. cuTexRefSetAddress. cuTexRefSetAddressMode. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. cuTexRefGetFlags 188 . cuTexRefDestroy. SEE ALSO cuTexRefCreate. cuTexRefGetAddress.gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array.9.2. cuTexRefSetFlags.

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

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

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

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

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

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

cuTexRefSetFlags. cuTexRefGetArray. CU_TR_FILTER_MODE_LINEAR = 1 } CUfilter_mode.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. cuTexRefSetAddressMode. DESCRIPTION Specifies the filtering mode mode to be used when reading memory through the texture reference texRef. cuTexRefSetFormat. cuTexRefSetAddress. Note that this call has no effect if texRef is bound to linear memory.12 cuTexRefSetFilterMode NAME cuTexRefSetFilterMode . asynchronous launches. SEE ALSO cuTexRefCreate. cuTexRefGetAddress. cuTexRefGetFlags 195 . CUfilter_mode_enum is defined as such: typedef enum CUfilter_mode_enum { CU_TR_FILTER_MODE_POINT = 0. cuTexRefSetArray. CUfilter_mode mode). cuTexRefGetAddressMode. cuTexRefDestroy. cuTexRefGetFormat.sets the mode for a texture-reference SYNOPSIS CUresult cuTexRefSetFilterMode(CUtexref texRef.2. cuTexRefGetFilterMode.

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

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

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

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

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

asynchronous launches. SEE ALSO cuGLCtxCreate.2. GLuint bufferObj). 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. cuGLUnmapBufferObject. cuGLInit. unsigned int* size. cuGLRegisterBufferObject. 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.3 cuGLMapBufferObject NAME cuGLMapBufferObject .10.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr. cuGLUnregisterBufferObject 201 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

atomicDec 231 .or 64-bit word old located at the address address in global memory. unsigned int val). computes (old == compare ? val : old).1 and higher.1. unsigned long long int val). 64-bit atomic operations are only supported on devices of compute capability 1. int compare. atomicMax. atomicExch.2 and higher. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. unsigned int compare. unsigned long long int compare.3. 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 (Compare And Swap).8 atomicCAS NAME atomicCAS . atomicSub. unsigned int atomicCAS(unsigned int* address. atomicInc. atomicMin. int val). unsigned long long int atomicCAS(unsigned long long int* address.atomic compare-and-swap SYNOPSIS int atomicCAS(int* address. SEE ALSO atomicAdd. DESCRIPTION Reads the 32.

3.2

BitwiseFunctions

NAME
Bitwise Functions

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

SEE ALSO
ArithmeticFunctions

232

3.2.1

atomicAnd

NAME
atomicAnd - atomic bitwise-and

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

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

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

SEE ALSO
atomicOr, atomicXor

233

3.2.2

atomicOr

NAME
atomicOr - atomic bitwise-or

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

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

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

SEE ALSO
atomicAnd, atomicXor

234

3.2.3

atomicXor

NAME
atomicXor - atomic bitwise-xor

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

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

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

SEE ALSO
atomicAnd, atomicOr

235

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

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

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

Sign up to vote on this title
UsefulNot useful