CudaReferenceManual_2.0 | Integer (Computer Science) | Pointer (Computer Programming)

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

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

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

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

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

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

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

cudaChooseDevice 3 . cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode. Since this device will be able to emulate all hardware features.1. If there is no such device. asynchronous launches.1 cudaGetDeviceCount NAME cudaGetDeviceCount .0 that are available for execution.1. SEE ALSO cudaGetDevice. 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. cudaSetDevice.

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

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

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

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

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

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

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

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

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

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

SEE ALSO cudaStreamCreate. cudaStreamSynchronize 14 .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. cudaStreamDestroy. asynchronous launches.3. or cudaErrorNotReady if not.2 cudaStreamQuery NAME cudaStreamQuery .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMemset2D.SEE ALSO cudaMemset. cudaMalloc3D 51 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

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

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

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

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

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

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

SEE ALSO

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

79

1.9.2

cudaD3D9SetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

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

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

SEE ALSO

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

80

1.9.3

cudaD3D9GetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

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

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

SEE ALSO

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

81

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

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

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

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

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

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

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

the value returned in *pDepth will be 0.get the dimensions of a registered surface SYNOPSIS cudaError_t cudaD3D9ResourceGetSurfaceDimensions(size_t* pWidth. cudaD3D9ResourceGetMappedPitch 89 . unsigned int Face. If pResource is not of type IDirect3DBaseTexture9 or IDirect3DSurface9 or if pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. size_t *pDepth. cudaD3D9ResourceSetMapFlags. cudaD3D9ResourceGetMappedPointer. pHeight. SEE ALSO cudaD3D9GetDevice. The parameters pWidth.9.9 cudaD3D9ResourceGetSurfaceDimensions NAME cudaD3D9ResourceGetSurfaceDimensions . cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedSize. cudaD3D9RegisterResource. cudaD3D9UnmapResources. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle Note that this function may also return error codes from previous.1. For 2D surfaces. *pHeight. cudaD3D9MapResources. cudaD3D9GetDirect3DDevice. and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. and pDepth are optional. DESCRIPTION Returns in *pWidth. size_t* pHeight. asynchronous launches. cudaD3D9UnregisterResource. Because anti-aliased surfaces may have multiple samples per pixel it is possible that the dimensions of a resource will be an integer factor larger than the dimensions reported by the Direct3D runtime. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. unsigned int Level). IDirect3DResource9* pResource.

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

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

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

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

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

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

cudaError 96 .SEE ALSO cudaGetErrorString.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2. cuCtxDetach.3 cuCtxDestroy NAME cuCtxDestroy .3.destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). If the context usage count is not equal to 1. Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuCtxCreate. asynchronous launches. cuCtxAttach. cuCtxPushCurrent. this function fails. DESCRIPTION Destroys the given CUDA context. or the context is current to any CPU thread other than the current one. cuCtxPopCurrent 115 .

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

SEE ALSO cuCtxCreate. 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. cuCtxSynchronize 117 .return device-ID for current context SYNOPSIS CUresult cuCtxGetDevice(CUdevice* device). cuCtxDetach. DESCRIPTION Returns in *device the ordinal of the current context’s device. cuCtxAttach. asynchronous launches.5 cuCtxGetDevice NAME cuCtxGetDevice .2.

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

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

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

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

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

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

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

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

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

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

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

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

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

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

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

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

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

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

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

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

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

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

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

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

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

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

127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc. asynchronous launches. cuArray3DGetDescriptor. cuArrayDestroy 157 .8. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array. 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. but need to know the CUDA array parameters for validation or other purposes. It is useful for subroutines that have been passed a CUDA array.2. SEE ALSO cuArrayCreate. cuArray3DCreate.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

9. cuTexRefSetFormat. cuTexRefGetFlags 193 . SEE ALSO cuTexRefCreate. and so on. if dim is 1. cuTexRefGetArray. cuTexRefGetFilterMode.10 cuTexRefSetAddressMode NAME cuTexRefSetAddressMode . DESCRIPTION Specifies the addressing mode mode for the given dimension of the texture reference texRef. Note that this call has no effect if texRef is bound to linear memory. cuTexRefSetArray. cuTexRefSetFlags. CUaddress_mode mode). cuTexRefSetFilterMode. CU_TR_ADDRESS_MODE_MIRROR = 2.set the addressing mode for a texture-reference SYNOPSIS CUresult cuTexRefSetAddressMode(CUtexref texRef. cuTexRefGetFormat. If dim is zero. CU_TR_ADDRESS_MODE_CLAMP = 1. the second. } CUaddress_mode. cuTexRefDestroy. cuTexRefGetAddressMode.2. the addressing mode is applied to the first parameter of the functions used to fetch from the texture. CUaddress_mode is defined as such: typedef enum CUaddress_mode_enum { CU_TR_ADDRESS_MODE_WRAP = 0. int dim. cuTexRefSetAddress. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetAddress. 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. cuTexRefGetArray. SEE ALSO cuTexRefCreate. cuTexRefGetFilterMode. cuTexRefSetFormat. cuTexRefSetAddress. Any previous address or CUDA array state associated with the texture reference is superseded by this function. cuTexRefSetFilterMode. cuTexRefGetAddressMode. Any CUDA array previously bound to texRef is unbound. cuTexRefDestroy. cuTexRefGetAddress. unsigned int flags). CUarray array. asynchronous launches.11 cuTexRefSetArray NAME cuTexRefSetArray . cuTexRefSetFlags. flags must be set to CU_TRSA_OVERRIDE_FORMAT.9. cuTexRefGetFlags 194 .binds an array to a texture-reference SYNOPSIS CUresult cuTexRefSetArray(CUtexref texRef.2. cuTexRefSetAddressMode. cuTexRefGetFormat. DESCRIPTION Binds the CUDA array array to the texture reference texRef.

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

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

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

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

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

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

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

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

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

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

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

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

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

2. DESCRIPTION Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cuD3D9CtxCreate. cuD3D9MapResources. cuD3D9RegisterResource.3 cuD3D9GetDirect3DDevice NAME cuD3D9GetDirect3DDevice . cuD3D9CtxCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. cuD3D9UnmapResources. cuD3D9ResourceSetMapFlags. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9ResourceGetMappedPitch 208 . asynchronous launches. cuD3D9UnregisterResource.get the Direct3D device against which the current CUDA context was created SYNOPSIS CUresult cuD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice). cuD3D9ResourceGetSurfaceDimensions.11.

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

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

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

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

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

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. asynchronous launches. The value set in pDevPtr may change every time that pResource is mapped. unsigned int Face. 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.11.10 cuD3D9ResourceGetMappedPointer NAME cuD3D9ResourceGetMappedPointer . IDirect3DResource9* pResource. unsigned int Level). 217 . DESCRIPTION Returns in *pDevPtr the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. If Level is invalid then CUDA_ERROR_INVALID_VALUE is returned. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVA is returned. If Face is invalid then CUDA_ERROR_INVALID_V is returned.2. If pResource is not mapped then CUDA_ERROR_NOT_MAPPED is returned. At present only mipmap level 0 is supported. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. For all other types Face must be 0. 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. For all other types Level must be 0.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3.2

BitwiseFunctions

NAME
Bitwise Functions

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

SEE ALSO
ArithmeticFunctions

232

3.2.1

atomicAnd

NAME
atomicAnd - atomic bitwise-and

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

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

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

SEE ALSO
atomicOr, atomicXor

233

3.2.2

atomicOr

NAME
atomicOr - atomic bitwise-or

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

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

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

SEE ALSO
atomicAnd, atomicXor

234

3.2.3

atomicXor

NAME
atomicXor - atomic bitwise-xor

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

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

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

SEE ALSO
atomicAnd, atomicOr

235

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

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

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

Sign up to vote on this title
UsefulNot useful