hipeventrecordwithflags Interface Reference

hipeventrecordwithflags Interface Reference#

HIPFORT API Reference: hipfort::hipeventrecordwithflags Interface Reference

Record an event in the specified stream. More...

Public Member Functions
integer(kind(hipsuccess)) function	hipeventrecordwithflags_ (event, stream, flags)

Detailed Description

Record an event in the specified stream.

Parameters

[in]	event	- event to record.
[in]	stream	- stream in which to record event.
[in]	flags	- parameter for operations

Returns: hipSuccess, hipErrorInvalidValue, hipErrorNotInitialized, hipErrorInvalidHandle, hipErrorLaunchFailure

hipEventQuery() or hipEventSynchronize() must be used to determine when the event transitions from "recording" (after hipEventRecord() is called) to "recorded" (when timestamps are set, if requested).

Events which are recorded in a non-NULL stream will transition to from recording to "recorded" state when they reach the head of the specified stream, after all previous commands in that stream have completed executing.

Flags include: hipEventRecordDefault: Default event creation flag. hipEventRecordExternal: Event is captured in the graph as an external event node when performing stream capture

If hipEventRecord() has been previously called on this event, then this call will overwrite any existing state in event.

If this function is called on an event that is currently being recorded, results are undefined

either outstanding recording may save state into the event, and the order is not guaranteed.

Note: : If this function is not called before use hipEventQuery() or hipEventSynchronize(), hipSuccess is returned, meaning no pending event in the stream.

See also: hipEventCreate, hipEventCreateWithFlags, hipEventQuery, hipEventSynchronize, hipEventDestroy, hipEventElapsedTime

Member Function/Subroutine Documentation