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

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

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

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

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

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

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

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

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

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

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

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

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. asynchronous launches.5 cudaChooseDevice NAME cudaChooseDevice . const struct cudaDeviceProp* prop ) DESCRIPTION Returns in *dev the device which properties best match *prop.1. cudaSetDevice. cudaGetDeviceProperties 8 . SEE ALSO cudaGetDeviceCount. cudaGetDevice.1.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Stream Management. Thread Management. Execution Management.1. 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. Direct3D Interoperability. OpenGL Interoperability. Memory Management. Texture Reference Management. Event Management.5 MemoryManagement RT NAME Memory Management DESCRIPTION This section describes the CUDA runtime application programming interface. Error Handling 24 .

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

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

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

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

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

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

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

8 cudaMemset NAME cudaMemset . int value.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous. 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. asynchronous launches.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset( void* devPtr.5. cudaMemset3D 32 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 .SEE ALSO cudaMemset. cudaMemset2D.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuModuleLoadData.2. cuModuleGetTexRef 122 . const char* funcname). cuModuleGetGlobal. CUmodule mod. cuModuleUnload. cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND.4.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous.1 cuModuleGetFunction NAME cuModuleGetFunction . DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod. If no function of that name exists. SEE ALSO cuModuleLoad. cuModuleLoadFatBinary. 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_NOT_FOUND Note that this function may also return error codes from previous. Both parameters devPtr and bytes are optional.2. cuModuleUnload.2 cuModuleGetGlobal NAME cuModuleGetGlobal . CUmodule mod. unsigned int* bytes. cuModuleGetFunction. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND. DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod. cuModuleLoadData. cuModuleGetTexRef 123 . If one of them is null. If no variable of that name exists. const char* globalname). SEE ALSO cuModuleLoad.4. cuModuleLoadFatBinary. asynchronous launches. it is ignored.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr.

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

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

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

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

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

cuStreamDestroy 132 .5. or CUDA_ERROR_NOT_READY if not.determine status of a compute stream SYNOPSIS CUresult cuStreamQuery(CUstream stream). 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 CUDA_ERROR_NOT_READY Note that this function may also return error codes from previous. asynchronous launches. DESCRIPTION Returns CUDA_SUCCESS if all operations in the stream have completed. cuStreamSynchronize.3 cuStreamQuery NAME cuStreamQuery .2.

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

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

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

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

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

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

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

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

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

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

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

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

In this version of CUDA. CUtexref texRef).adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(CUfunction func. cuLaunch.4 cuParamSetTexRef NAME cuParamSetTexRef . 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. cuParamSetv. cuLaunchGrid 145 .2. cuParamSetSize. cuParamSetf. DESCRIPTION Makes the CUDA array or linear memory bound to the texture reference texRef available to a device program as a texture. cuFuncSetSharedSize. cuParamSeti. int texunit. SEE ALSO cuFuncSetBlockShape.7. the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

copies memory from Host to Array SYNOPSIS CUresult cuMemcpyHtoA(CUarray dstArray. const void *srcHostPtr. cuMemcpyAtoA. srcHostPtr specify the base addresse of the source. SEE ALSO cuMemcpyHtoD. 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.8.21 cuMemcpyHtoA NAME cuMemcpyHtoA . CUstream stream). count specifies the number of bytes to copy. cuMemcpyAtoH. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. cuMemcpyAtoD. CUresult cuMemcpyHtoAAsync(CUarray dstArray. unsigned int dstIndex. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. cuMemcpyDtoD. cuMemcpyDtoA. cuMemcpy2D 179 . cuMemcpyDtoH. const void *srcHostPtr. unsigned int count. DESCRIPTION Copies from host memory to a 1D CUDA array. unsigned int count). cuMemcpyHtoAAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument.2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful