@@ -39,16 +39,16 @@ params:
3939 desc : " [in] Handle of the context object."
4040 - type : $x_exp_graph_handle_t*
4141 name : phGraph
42- desc : " [out] Pointer to the handle of the created graph object."
42+ desc : " [out][alloc] Pointer to the handle of the created graph object."
4343 - type : void*
4444 name : pNext
45- desc : " [out] pointer to extension-specific structure."
45+ desc : " [out] Pointer to extension-specific structure."
4646returns :
4747 - $X_RESULT_SUCCESS
4848 - $X_RESULT_ERROR_INVALID_ARGUMENT
4949--- # ------------------------------------------k--------------------------------
5050type : function
51- desc : " Begin graph capture on the specified immediate command list ."
51+ desc : " Begin graph capture on the specified immediate queue ."
5252class : $xQueue
5353name : BeginGraphCaptureExp
5454params :
@@ -57,13 +57,13 @@ params:
5757 desc : " [in] Handle of the queue on which to begin graph capture."
5858 - type : void*
5959 name : pNext
60- desc : " [in][optional] pointer to extension-specific structure."
60+ desc : " [in][optional] Pointer to extension-specific structure."
6161returns :
6262 - $X_RESULT_SUCCESS
6363 - $X_RESULT_ERROR_INVALID_ARGUMENT
6464--- # --------------------------------------------------------------------------
6565type : function
66- desc : " Begin capturing commands into an existing graph on the specified immediate command list ."
66+ desc : " Begin capturing commands into an existing graph on the specified immediate queue ."
6767class : $xQueue
6868name : BeginCaptureIntoGraphExp
6969params :
@@ -75,13 +75,13 @@ params:
7575 desc : " [in] Handle of the graph object to capture into."
7676 - type : void*
7777 name : pNext
78- desc : " [in][optional] pointer to extension-specific structure."
78+ desc : " [in][optional] Pointer to extension-specific structure."
7979returns :
8080 - $X_RESULT_SUCCESS
8181 - $X_RESULT_ERROR_INVALID_ARGUMENT
8282--- # --------------------------------------------------------------------------
8383type : function
84- desc : " End graph capture on the specified immediate command list ."
84+ desc : " End graph capture on the specified immediate queue ."
8585class : $xQueue
8686name : EndGraphCaptureExp
8787params :
@@ -90,10 +90,11 @@ params:
9090 desc : " [in] Handle of the queue on which to end graph capture."
9191 - type : $x_exp_graph_handle_t*
9292 name : phGraph
93- desc : " [out] Pointer to the handle of the captured graph object."
93+ desc : " [out] Pointer to the handle of the recorded graph object. If $xGraphBeginCaptureIntoGraphExp
94+ was used to begin the capture, then phGraph will contain the same graph that was passed to it."
9495 - type : void*
9596 name : pNext
96- desc : " [out][optional] pointer to extension-specific structure."
97+ desc : " [out][optional] Pointer to extension-specific structure."
9798returns :
9899 - $X_RESULT_SUCCESS
99100 - $X_RESULT_ERROR_INVALID_ARGUMENT
@@ -111,7 +112,7 @@ params:
111112 desc : " [out] Pointer to the handle of the instantiated executable graph."
112113 - type : void*
113114 name : pNext
114- desc : " [out][optional] pointer to extension-specific structure."
115+ desc : " [out][optional] Pointer to extension-specific structure."
115116returns :
116117 - $X_RESULT_SUCCESS
117118 - $X_RESULT_ERROR_INVALID_ARGUMENT
@@ -129,7 +130,7 @@ params:
129130 desc : " [in] Handle of the executable graph to append."
130131 - type : void*
131132 name : pNext
132- desc : " [in][optional] pointer to extension-specific structure."
133+ desc : " [in][optional] Pointer to extension-specific structure."
133134 - type : $x_event_handle_t
134135 name : hSignalEvent
135136 desc : " [in][optional] Event to be signaled on completion."
@@ -138,13 +139,13 @@ params:
138139 desc : " [in][optional] Number of events to wait on before executing."
139140 - type : $x_event_handle_t*
140141 name : phWaitEvents
141- desc : " [in][optional][range(0, numWaitEvents)] Pointer to an array of events to wait on."
142+ desc : " [in][optional][range(0, numWaitEvents)] Handle of the events to wait on before launching ."
142143returns :
143144 - $X_RESULT_SUCCESS
144145 - $X_RESULT_ERROR_INVALID_ARGUMENT
145146--- # --------------------------------------------------------------------------
146147type : function
147- desc : " Destroy a recorded graph object."
148+ desc : " Destroy a recorded graph object. All executable graph instances created from this recorded graph must be destroyed before calling this function. "
148149class : $xGraph
149150name : DestroyExp
150151params :
@@ -156,7 +157,7 @@ returns:
156157 - $X_RESULT_ERROR_INVALID_ARGUMENT
157158--- # --------------------------------------------------------------------------
158159type : function
159- desc : " Destroy an instantiated executable graph object."
160+ desc : " Destroy an instantiated executable graph object. The graph instance must not be executing on any queue. "
160161class : $xGraph
161162name : ExecutableGraphDestroyExp
162163params :
@@ -190,6 +191,9 @@ params:
190191 - type : $x_exp_graph_handle_t
191192 name : hGraph
192193 desc : " [in] Handle of the graph to query."
194+ - type : bool*
195+ name : hResult
196+ desc : " [out] Pointer to a boolean where the result will be stored."
193197returns :
194198 - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
195199 - $X_RESULT_ERROR_OUT_OF_RESOURCES
@@ -207,8 +211,8 @@ params:
207211 desc : " [in] Path to the file to write the dumped graph contents."
208212 - type : void*
209213 name : pNext
210- desc : " [in][optional] pointer to extension-specific structure."
214+ desc : " [in][optional] Pointer to extension-specific structure."
211215returns :
212216 - $X_RESULT_ERROR_INVALID_VALUE
213217 - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
214- - $X_RESULT_ERROR_OUT_OF_RESOURCES
218+ - $X_RESULT_ERROR_OUT_OF_RESOURCES
0 commit comments