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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaThreadExit 10 .1.1 cudaThreadSynchronize NAME cudaThreadSynchronize .wait for compute-device to finish SYNOPSIS cudaError_t cudaThreadSynchronize(void) DESCRIPTION Blocks until the device has completed all preceding requested tasks. asynchronous launches. 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.2.

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

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

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

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

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

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

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

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

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

1.query if an event has been recorded SYNOPSIS cudaError_t cudaEventQuery( cudaEvent_t event ) DESCRIPTION Returns cudaSuccess if the event has actually been recorded. cudaEventDestroy. cudaEventSynchronize.3 cudaEventQuery NAME cudaEventQuery . SEE ALSO cudaEventCreate. If cudaEventRecord() has not been called on this event. 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. cudaEventElapsedTime 20 . cudaEventRecord. the function returns cudaErrorInvalidValue. asynchronous launches.4.

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

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

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

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

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

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

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

where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. const struct cudaChannelFormatDesc* desc.5. w.4 cudaMallocArray NAME cudaMallocArray . The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. SEE ALSO cudaMalloc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaFreeHost 28 . cudaMallocPitch. cudaFreeArray. asynchronous launches. size_t height ) DESCRIPTION Allocates a CUDA array according to the cudaChannelFormatDesc structure desc and returns a handle to the new CUDA array in *array. cudaChannelFormatKindUnsigned. enum cudaChannelFormatKind f.allocate an array on the GPU SYNOPSIS cudaError_t cudaMallocArray( struct cudaArray** array. size_t width. z. cudaChannelFormatKindFloat. cudaMallocHost.1. cudaFree. }. y.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaMemset. cudaMemset2D. cudaMalloc3D 51 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaD3D9SetDirect3DDevice.map Direct3D resources for access by CUDA SYNOPSIS cudaError_t cudaD3D9MapResources(unsigned int count. cudaD3D9RegisterResource.9. Direct3D should not access any resources while they are mapped by CUDA. cudaD3D9GetDirect3DDevice. cudaD3D9UnmapResources. cudaD3D9ResourceSetMapFlags. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. cudaD3D9ResourceGetMappedSize. This function provides the synchronization guarantee that any Direct3D calls issued before cudaD3D9MapResources will complete before any CUDA kernels issued after cudaD3D9MapResources begin.6 cudaD3D9MapResources NAME cudaD3D9MapResources . cudaD3D9ResourceGetMappedPitch 85 . 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. asynchronous launches. SEE ALSO cudaD3D9GetDevice.1. cudaD3D9ResourceGetMappedPointer. The resources in ppResources may be accessed in CUDA kernels until they are unmapped. IDirect3DResource9 **ppResources). cudaD3D9UnregisterResource. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned. cudaD3D9ResourceGetSurfaceDimensions. If an application does so the results are undefined.

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuCtxAttach.8 cuCtxSynchronize NAME cuCtxSynchronize .2. SEE ALSO cuCtxCreate. cuCtxGetDevice 120 .3. DESCRIPTION Blocks until the device has completed all preceding requested tasks. cuCtxDetach.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. asynchronous launches. cuCtxSynchronize() returns an error if one of the preceding tasks failed.

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

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

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

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

SYNOPSIS
CUresult cuModuleGetTexRef(CUtexref* texRef, CUmodule hmod, const char* texrefname);

DESCRIPTION
Returns in *texref the handle of the texture reference of name texrefname in the module mod. If no texture reference of that name exists, cuModuleGetTexRef() returns CUDA_ERROR_NOT_FOUND. This texture reference handle should not be destroyed, since it will be destroyed when the module is unloaded.

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

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

SYNOPSIS
CUresult cuModuleLoad(CUmodule* mod, const char* filename);

DESCRIPTION
Takes a file name filename and loads the corresponding module mod into the current context. The CUDA driver API does not attempt to lazily allocate the resources needed by a module; if the memory for functions and data (constant and global) needed by the module cannot be allocated, cuModuleLoad() fails. The file should be a cubin file as output by nvcc.

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

SEE ALSO
cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

SYNOPSIS
CUresult cuModuleLoadData(CUmodule* mod, const void* image);

DESCRIPTION
Takes a pointer image and loads the corresponding module mod into the current context. The pointer may be obtained by mapping a cubin file, passing a cubin file as a text string, or incorporating a cubin object into the executable resources and using operation system calls such as WindowsâĂŹ FindResource() to obtain the pointer.

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

SEE ALSO
cuModuleLoad, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

SYNOPSIS
CUresult cuModuleLoadFatBinary(CUmodule* mod, const void* fatBin);

DESCRIPTION
Takes a pointer fatBin and loads the corresponding module mod into the current context. The pointer represents a fat binary object, which is a collection of different cubin files, all representing the same device code but compiled and optimized for different architectures. There is currently no documented API for constructing and using fat binary objects by programmers, and therefore this function is an internal function in this version of CUDA. More information can be found in the nvcc document.

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

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

127

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

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

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

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

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

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

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

flags is required to be 0. At present.6.2. unsigned int flags). asynchronous launches. DESCRIPTION Creates an event.creates an event SYNOPSIS CUresult cuEventCreate(CUevent* event. cuEventDestroy. cuEventQuery. SEE ALSO cuEventRecord.1 cuEventCreate NAME cuEventCreate . cuEventElapsedTime 135 . cuEventSynchronize. 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_INVALID_HANDLE Note that this function may also return error codes from previous.2 cuEventDestroy NAME cuEventDestroy .6. asynchronous launches. cuEventRecord.destroys an event SYNOPSIS CUresult cuEventDestroy(CUevent event). DESCRIPTION Destroys the event.2. cuEventElapsedTime 136 . cuEventQuery. cuEventSynchronize. SEE ALSO cuEventCreate.

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

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

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

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

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

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

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

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

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

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

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

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

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

cuLaunchGrid 150 . cuParamSetv. cuParamSetSize. SEE ALSO 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).2.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize .sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func.7. cuLaunch. asynchronous launches. cuParamSetf. cuParamSeti. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuParamSetTexRef.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

asynchronous launches. cuGLRegisterBufferObject. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of the current CUDA context and returns in *devPtr and *size the base pointer and size of the resulting mapping. SEE ALSO cuGLCtxCreate. cuGLUnmapBufferObject.10. cuGLInit. GLuint bufferObj). cuGLUnregisterBufferObject 201 .3 cuGLMapBufferObject NAME cuGLMapBufferObject . 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.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr.2. unsigned int* size.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful