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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMalloc3D 51 . cudaMemset2D.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

6 cuCtxPopCurrent NAME cuCtxPopCurrent . If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called. 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. cuCtxDetach. If successful. DESCRIPTION Pops the current CUDA context from the CPU thread. SEE ALSO cuCtxCreate. cuCtxPushCurrent 118 . Floating contexts may be destroyed by calling cuCtxDestroy().pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx).2. the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach().3. asynchronous launches. this function makes that context current to the CPU thread again. CUDA contexts have a usage count of 1 upon creation. cuCtxDestroy. cuCtxPopCurrent() passes back the context handle in *pctx. The CUDA context must have a usage count of 1. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent().

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. unsigned int count). cuMemFreeHost. cuMemAllocHost. cuMemAllocPitch.6 cuMemAlloc NAME cuMemAlloc . asynchronous launches. cuMemset. cuArrayCreate. cuMemGetAddressRange. cuMemset2D 159 . cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. cuArrayDestroy. cuArrayGetDescriptor.8.2. 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. SEE ALSO cuMemGetInfo. cuMemFree.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. The allocated memory is suitably aligned for any kind of variable. If count is 0.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuTexRefGetFlags 187 . cuTexRefGetAddress. cuTexRefSetFormat. int dim). Currently the only valid values for dim are 0 and 1. asynchronous launches. cuTexRefSetFilterMode.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode .2. cuTexRefGetFormat. CUtexref texRef. cuTexRefDestroy. SEE ALSO cuTexRefCreate. cuTexRefSetAddress. cuTexRefSetArray. 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. cuTexRefSetFlags. cuTexRefGetArray. cuTexRefSetAddressMode.9. DESCRIPTION Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuGLMapBufferObject.5 cuGLUnmapBufferObject NAME cuGLUnmapBufferObject . cuGLRegisterBufferObject. SEE ALSO cuGLCtxCreate.2.10. cuGLUnregisterBufferObject 203 . 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. cuGLInit. DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA.unmaps a GL buffer object SYNOPSIS CUresult cuGLUnmapBufferObject(GLuint bufferObj).

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

They should not be used in new development. StreamManagement. OpenGLInteroperability. cuD3D9GetDevice cuD3D9CtxCreate cuD3D9GetDirect3DDevice cuD3D9RegisterResource cuD3D9UnregisterResource cuD3D9MapResources cuD3D9UnmapResources cuD3D9ResourceGetSurfaceDimensions cuD3D9ResourceSetMapFlags cuD3D9ResourceGetMappedPointer cuD3D9ResourceGetMappedSize cuD3D9ResourceGetMappedPitch As of CUDA 2. MemoryManagement. cuD3D9Begin cuD3D9End cuD3D9MapVertexBuffer cuD3D9RegisterVertexBuffer cuD3D9UnmapVertexBuffer cuD3D9UnregisterVertexBuffer SEE ALSO Initialization. ContextManagement. TextureReferenceManagement.2. Direct3dInteroperability 205 . DeviceManagement.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. ModuleManagement. EventManagement. ExecutionControl.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful