hipeventrecord Interface Reference

hipeventrecord Interface Reference#

HIPFORT API Reference: hipfort::hipeventrecord Interface Reference
hipfort::hipeventrecord Interface Reference

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

Public Member Functions

integer(kind(hipsuccess)) function hipeventrecord_ (event, stream)
 

Detailed Description

Record an event in the specified stream.

Parameters
[in]eventevent to record.
[in]streamstream in which to record event.
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.

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.
See also
hipEventCreate, hipEventCreateWithFlags, hipEventQuery, hipEventSynchronize, hipEventDestroy, hipEventElapsedTime

Member Function/Subroutine Documentation

◆ hipeventrecord_()

integer(kind(hipsuccess)) function hipfort::hipeventrecord::hipeventrecord_ ( type(c_ptr), value  event,
type(c_ptr), value  stream 
)

The documentation for this interface was generated from the following file: