hip.roctx

hip.roctx#

(No short description)

Attributes:
ROCTX_VERSION_MAJOR (int):

Macro constant.

ROCTX_VERSION_MINOR (int):

Macro constant.

hip.roctx.roctx_version_major()#

(No short description, might be part of a group.)

Query the major version of the installed library.

Return the major version of the installed library. This can be used to check if it is compatible with this interface version.

Returns:

A tuple of size 1 that contains (in that order):

  • int: Returns the major version number.

hip.roctx.roctx_version_minor()#

(No short description, might be part of a group.)

Query the minor version of the installed library.

Return the minor version of the installed library. This can be used to check if it is compatible with this interface version.

Returns:

A tuple of size 1 that contains (in that order):

  • int: Returns the minor version number.

hip.roctx.roctxMarkA(message)#

(No short description, might be part of a group.)

Mark an event.

Args:
message (CStr/object) – IN:

The message associated with the event.

hip.roctx.roctxRangePushA(message)#

(No short description, might be part of a group.)

Start a new nested range.

Nested ranges are stacked and local to the current CPU thread.

Args:
message (CStr/object) – IN:

The message associated with this range.

Returns:

A tuple of size 1 that contains (in that order):

  • int: Returns the level this nested range is started at. Nested range

    levels are 0 based.

hip.roctx.roctxRangePop()#

(No short description, might be part of a group.)

Stop the current nested range.

Stop the current nested range, and pop it from the stack. If a nested range was active before the last one was started, it becomes again the current nested range.

Returns:

A tuple of size 1 that contains (in that order):

  • int: Returns the level the stopped nested range was started at, or a

    negative value if there was no nested range active.

hip.roctx.roctxRangeStartA(message)#

(No short description, might be part of a group.)

Starts a process range.

Start/stop ranges can be started and stopped in different threads. Each timespan is assigned a unique range ID.

Args:
message (CStr/object) – IN:

The message associated with this range.

Returns:

A tuple of size 1 that contains (in that order):

  • int: Returns the ID of the new range.

hip.roctx.roctxRangeStop(unsigned long id)#

(No short description, might be part of a group.)

Stop a process range.

Args:
id (int):

(undocumented)