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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMemcpyArrayToArray. or it can be a character string.5. asynchronous launches. size_t offset. cudaMemcpyFromArray. cudaMemcpy2D. const T& symbol. symbol can either be a variable that resides in global or constant memory space. cudaMemcpy2DFromArray. 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 cudaMemcpyDeviceToHost or cudaMemcpyDeviceToDevice. 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. The memory areas may not overlap. SEE ALSO cudaMemcpy. cudaMemcpyToArray. size_t count.1. cudaMemcpy2DArrayToArray. cudaMemcpyToSymbol 43 .19 cudaMemcpyFromSymbol NAME cudaMemcpyFromSymbol . cudaMemcpy2DToArray.copies data from GPU to host memory SYNOPSIS template < class T > cudaError_t cudaMemcpyFromSymbol( void *dst. naming a variable that resides in global or constant memory space.

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

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMemset2D. cudaMalloc3D 51 .

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

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

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

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

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

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

asynchronous launches. desc describes how the memory is interpreted when fetching values from the texture. const void* devPtr. const struct cudaChannelFormatDesc* desc. size_t size = UINT_MAX). cudaBindTextureToArray. Any memory previously bound to texRef is unbound. cudaGetChannelDesc.Low-level texture API SYNOPSIS cudaError_t cudaBindTexture(size_t* offset. SEE ALSO cudaCreateChannelDesc. cudaGetTextureAlignmentOffset 59 .cudaBindTexture NAME cudaBindTexture . const struct textureReference* texRef. If the device memory pointer was returned from cudaMalloc(). 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. 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. cudaGetTextureReference. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. the offset is guaranteed to be 0 and NULL may be passed as the offset parameter. cudaUnbindTexture.

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

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

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

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

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

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

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

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

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

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

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 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration Note that this function may also return error codes from previous. asynchronous launches. naming a function that executes on the device. SEE ALSO cudaConfigureCall. cudaLaunch() must be preceded by a call to cudaConfigureCall() since it pops the data that was pushed by cudaConfigureCall() from the execution stack. cudaSetupArgument 70 . entry can either be a function that executes on the device. entry must be declared as a __global__ function.1.7. or it can be a character string.

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

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

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

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

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

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

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

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

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

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

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

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

1. cudaD3D9UnregisterResource.9. cudaD3D9GetDirect3DDevice. cudaD3D9RegisterResource. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9ResourceGetMappedPitch 86 . cudaD3D9MapResources.7 cudaD3D9UnmapResources NAME cudaD3D9UnmapResources . If any of ppResources are not presently mapped for access by CUDA then cudaErrorUnknown 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. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned. cudaD3D9ResourceGetMappedSize. asynchronous launches. SEE ALSO cudaD3D9GetDevice. DESCRIPTION Unmaps the count Direct3D resources in ppResources. IDirect3DResource9** ppResources).unmap Direct3D resources SYNOPSIS cudaError_t cudaD3D9UnmapResources(unsigned int count. cudaD3D9ResourceSetMa cudaD3D9ResourceGetMappedPointer.

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

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

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

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

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

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

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

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

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

cudaError 96 .SEE ALSO cudaGetErrorString.

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

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

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

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

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

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

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

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

cuDeviceGet. cuDeviceTotalMem 105 . cuDeviceGetName. 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. SEE ALSO cuDeviceComputeCapability. asynchronous launches. cuDeviceGetProperties.

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

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

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

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

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

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

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

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

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

cuCtxDetach. cuCtxPopCurrent 115 . cuCtxPushCurrent.3 cuCtxDestroy NAME cuCtxDestroy . this function fails. Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function.3. 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. cuCtxAttach.destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). or the context is current to any CPU thread other than the current one. SEE ALSO cuCtxCreate. If the context usage count is not equal to 1.2. DESCRIPTION Destroys the given CUDA context.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

6. cuEventRecord. cuEventDestroy.6 cuEventSynchronize NAME cuEventSynchronize . DESCRIPTION Blocks until the event has actually been recorded.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. SEE ALSO cuEventCreate. the function returns CUDA_ERROR_INVALID_VALUE.2. cuEventElapsedTime 140 . cuEventQuery. asynchronous launches. If cuEventRecord() has not been called on this event.

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

cuParamSetf. cuParamSetTexRef.1 cuLaunch NAME cuLaunch . DESCRIPTION Invokes the kernel func on a 1ÃŮ1 grid of blocks.launches a CUDA function SYNOPSIS CUresult cuLaunch(CUfunction func). cuParamSeti. cuLaunchGrid 142 . cuFuncSetSharedSize. SEE ALSO cuFuncSetBlockShape.7.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_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(). cuParamSetSize. asynchronous launches. cuParamSetv.

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

cuFuncSetSharedSize. cuParamSeti. asynchronous launches. SEE ALSO cuFuncSetBlockShape. cuParamSetTexRef. cuParamSetf.2. cuLaunchGrid 144 .3 cuParamSetSize NAME cuParamSetSize . unsigned int numbytes). cuParamSetv. DESCRIPTION Sets through numbytes the total size in bytes needed by the function parameters of function func.sets the parameter-size for the function SYNOPSIS CUresult cuParamSetSize(CUfunction func. cuLaunch. 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.

2.7. int texunit. SEE ALSO cuFuncSetBlockShape. cuFuncSetSharedSize. cuLaunch. cuParamSeti. cuParamSetv. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(CUfunction func. cuParamSetSize. CUtexref texRef). In this version of CUDA. cuLaunchGrid 145 . asynchronous launches. cuParamSetf. the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT. 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 .

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

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

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

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

cuParamSetv. cuParamSetf. unsigned int bytes). cuLaunchGrid 150 . DESCRIPTION Sets through bytes the amount of shared memory that will be available to each thread block when the kernel given by func is launched. SEE ALSO cuFuncSetBlockShape. cuLaunch. cuParamSetTexRef.7.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . cuParamSeti. 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. asynchronous launches.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. cuParamSetSize.2.

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

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

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

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

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

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

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

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

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

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

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

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

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

cuArrayGetDescriptor.8. cuMemset2D 164 . 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.frees page-locked host memory SYNOPSIS CUresult cuMemFreeHost(void* hostPtr). cuMemAllocHost. which must have been returned by a previous call to cuMemAllocHost(). cuMemAllocPitch. cuArrayDestroy.2. asynchronous launches. cuMemset. SEE ALSO cuMemGetInfo.10 cuMemFreeHost NAME cuMemFreeHost . cuArrayCreate. cuMemGetAddressRange. cuMemFree. DESCRIPTION Frees the memory space pointed to by hostPtr. cuMemAlloc.

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

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

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

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

cuMemcpyAtoH. cuMemcpy3D 169 . cuMemcpyDtoD. cuMemcpyDtoA. cuMemcpyAtoD. cuMemcpyDtoH.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 cuMemcpyHtoD. asynchronous launches. cuMemcpyHtoA. cuMemcpyAtoA.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TextureReferenceManagement. cuD3D9Begin cuD3D9End cuD3D9MapVertexBuffer cuD3D9RegisterVertexBuffer cuD3D9UnmapVertexBuffer cuD3D9UnregisterVertexBuffer SEE ALSO Initialization. ExecutionControl. Direct3dInteroperability 205 .0 the following functions are deprecated. ContextManagement. MemoryManagement. cuD3D9GetDevice cuD3D9CtxCreate cuD3D9GetDirect3DDevice cuD3D9RegisterResource cuD3D9UnregisterResource cuD3D9MapResources cuD3D9UnmapResources cuD3D9ResourceGetSurfaceDimensions cuD3D9ResourceSetMapFlags cuD3D9ResourceGetMappedPointer cuD3D9ResourceGetMappedSize cuD3D9ResourceGetMappedPitch As of CUDA 2.2. DeviceManagement. OpenGLInteroperability. EventManagement. StreamManagement. ModuleManagement.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.

2.1 cuD3D9GetDevice NAME cuD3D9GetDevice . asynchronous launches. cuD3D9MapResources. 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. cuD3D9ResourceSetMapFlags. cuD3D9UnregisterResource. cuD3D9GetDirect3DDevice. cuD3D9RegisterResource. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize.gets the device number for an adapter SYNOPSIS CUresult cuD3D9GetDevice(CUdevice* dev.11. SEE ALSO cuD3D9CtxCreate. cuD3D9ResourceGetMappedPitch 206 . cuD3D9ResourceGetSurfaceDimensions. const char* adapterName). cuD3D9UnmapResources. 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.

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

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

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

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

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

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

2.11.7

cuD3D9UnmapResources

NAME
cuD3D9UnmapResources - unmap Direct3D resources

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

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

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

SEE ALSO

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

213

2.11.8

cuD3D9ResourceSetMapFlags

NAME
cuD3D9ResourceSetMapFlags - set usage flags for mapping a Direct3D resource

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

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

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

214

SEE ALSO

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

215

2.11.9

cuD3D9ResourceGetSurfaceDimensions

NAME
cuD3D9ResourceGetSurfaceDimensions - get the dimensions of a registered surface

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

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

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

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

216

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

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

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

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

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

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

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

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

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

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

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

computes the maximum of old and val. SEE ALSO atomicAdd.3. unsigned int val).5 atomicMax NAME atomicMax .1 and higher. atomicCAS 228 . 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. unsigned int atomicMax(unsigned int* address. atomicSub.1. These three operations are performed in one atomic transaction. int val). and stores the result back to global memory at the same address. atomicExch. atomicInc.atomic maximum SYNOPSIS int atomicMax(int* address. The function returns old. atomicDec. atomicMin.

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful