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

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

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

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

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

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

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

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

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

1. cudaSetDevice. asynchronous launches.returns which device is currently being used SYNOPSIS cudaError_t cudaGetDevice( int* dev ) DESCRIPTION Returns in *dev the device on which the active host thread executes the device code. cudaChooseDevice 5 .3 cudaGetDevice NAME cudaGetDevice . RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. SEE ALSO cudaGetDeviceCount.1. cudaGetDeviceProperties.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMallocHost. cudaMallocPitch. cudaFree. asynchronous launches.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError Note that this function may also return error codes from previous. SEE ALSO cudaMalloc. cudaMallocArray.5 cudaFreeArray NAME cudaFreeArray .frees an array on the GPU SYNOPSIS cudaError_t cudaFreeArray( struct cudaArray* array ) DESCRIPTION Frees the CUDA array array. no operation is performed. cudaFreeHost 29 . If array is 0.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. cudaFree. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cudaMemcpy*(). As a result.6 cudaMallocHost NAME cudaMallocHost .allocates page-locked memory on the host SYNOPSIS cudaError_t cudaMallocHost( void** hostPtr. SEE ALSO cudaMalloc. cudaMallocArray. size_t size ) DESCRIPTION Allocates size bytes of host memory that is page-locked and accessible to the device.5. since it reduces the amount of memory available to the system for paging. asynchronous launches. Allocating excessive amounts of memory with cudaMallocHost() may degrade system performance. cudaMallocPitch.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaFreeHost 30 . cudaFreeArray. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc().

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

8 cudaMemset NAME cudaMemset .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. size_t count ) DESCRIPTION Fills the first count bytes of the memory area pointed to by devPtr with the constant byte value value. SEE ALSO cudaMemset2D. cudaMemset3D 32 .5. asynchronous launches.1. int value.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 .SEE ALSO cudaMemset. cudaMemset2D.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

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

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

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

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

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

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

SEE ALSO

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

79

1.9.2

cudaD3D9SetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

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

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

SEE ALSO

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

80

1.9.3

cudaD3D9GetDirect3DDevice

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

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

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

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

SEE ALSO

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

81

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

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

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

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

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

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

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

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

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

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

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

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

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

returns the last error from a run-time call SYNOPSIS cudaError_t cudaGetLastError( void ) DESCRIPTION Returns the last error that was returned from any of the runtime calls in the same host thread and resets it to cudaSuccess. 95 .1.10.1 cudaGetLastError NAME cudaGetLastError . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.

cudaError 96 .SEE ALSO cudaGetErrorString.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

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

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

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

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

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

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

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

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

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

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

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

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

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

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

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

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

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

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

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

127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cuLaunchGrid 150 . cuParamSetSize. cuParamSeti. cuLaunch. asynchronous launches.7. cuParamSetTexRef. SEE ALSO cuFuncSetBlockShape.2. cuParamSetf. cuParamSetv. unsigned int bytes). 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.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. 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.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize .

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

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

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

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

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

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

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

DESCRIPTION Returns in *arrayDesc a descriptor containing information on the format and dimensions of the CUDA array array.get a 3D CUDA array descriptor SYNOPSIS CUresult cuArray3DGetDescriptor(CUDA_ARRAY3D_DESC *arrayDesc. 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. cuArrayGetDescriptor.5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor . 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.8. CUarray array). SEE ALSO cuArrayCreate.2. cuArrayDestroy 158 . cuArray3DCreate. asynchronous launches.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9MapResources.11. cuD3D9RegisterResource. cuD3D9ResourceGetSurfaceDimensions. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. unsigned int Level). IDirect3DResource9* pResource. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetMappedPitch 219 .11 cuD3D9ResourceGetMappedSize NAME cuD3D9ResourceGetMappedSize . asynchronous launches. cuD3D9GetDirect3DDevice. cuD3D9UnregisterResource. unsigned int Face. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. The value set in pSize may change every time that pResource is mapped. cuD3D9UnmapResources. cuD3D9CtxCreate.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedSize(unsigned int* pSize. cuD3D9ResourceGetMappedPointer. cuD3D9ResourceSetMapFlags. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer.2. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. DESCRIPTION Returns in *pSize the size 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 CUresult cuD3D9ResourceGetMappedPitch(unsigned int* pPitch. IDirect3DResource pResource.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL. 220 . The values set in pPitch and pPitchSlice may change every time that pResource is mapped. asynchronous launches. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. RETURN VALUE Relevant return values: 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. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. unsigned int Face. unsigned int Level). 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 CUDA_ERROR_INVALID_HANDLE is returned.2.12 cuD3D9ResourceGetMappedPitch NAME cuD3D9ResourceGetMappedPitch .11. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x.y. unsigned int* pPitchSlice. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful