hostdepend/X86MAC64/util/X86MAC64/cuda/man/man3/CUSTREAM.3

   1 func, \fBCUmodule\fP mod, const char * name)ret_dptr, unsigned int * ret_bytes, \fBCUmodule\fP mod, const char * name)ppTexRef, \fBCUmodule\fP mod, const char * name)phMod, const char * fname)phMod, const void * p)phMod, const void * p, unsigned int numOptions, \fBCUjit_option\fP * options, void ** optionValues)phMod, const void * vfatCubin)mod).TH "Stream Management" 3 "30 Mar 2009" "Version 2.2" "NVIDIA CUDA Library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Stream Management \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "\fBCUresult\fP \fBcuStreamCreate\fP (\fBCUstream\fP *phStream, unsigned int Flags)"
  11 .br
  12 .RI "\fICreate a stream. \fP"
  13 .ti -1c
  14 .RI "\fBCUresult\fP \fBcuStreamDestroy\fP (\fBCUstream\fP hStream)"
  15 .br
  16 .RI "\fIDestroys a stream. \fP"
  17 .ti -1c
  18 .RI "\fBCUresult\fP \fBcuStreamQuery\fP (\fBCUstream\fP hStream)"
  19 .br
  20 .RI "\fIDetermine status of a compute stream. \fP"
  21 .ti -1c
  22 .RI "\fBCUresult\fP \fBcuStreamSynchronize\fP (\fBCUstream\fP hStream)"
  23 .br
  24 .RI "\fIWait until a stream's tasks are completed. \fP"
  25 .in -1c
  26 .SH "Detailed Description"
  27 .PP
  28 This section describes the stream management functions of the low-level CUDA driver application programming interface.
  29 .SH "Function Documentation"
  30 .PP
  31 .SS "\fBCUresult\fP cuStreamCreate (\fBCUstream\fP * phStream, unsigned int Flags)"
  32 .PP
  33 Creates a stream and returns a handle in \fCphStream\fP. \fCFlags\fP is required to be 0.
  34 .PP
  35 \fBParameters:\fP
  36 .RS 4
  37 \fIphStream\fP - Returned newly created stream
  38 .br
  39 \fIFlags\fP - Parameters for stream creation (must be 0)
  40 .RE
  41 .PP
  42 \fBReturns:\fP
  43 .RS 4
  44 \fBCUDA_SUCCESS\fP, \fBCUDA_ERROR_DEINITIALIZED\fP, \fBCUDA_ERROR_NOT_INITIALIZED\fP, \fBCUDA_ERROR_INVALID_CONTEXT\fP, \fBCUDA_ERROR_INVALID_VALUE\fP, \fBCUDA_ERROR_OUT_OF_MEMORY\fP
  45 .RE
  46 .PP
  47 \fBNote:\fP
  48 .RS 4
  49 Note that this function may also return error codes from previous, asynchronous launches.
  50 .RE
  51 .PP
  52 \fBSee also:\fP
  53 .RS 4
  54 \fBcuStreamDestroy\fP, \fBcuStreamQuery\fP, \fBcuStreamSynchronize\fP
  55 .RE
  56 .PP
  57
  58 .SS "\fBCUresult\fP cuStreamDestroy (\fBCUstream\fP hStream)"
  59 .PP
  60 Destroys the stream specified by \fChStream\fP.
  61 .PP
  62 \fBParameters:\fP
  63 .RS 4
  64 \fIhStream\fP - Stream to destroy
  65 .RE
  66 .PP
  67 \fBReturns:\fP
  68 .RS 4
  69 \fBCUDA_SUCCESS\fP, \fBCUDA_ERROR_DEINITIALIZED\fP, \fBCUDA_ERROR_NOT_INITIALIZED\fP, \fBCUDA_ERROR_INVALID_CONTEXT\fP, \fBCUDA_ERROR_INVALID_VALUE\fP
  70 .RE
  71 .PP
  72 \fBNote:\fP
  73 .RS 4
  74 Note that this function may also return error codes from previous, asynchronous launches.
  75 .RE
  76 .PP
  77 \fBSee also:\fP
  78 .RS 4
  79 \fBcuStreamCreate\fP, \fBcuStreamQuery\fP, \fBcuStreamSynchronize\fP
  80 .RE
  81 .PP
  82
  83 .SS "\fBCUresult\fP cuStreamQuery (\fBCUstream\fP hStream)"
  84 .PP
  85 Returns \fBCUDA_SUCCESS\fP if all operations in the stream specified by \fChStream\fP have completed, or \fBCUDA_ERROR_NOT_READY\fP if not.
  86 .PP
  87 \fBParameters:\fP
  88 .RS 4
  89 \fIhStream\fP - Stream to query status of
  90 .RE
  91 .PP
  92 \fBReturns:\fP
  93 .RS 4
  94 \fBCUDA_SUCCESS\fP, \fBCUDA_ERROR_DEINITIALIZED\fP, \fBCUDA_ERROR_NOT_INITIALIZED\fP, \fBCUDA_ERROR_INVALID_CONTEXT\fP, \fBCUDA_ERROR_INVALID_HANDLE\fP, \fBCUDA_ERROR_NOT_READY\fP
  95 .RE
  96 .PP
  97 \fBNote:\fP
  98 .RS 4
  99 Note that this function may also return error codes from previous, asynchronous launches.
 100 .RE
 101 .PP
 102 \fBSee also:\fP
 103 .RS 4
 104 \fBcuStreamCreate\fP, \fBcuStreamDestroy\fP, \fBcuStreamSynchronize\fP
 105 .RE
 106 .PP
 107
 108 .SS "\fBCUresult\fP cuStreamSynchronize (\fBCUstream\fP hStream)"
 109 .PP
 110 Waits until the device has completed all operations in the stream specified by \fChStream\fP.
 111 .PP
 112 \fBParameters:\fP
 113 .RS 4
 114 \fIhStream\fP - Stream to wait for
 115 .RE
 116 .PP
 117 \fBReturns:\fP
 118 .RS 4
 119 \fBCUDA_SUCCESS\fP, \fBCUDA_ERROR_DEINITIALIZED\fP, \fBCUDA_ERROR_NOT_INITIALIZED\fP, \fBCUDA_ERROR_INVALID_CONTEXT\fP, \fBCUDA_ERROR_INVALID_HANDLE\fP
 120 .RE
 121 .PP
 122 \fBNote:\fP
 123 .RS 4
 124 Note that this function may also return error codes from previous, asynchronous launches.
 125 .RE
 126 .PP
 127 \fBSee also:\fP
 128 .RS 4
 129 \fBcuStreamCreate\fP, \fBcuStreamDestroy\fP, \fBcuStreamQuery\fP
 130 .RE
 131 .PP
 132
 133 .SH "Author"
 134 .PP
 135 Generated automatically by Doxygen for NVIDIA CUDA Library from the source code.