HIP: Heterogenous-computing Interface for Portability: /long_pathname_so_that_rpms_can_package_the_debug_info/src/external/hip-on-vdi/include/hip/hip_runtime_api.h File Reference

HIP: Heterogenous-computing Interface for Portability

Classes | Macros | Typedefs | Enumerations | Functions | Variables
hip_runtime_api.h File Reference

Defines the API signatures for HIP runtime. This file can be compiled with a standard compiler. More...

`#include <string.h>`
`#include <hip/hip_version.h>`
`#include <hip/hip_common.h>`
`#include <stdint.h>`
`#include <stddef.h>`
`#include <hip/amd_detail/host_defines.h>`
`#include <hip/driver_types.h>`
`#include <hip/texture_types.h>`
`#include <hip/surface_types.h>`
Include dependency graph for hip_runtime_api.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | hipDeviceArch_t
struct | hipDeviceProp_t
struct | hipPointerAttribute_t
struct | hipIpcMemHandle_st
struct | hipIpcEventHandle_st
struct | hipFuncAttributes
struct | dim3
struct | hipLaunchParams_t
struct | hipExternalMemoryHandleDesc_st
struct | hipExternalMemoryBufferDesc_st
struct | hipExternalSemaphoreHandleDesc_st
struct | hipExternalSemaphoreSignalParams_st
struct | hipExternalSemaphoreWaitParams_st
struct | hipHostNodeParams
struct | hipKernelNodeParams
struct | hipMemsetParams

## Macros
#define | __HIP_NODISCARD
#define | GENERIC_GRID_LAUNCH 1
#define | DEPRECATED(msg) __attribute__ ((deprecated(msg)))
#define | DEPRECATED_MSG "This API is marked as deprecated and may not be supported in future releases. For more details please refer https://github.com/ROCm-Developer-Tools/HIP/blob/master/docs/markdown/hip_deprecated_api_list.md"
#define | HIP_LAUNCH_PARAM_BUFFER_POINTER ((void*)0x01)
#define | HIP_LAUNCH_PARAM_BUFFER_SIZE ((void*)0x02)
#define | HIP_LAUNCH_PARAM_END ((void*)0x03)
#define | __dparm(x)
#define | hipIpcMemLazyEnablePeerAccess 0
#define | HIP_IPC_HANDLE_SIZE 64
#define | hipStreamDefault 0x00
#define | hipStreamNonBlocking 0x01
#define | hipEventDefault 0x0
#define | hipEventBlockingSync 0x1
#define | hipEventDisableTiming 0x2
#define | hipEventInterprocess 0x4
#define | hipEventReleaseToDevice 0x40000000
#define | hipEventReleaseToSystem 0x80000000
#define | hipHostMallocDefault 0x0
#define | hipHostMallocPortable 0x1
#define | hipHostMallocMapped 0x2
#define | hipHostMallocWriteCombined 0x4
#define | hipHostMallocNumaUser 0x20000000
#define | hipHostMallocCoherent 0x40000000
#define | hipHostMallocNonCoherent 0x80000000
#define | hipMemAttachGlobal 0x01
#define | hipMemAttachHost 0x02
#define | hipMemAttachSingle 0x04
#define | hipDeviceMallocDefault 0x0
#define | hipDeviceMallocFinegrained 0x1
#define | hipMallocSignalMemory 0x2
#define | hipHostRegisterDefault 0x0
#define | hipHostRegisterPortable 0x1
#define | hipHostRegisterMapped 0x2
#define | hipHostRegisterIoMemory 0x4
#define | hipExtHostRegisterCoarseGrained 0x8
#define | hipDeviceScheduleAuto 0x0
#define | hipDeviceScheduleSpin 0x1
#define | hipDeviceScheduleYield 0x2
#define | hipDeviceScheduleBlockingSync 0x4
#define | hipDeviceScheduleMask 0x7
#define | hipDeviceMapHost 0x8
#define | hipDeviceLmemResizeToMax 0x16
#define | hipArrayDefault 0x00
#define | hipArrayLayered 0x01
#define | hipArraySurfaceLoadStore 0x02
#define | hipArrayCubemap 0x04
#define | hipArrayTextureGather 0x08
#define | hipOccupancyDefault 0x00
#define | hipCooperativeLaunchMultiDeviceNoPreSync 0x01
#define | hipCooperativeLaunchMultiDeviceNoPostSync 0x02
#define | hipCpuDeviceId ((int)-1)
#define | hipInvalidDeviceId ((int)-2)
#define | hipExtAnyOrderLaunch 0x01
#define | hipStreamWaitValueGte 0x0
#define | hipStreamWaitValueEq 0x1
#define | hipStreamWaitValueAnd 0x2
#define | hipStreamWaitValueNor 0x3
#define | hipStreamPerThread ((hipStream_t)2)
#define | USE_PEER_NON_UNIFIED 1

## Typedefs
typedef struct hipDeviceProp_t | hipDeviceProp_t
typedef enum hipMemoryType | hipMemoryType
typedef struct hipPointerAttribute_t | hipPointerAttribute_t
typedef enum __HIP_NODISCARD hipError_t | hipError_t
typedef enum hipDeviceAttribute_t | hipDeviceAttribute_t
typedef struct ihipCtx_t * | hipCtx_t
typedef int | hipDevice_t
typedef enum hipDeviceP2PAttr | hipDeviceP2PAttr
typedef struct ihipStream_t * | hipStream_t
typedef struct hipIpcMemHandle_st | hipIpcMemHandle_t
typedef struct hipIpcEventHandle_st | hipIpcEventHandle_t
typedef struct ihipModule_t * | hipModule_t
typedef struct ihipModuleSymbol_t * | hipFunction_t
typedef struct hipFuncAttributes | hipFuncAttributes
typedef struct ihipEvent_t * | hipEvent_t
typedef enum hipMemoryAdvise | hipMemoryAdvise
typedef enum hipMemRangeCoherencyMode | hipMemRangeCoherencyMode
typedef enum hipMemRangeAttribute | hipMemRangeAttribute
typedef enum hipJitOption | hipJitOption
typedef enum hipFuncAttribute | hipFuncAttribute
typedef enum hipFuncCache_t | hipFuncCache_t
typedef enum hipSharedMemConfig | hipSharedMemConfig
typedef struct dim3 | dim3
typedef struct hipLaunchParams_t | hipLaunchParams
typedef enum hipExternalMemoryHandleType_enum | hipExternalMemoryHandleType
typedef struct hipExternalMemoryHandleDesc_st | hipExternalMemoryHandleDesc
typedef struct hipExternalMemoryBufferDesc_st | hipExternalMemoryBufferDesc
typedef void * | hipExternalMemory_t
typedef enum hipExternalSemaphoreHandleType_enum | hipExternalSemaphoreHandleType
typedef struct hipExternalSemaphoreHandleDesc_st | hipExternalSemaphoreHandleDesc
typedef void * | hipExternalSemaphore_t
typedef struct hipExternalSemaphoreSignalParams_st | hipExternalSemaphoreSignalParams
typedef struct hipExternalSemaphoreWaitParams_st | hipExternalSemaphoreWaitParams
typedef enum hipGLDeviceList | hipGLDeviceList
typedef enum hipGraphicsRegisterFlags | hipGraphicsRegisterFlags
typedef struct _hipGraphicsResource | hipGraphicsResource
typedef hipGraphicsResource * | hipGraphicsResource_t
typedef void(* | hipStreamCallback_t) (hipStream_t stream, hipError_t status, void *userData)
typedef struct ihipGraph * | hipGraph_t
typedef struct hipGraphNode * | hipGraphNode_t
typedef struct hipGraphExec * | hipGraphExec_t
typedef enum hipGraphNodeType | hipGraphNodeType
typedef void(* | hipHostFn_t) (void *userData)
typedef struct hipHostNodeParams | hipHostNodeParams
typedef struct hipKernelNodeParams | hipKernelNodeParams
typedef struct hipMemsetParams | hipMemsetParams
typedef enum hipGraphExecUpdateResult | hipGraphExecUpdateResult
typedef enum hipStreamCaptureMode | hipStreamCaptureMode
typedef enum hipStreamCaptureStatus | hipStreamCaptureStatus
typedef enum hipStreamUpdateCaptureDependenciesFlags | hipStreamUpdateCaptureDependenciesFlags
typedef unsigned int | GLuint
typedef unsigned int | GLenum

## Enumerations
enum | { HIP_SUCCESS = 0, HIP_ERROR_INVALID_VALUE, HIP_ERROR_NOT_INITIALIZED, HIP_ERROR_LAUNCH_OUT_OF_RESOURCES }
enum | hipMemoryType { hipMemoryTypeHost, hipMemoryTypeDevice, hipMemoryTypeArray, hipMemoryTypeUnified }
enum | hipDeviceAttribute_t { hipDeviceAttributeCudaCompatibleBegin = 0, hipDeviceAttributeEccEnabled = hipDeviceAttributeCudaCompatibleBegin, hipDeviceAttributeAccessPolicyMaxWindowSize, hipDeviceAttributeAsyncEngineCount, hipDeviceAttributeCanMapHostMemory, hipDeviceAttributeCanUseHostPointerForRegisteredMem, hipDeviceAttributeClockRate, hipDeviceAttributeComputeMode, hipDeviceAttributeComputePreemptionSupported, hipDeviceAttributeConcurrentKernels, hipDeviceAttributeConcurrentManagedAccess, hipDeviceAttributeCooperativeLaunch, hipDeviceAttributeCooperativeMultiDeviceLaunch, hipDeviceAttributeDeviceOverlap, hipDeviceAttributeDirectManagedMemAccessFromHost, hipDeviceAttributeGlobalL1CacheSupported, hipDeviceAttributeHostNativeAtomicSupported, hipDeviceAttributeIntegrated, hipDeviceAttributeIsMultiGpuBoard, hipDeviceAttributeKernelExecTimeout, hipDeviceAttributeL2CacheSize, hipDeviceAttributeLocalL1CacheSupported, hipDeviceAttributeLuid, hipDeviceAttributeLuidDeviceNodeMask, hipDeviceAttributeComputeCapabilityMajor, hipDeviceAttributeManagedMemory, hipDeviceAttributeMaxBlocksPerMultiProcessor, hipDeviceAttributeMaxBlockDimX, hipDeviceAttributeMaxBlockDimY, hipDeviceAttributeMaxBlockDimZ, hipDeviceAttributeMaxGridDimX, hipDeviceAttributeMaxGridDimY, hipDeviceAttributeMaxGridDimZ, hipDeviceAttributeMaxSurface1D, hipDeviceAttributeMaxSurface1DLayered, hipDeviceAttributeMaxSurface2D, hipDeviceAttributeMaxSurface2DLayered, hipDeviceAttributeMaxSurface3D, hipDeviceAttributeMaxSurfaceCubemap, hipDeviceAttributeMaxSurfaceCubemapLayered, hipDeviceAttributeMaxTexture1DWidth, hipDeviceAttributeMaxTexture1DLayered, hipDeviceAttributeMaxTexture1DLinear, hipDeviceAttributeMaxTexture1DMipmap, hipDeviceAttributeMaxTexture2DWidth, hipDeviceAttributeMaxTexture2DHeight, hipDeviceAttributeMaxTexture2DGather, hipDeviceAttributeMaxTexture2DLayered, hipDeviceAttributeMaxTexture2DLinear, hipDeviceAttributeMaxTexture2DMipmap, hipDeviceAttributeMaxTexture3DWidth, hipDeviceAttributeMaxTexture3DHeight, hipDeviceAttributeMaxTexture3DDepth, hipDeviceAttributeMaxTexture3DAlt, hipDeviceAttributeMaxTextureCubemap, hipDeviceAttributeMaxTextureCubemapLayered, hipDeviceAttributeMaxThreadsDim, hipDeviceAttributeMaxThreadsPerBlock, hipDeviceAttributeMaxThreadsPerMultiProcessor, hipDeviceAttributeMaxPitch, hipDeviceAttributeMemoryBusWidth, hipDeviceAttributeMemoryClockRate, hipDeviceAttributeComputeCapabilityMinor, hipDeviceAttributeMultiGpuBoardGroupID, hipDeviceAttributeMultiprocessorCount, hipDeviceAttributeName, hipDeviceAttributePageableMemoryAccess, hipDeviceAttributePageableMemoryAccessUsesHostPageTables, hipDeviceAttributePciBusId, hipDeviceAttributePciDeviceId, hipDeviceAttributePciDomainID, hipDeviceAttributePersistingL2CacheMaxSize, hipDeviceAttributeMaxRegistersPerBlock, hipDeviceAttributeMaxRegistersPerMultiprocessor, hipDeviceAttributeReservedSharedMemPerBlock, hipDeviceAttributeMaxSharedMemoryPerBlock, hipDeviceAttributeSharedMemPerBlockOptin, hipDeviceAttributeSharedMemPerMultiprocessor, hipDeviceAttributeSingleToDoublePrecisionPerfRatio, hipDeviceAttributeStreamPrioritiesSupported, hipDeviceAttributeSurfaceAlignment, hipDeviceAttributeTccDriver, hipDeviceAttributeTextureAlignment, hipDeviceAttributeTexturePitchAlignment, hipDeviceAttributeTotalConstantMemory, hipDeviceAttributeTotalGlobalMem, hipDeviceAttributeUnifiedAddressing, hipDeviceAttributeUuid, hipDeviceAttributeWarpSize, hipDeviceAttributeCudaCompatibleEnd = 9999, hipDeviceAttributeAmdSpecificBegin = 10000, hipDeviceAttributeClockInstructionRate = hipDeviceAttributeAmdSpecificBegin, hipDeviceAttributeArch, hipDeviceAttributeMaxSharedMemoryPerMultiprocessor, hipDeviceAttributeGcnArch, hipDeviceAttributeGcnArchName, hipDeviceAttributeHdpMemFlushCntl, hipDeviceAttributeHdpRegFlushCntl, hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc, hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim, hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim, hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem, hipDeviceAttributeIsLargeBar, hipDeviceAttributeAsicRevision, hipDeviceAttributeCanUseStreamWaitValue, hipDeviceAttributeImageSupport, hipDeviceAttributePhysicalMultiProcessorCount, hipDeviceAttributeAmdSpecificEnd = 19999, hipDeviceAttributeVendorSpecificBegin = 20000 }
enum | hipComputeMode { hipComputeModeDefault = 0, hipComputeModeExclusive = 1, hipComputeModeProhibited = 2, hipComputeModeExclusiveProcess = 3 }
enum | hipDeviceP2PAttr { hipDevP2PAttrPerformanceRank = 0, hipDevP2PAttrAccessSupported, hipDevP2PAttrNativeAtomicSupported, hipDevP2PAttrHipArrayAccessSupported }
enum | hipLimit_t { hipLimitPrintfFifoSize = 0x01, hipLimitMallocHeapSize = 0x02 }
enum | hipMemoryAdvise { hipMemAdviseSetReadMostly = 1, hipMemAdviseUnsetReadMostly = 2, hipMemAdviseSetPreferredLocation = 3, hipMemAdviseUnsetPreferredLocation = 4, hipMemAdviseSetAccessedBy = 5, hipMemAdviseUnsetAccessedBy = 6, hipMemAdviseSetCoarseGrain = 100, hipMemAdviseUnsetCoarseGrain = 101 }
enum | hipMemRangeCoherencyMode { hipMemRangeCoherencyModeFineGrain = 0, hipMemRangeCoherencyModeCoarseGrain = 1, hipMemRangeCoherencyModeIndeterminate = 2 }
enum | hipMemRangeAttribute { hipMemRangeAttributeReadMostly = 1, hipMemRangeAttributePreferredLocation = 2, hipMemRangeAttributeAccessedBy = 3, hipMemRangeAttributeLastPrefetchLocation = 4, hipMemRangeAttributeCoherencyMode = 100 }
enum | hipJitOption { hipJitOptionMaxRegisters = 0, hipJitOptionThreadsPerBlock, hipJitOptionWallTime, hipJitOptionInfoLogBuffer, hipJitOptionInfoLogBufferSizeBytes, hipJitOptionErrorLogBuffer, hipJitOptionErrorLogBufferSizeBytes, hipJitOptionOptimizationLevel, hipJitOptionTargetFromContext, hipJitOptionTarget, hipJitOptionFallbackStrategy, hipJitOptionGenerateDebugInfo, hipJitOptionLogVerbose, hipJitOptionGenerateLineInfo, hipJitOptionCacheMode, hipJitOptionSm3xOpt, hipJitOptionFastCompile, hipJitOptionNumOptions }
enum | hipFuncAttribute { hipFuncAttributeMaxDynamicSharedMemorySize = 8, hipFuncAttributePreferredSharedMemoryCarveout = 9, hipFuncAttributeMax }
enum | hipFuncCache_t { hipFuncCachePreferNone, hipFuncCachePreferShared, hipFuncCachePreferL1, hipFuncCachePreferEqual }
enum | hipSharedMemConfig { hipSharedMemBankSizeDefault, hipSharedMemBankSizeFourByte, hipSharedMemBankSizeEightByte }
enum | hipExternalMemoryHandleType_enum { hipExternalMemoryHandleTypeOpaqueFd = 1, hipExternalMemoryHandleTypeOpaqueWin32 = 2, hipExternalMemoryHandleTypeOpaqueWin32Kmt = 3, hipExternalMemoryHandleTypeD3D12Heap = 4, hipExternalMemoryHandleTypeD3D12Resource = 5, hipExternalMemoryHandleTypeD3D11Resource = 6, hipExternalMemoryHandleTypeD3D11ResourceKmt = 7 }
enum | hipExternalSemaphoreHandleType_enum { hipExternalSemaphoreHandleTypeOpaqueFd = 1, hipExternalSemaphoreHandleTypeOpaqueWin32 = 2, hipExternalSemaphoreHandleTypeOpaqueWin32Kmt = 3, hipExternalSemaphoreHandleTypeD3D12Fence = 4 }
enum | hipGLDeviceList { hipGLDeviceListAll = 1, hipGLDeviceListCurrentFrame = 2, hipGLDeviceListNextFrame = 3 }
enum | hipGraphicsRegisterFlags { hipGraphicsRegisterFlagsNone = 0, hipGraphicsRegisterFlagsReadOnly = 1, hipGraphicsRegisterFlagsWriteDiscard, hipGraphicsRegisterFlagsSurfaceLoadStore = 4, hipGraphicsRegisterFlagsTextureGather }
enum | hipGraphNodeType { hipGraphNodeTypeKernel = 1, hipGraphNodeTypeMemcpy = 2, hipGraphNodeTypeMemset = 3, hipGraphNodeTypeHost = 4, hipGraphNodeTypeGraph = 5, hipGraphNodeTypeEmpty = 6, hipGraphNodeTypeWaitEvent = 7, hipGraphNodeTypeEventRecord = 8, hipGraphNodeTypeMemcpy1D = 9, hipGraphNodeTypeMemcpyFromSymbol = 10, hipGraphNodeTypeMemcpyToSymbol = 11, hipGraphNodeTypeCount }
enum | hipGraphExecUpdateResult { hipGraphExecUpdateSuccess = 0x0, hipGraphExecUpdateError = 0x1, hipGraphExecUpdateErrorTopologyChanged = 0x2, hipGraphExecUpdateErrorNodeTypeChanged = 0x3, hipGraphExecUpdateErrorFunctionChanged, hipGraphExecUpdateErrorParametersChanged, hipGraphExecUpdateErrorNotSupported, hipGraphExecUpdateErrorUnsupportedFunctionChange = 0x7 }
enum | hipStreamCaptureMode { hipStreamCaptureModeGlobal = 0, hipStreamCaptureModeThreadLocal, hipStreamCaptureModeRelaxed }
enum | hipStreamCaptureStatus { hipStreamCaptureStatusNone = 0, hipStreamCaptureStatusActive, hipStreamCaptureStatusInvalidated }
enum | hipStreamUpdateCaptureDependenciesFlags { hipStreamAddCaptureDependencies = 0, hipStreamSetCaptureDependencies }

## Functions
hipError_t | hipInit (unsigned int flags)
| Explicitly initializes the HIP runtime. More...
hipError_t | hipDriverGetVersion (int *driverVersion)
| Returns the approximate HIP driver version. More...
hipError_t | hipRuntimeGetVersion (int *runtimeVersion)
| Returns the approximate HIP Runtime version. More...
hipError_t | hipDeviceGet (hipDevice_t *device, int ordinal)
| Returns a handle to a compute device. More...
hipError_t | hipDeviceComputeCapability (int *major, int *minor, hipDevice_t device)
| Returns the compute capability of the device. More...
hipError_t | hipDeviceGetName (char *name, int len, hipDevice_t device)
| Returns an identifer string for the device. More...
hipError_t | hipDeviceGetP2PAttribute (int *value, hipDeviceP2PAttr attr, int srcDevice, int dstDevice)
| Returns a value for attr of link between two devices. More...
hipError_t | hipDeviceGetPCIBusId (char *pciBusId, int len, int device)
| Returns a PCI Bus Id string for the device, overloaded to take int device ID. More...
hipError_t | hipDeviceGetByPCIBusId (int *device, const char *pciBusId)
| Returns a handle to a compute device. More...
hipError_t | hipDeviceTotalMem (size_t *bytes, hipDevice_t device)
| Returns the total amount of memory on the device. More...
hipError_t | hipDeviceSynchronize (void)
| Waits on all active streams on current device. More...
hipError_t | hipDeviceReset (void)
| The state of current device is discarded and updated to a fresh state. More...
hipError_t | hipSetDevice (int deviceId)
| Set default device to be used for subsequent hip API calls from this thread. More...
hipError_t | hipGetDevice (int *deviceId)
| Return the default device id for the calling host thread. More...
hipError_t | hipGetDeviceCount (int *count)
| Return number of compute-capable devices. More...
hipError_t | hipDeviceGetAttribute (int *pi, hipDeviceAttribute_t attr, int deviceId)
| Query for a specific device attribute. More...
hipError_t | hipGetDeviceProperties (hipDeviceProp_t *prop, int deviceId)
| Returns device properties. More...
hipError_t | hipDeviceSetCacheConfig (hipFuncCache_t cacheConfig)
| Set L1/Shared cache partition. More...
hipError_t | hipDeviceGetCacheConfig (hipFuncCache_t *cacheConfig)
| Set Cache configuration for a specific function. More...
hipError_t | hipDeviceGetLimit (size_t *pValue, enum hipLimit_t limit)
| Get Resource limits of current device. More...
hipError_t | hipDeviceGetSharedMemConfig (hipSharedMemConfig *pConfig)
| Returns bank width of shared memory for current device. More...
hipError_t | hipGetDeviceFlags (unsigned int *flags)
| Gets the flags set for current device. More...
hipError_t | hipDeviceSetSharedMemConfig (hipSharedMemConfig config)
| The bank width of shared memory on current device is set. More...
hipError_t | hipSetDeviceFlags (unsigned flags)
| The current device behavior is changed according the flags passed. More...
hipError_t | hipChooseDevice (int *device, const hipDeviceProp_t *prop)
| Device which matches hipDeviceProp_t is returned. More...
hipError_t | hipExtGetLinkTypeAndHopCount (int device1, int device2, uint32_t *linktype, uint32_t *hopcount)
| Returns the link type and hop count between two devices. More...
hipError_t | hipIpcGetMemHandle (hipIpcMemHandle_t *handle, void *devPtr)
| Gets an interprocess memory handle for an existing device memory allocation. More...
hipError_t | hipIpcOpenMemHandle (void **devPtr, hipIpcMemHandle_t handle, unsigned int flags)
| Opens an interprocess memory handle exported from another process and returns a device pointer usable in the local process. More...
hipError_t | hipIpcCloseMemHandle (void *devPtr)
| Close memory mapped with hipIpcOpenMemHandle. More...
hipError_t | hipIpcGetEventHandle (hipIpcEventHandle_t *handle, hipEvent_t event)
| Gets an opaque interprocess handle for an event. More...
hipError_t | hipIpcOpenEventHandle (hipEvent_t *event, hipIpcEventHandle_t handle)
| Opens an interprocess event handles. More...
hipError_t | hipFuncSetAttribute (const void *func, hipFuncAttribute attr, int value)
| Set attribute for a specific function. More...
hipError_t | hipFuncSetCacheConfig (const void *func, hipFuncCache_t config)
| Set Cache configuration for a specific function. More...
hipError_t | hipFuncSetSharedMemConfig (const void *func, hipSharedMemConfig config)
| Set shared memory configuation for a specific function. More...
hipError_t | hipGetLastError (void)
| Return last error returned by any HIP runtime API call and resets the stored error code to hipSuccess. More...
hipError_t | hipPeekAtLastError (void)
| Return last error returned by any HIP runtime API call. More...
const char * | hipGetErrorName (hipError_t hip_error)
| Return name of the specified error code in text form. More...
const char * | hipGetErrorString (hipError_t hipError)
| Return handy text string message to explain the error which occurred. More...
hipError_t | hipStreamCreate (hipStream_t *stream)
| Create an asynchronous stream. More...
hipError_t | hipStreamCreateWithFlags (hipStream_t *stream, unsigned int flags)
| Create an asynchronous stream. More...
hipError_t | hipStreamCreateWithPriority (hipStream_t *stream, unsigned int flags, int priority)
| Create an asynchronous stream with the specified priority. More...
hipError_t | hipDeviceGetStreamPriorityRange (int *leastPriority, int *greatestPriority)
| Returns numerical values that correspond to the least and greatest stream priority. More...
hipError_t | hipStreamDestroy (hipStream_t stream)
| Destroys the specified stream. More...
hipError_t | hipStreamQuery (hipStream_t stream)
| Return hipSuccess if all of the operations in the specified `stream` have completed, or hipErrorNotReady if not. More...
hipError_t | hipStreamSynchronize (hipStream_t stream)
| Wait for all commands in stream to complete. More...
hipError_t | hipStreamWaitEvent (hipStream_t stream, hipEvent_t event, unsigned int flags)
| Make the specified compute stream wait for an event. More...
hipError_t | hipStreamGetFlags (hipStream_t stream, unsigned int *flags)
| Return flags associated with this stream. More...
hipError_t | hipStreamGetPriority (hipStream_t stream, int *priority)
| Query the priority of a stream. More...
hipError_t | hipExtStreamCreateWithCUMask (hipStream_t *stream, uint32_t cuMaskSize, const uint32_t *cuMask)
| Create an asynchronous stream with the specified CU mask. More...
hipError_t | hipExtStreamGetCUMask (hipStream_t stream, uint32_t cuMaskSize, uint32_t *cuMask)
| Get CU mask associated with an asynchronous stream. More...
hipError_t | hipStreamAddCallback (hipStream_t stream, hipStreamCallback_t callback, void *userData, unsigned int flags)
| Adds a callback to be called on the host after all currently enqueued items in the stream have completed. For each hipStreamAddCallback call, a callback will be executed exactly once. The callback will block later work in the stream until it is finished. More...
hipError_t | hipStreamWaitValue32 (hipStream_t stream, void *ptr, uint32_t value, unsigned int flags, uint32_t mask __dparm(0xFFFFFFFF))
| Enqueues a wait command to the stream.[BETA]. More...
hipError_t | hipStreamWaitValue64 (hipStream_t stream, void *ptr, uint64_t value, unsigned int flags, uint64_t mask __dparm(0xFFFFFFFFFFFFFFFF))
| Enqueues a wait command to the stream.[BETA]. More...
hipError_t | hipStreamWriteValue32 (hipStream_t stream, void *ptr, uint32_t value, unsigned int flags)
| Enqueues a write command to the stream.[BETA]. More...
hipError_t | hipStreamWriteValue64 (hipStream_t stream, void *ptr, uint64_t value, unsigned int flags)
| Enqueues a write command to the stream.[BETA]. More...
hipError_t | hipEventCreateWithFlags (hipEvent_t *event, unsigned flags)
| Create an event with the specified flags. More...
hipError_t | hipEventCreate (hipEvent_t *event)
hipError_t | hipEventRecord (hipEvent_t event, hipStream_t stream)
| Record an event in the specified stream. More...
hipError_t | hipEventDestroy (hipEvent_t event)
| Destroy the specified event. More...
hipError_t | hipEventSynchronize (hipEvent_t event)
| Wait for an event to complete. More...
hipError_t | hipEventElapsedTime (float *ms, hipEvent_t start, hipEvent_t stop)
| Return the elapsed time between two events. More...
hipError_t | hipEventQuery (hipEvent_t event)
| Query event status. More...
hipError_t | hipPointerGetAttributes (hipPointerAttribute_t *attributes, const void *ptr)
| Return attributes for the specified pointer. More...
hipError_t | hipPointerGetAttribute (void *data, hipPointer_attribute attribute, hipDeviceptr_t ptr)
| Returns information about the specified pointer.[BETA]. More...
hipError_t | hipDrvPointerGetAttributes (unsigned int numAttributes, hipPointer_attribute *attributes, void **data, hipDeviceptr_t ptr)
| Returns information about the specified pointer.[BETA]. More...
hipError_t | hipImportExternalSemaphore (hipExternalSemaphore_t *extSem_out, const hipExternalSemaphoreHandleDesc *semHandleDesc)
| Imports an external semaphore. More...
hipError_t | hipSignalExternalSemaphoresAsync (const hipExternalSemaphore_t *extSemArray, const hipExternalSemaphoreSignalParams *paramsArray, unsigned int numExtSems, hipStream_t stream)
| Signals a set of external semaphore objects. More...
hipError_t | hipWaitExternalSemaphoresAsync (const hipExternalSemaphore_t *extSemArray, const hipExternalSemaphoreWaitParams *paramsArray, unsigned int numExtSems, hipStream_t stream)
| Waits on a set of external semaphore objects. More...
hipError_t | hipDestroyExternalSemaphore (hipExternalSemaphore_t extSem)
| Destroys an external semaphore object and releases any references to the underlying resource. Any outstanding signals or waits must have completed before the semaphore is destroyed. More...
hipError_t | hipImportExternalMemory (hipExternalMemory_t *extMem_out, const hipExternalMemoryHandleDesc *memHandleDesc)
| Imports an external memory object. More...
hipError_t | hipExternalMemoryGetMappedBuffer (void **devPtr, hipExternalMemory_t extMem, const hipExternalMemoryBufferDesc *bufferDesc)
| Maps a buffer onto an imported memory object. More...
hipError_t | hipDestroyExternalMemory (hipExternalMemory_t extMem)
| Destroys an external memory object. More...
hipError_t | hipMalloc (void **ptr, size_t size)
| Allocate memory on the default accelerator. More...
hipError_t | hipExtMallocWithFlags (void **ptr, size_t sizeBytes, unsigned int flags)
| Allocate memory on the default accelerator. More...
hipError_t | hipMallocHost (void **ptr, size_t size)
| Allocate pinned host memory [Deprecated]. More...
hipError_t | hipMemAllocHost (void **ptr, size_t size)
| Allocate pinned host memory [Deprecated]. More...
hipError_t | hipHostMalloc (void **ptr, size_t size, unsigned int flags)
| Allocate device accessible page locked host memory. More...
hipError_t | hipMallocManaged (void **dev_ptr, size_t size, unsigned int flags __dparm(hipMemAttachGlobal))
| Allocates memory that will be automatically managed by HIP. More...
hipError_t | hipMemPrefetchAsync (const void *dev_ptr, size_t count, int device, hipStream_t stream __dparm(0))
| Prefetches memory to the specified destination device using HIP. More...
hipError_t | hipMemAdvise (const void *dev_ptr, size_t count, hipMemoryAdvise advice, int device)
| Advise about the usage of a given memory range to HIP. More...
hipError_t | hipMemRangeGetAttribute (void *data, size_t data_size, hipMemRangeAttribute attribute, const void *dev_ptr, size_t count)
| Query an attribute of a given memory range in HIP. More...
hipError_t | hipMemRangeGetAttributes (void **data, size_t *data_sizes, hipMemRangeAttribute *attributes, size_t num_attributes, const void *dev_ptr, size_t count)
| Query attributes of a given memory range in HIP. More...
hipError_t | hipStreamAttachMemAsync (hipStream_t stream, void *dev_ptr, size_t length __dparm(0), unsigned int flags __dparm(hipMemAttachSingle))
| Attach memory to a stream asynchronously in HIP. More...
hipError_t | hipHostAlloc (void **ptr, size_t size, unsigned int flags)
| Allocate device accessible page locked host memory [Deprecated]. More...
hipError_t | hipHostGetDevicePointer (void **devPtr, void *hstPtr, unsigned int flags)
| Get Device pointer from Host Pointer allocated through hipHostMalloc. More...
hipError_t | hipHostGetFlags (unsigned int *flagsPtr, void *hostPtr)
| Return flags associated with host pointer. More...
hipError_t | hipHostRegister (void *hostPtr, size_t sizeBytes, unsigned int flags)
| Register host memory so it can be accessed from the current device. More...
hipError_t | hipHostUnregister (void *hostPtr)
| Un-register host pointer. More...
hipError_t | hipMallocPitch (void **ptr, size_t *pitch, size_t width, size_t height)
hipError_t | hipMemAllocPitch (hipDeviceptr_t *dptr, size_t *pitch, size_t widthInBytes, size_t height, unsigned int elementSizeBytes)
hipError_t | hipFree (void *ptr)
| Free memory allocated by the hcc hip memory allocation API. This API performs an implicit hipDeviceSynchronize() call. If pointer is NULL, the hip runtime is initialized and hipSuccess is returned. More...
hipError_t | hipFreeHost (void *ptr)
| Free memory allocated by the hcc hip host memory allocation API. [Deprecated]. More...
hipError_t | hipHostFree (void *ptr)
| Free memory allocated by the hcc hip host memory allocation API This API performs an implicit hipDeviceSynchronize() call. If pointer is NULL, the hip runtime is initialized and hipSuccess is returned. More...
hipError_t | hipMemcpy (void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind)
| Copy data from src to dst. More...
hipError_t | hipMemcpyWithStream (void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream)
hipError_t | hipMemcpyHtoD (hipDeviceptr_t dst, void *src, size_t sizeBytes)
| Copy data from Host to Device. More...
hipError_t | hipMemcpyDtoH (void *dst, hipDeviceptr_t src, size_t sizeBytes)
| Copy data from Device to Host. More...
hipError_t | hipMemcpyDtoD (hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes)
| Copy data from Device to Device. More...
hipError_t | hipMemcpyHtoDAsync (hipDeviceptr_t dst, void *src, size_t sizeBytes, hipStream_t stream)
| Copy data from Host to Device asynchronously. More...
hipError_t | hipMemcpyDtoHAsync (void *dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
| Copy data from Device to Host asynchronously. More...
hipError_t | hipMemcpyDtoDAsync (hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
| Copy data from Device to Device asynchronously. More...
hipError_t | hipModuleGetGlobal (hipDeviceptr_t *dptr, size_t *bytes, hipModule_t hmod, const char *name)
| Returns a global pointer from a module. Returns in *dptr and *bytes the pointer and size of the global of name name located in module hmod. If no variable of that name exists, it returns hipErrorNotFound. Both parameters dptr and bytes are optional. If one of them is NULL, it is ignored and hipSuccess is returned. More...
hipError_t | hipGetSymbolAddress (void **devPtr, const void *symbol)
| Gets device pointer associated with symbol on the device. More...
hipError_t | hipGetSymbolSize (size_t *size, const void *symbol)
| Gets the size of the given symbol on the device. More...
hipError_t | hipMemcpyToSymbol (const void *symbol, const void *src, size_t sizeBytes, size_t offset __dparm(0), hipMemcpyKind kind __dparm(hipMemcpyHostToDevice))
| Copies data to the given symbol on the device. Symbol HIP APIs allow a kernel to define a device-side data symbol which can be accessed on the host side. The symbol can be in __constant or device space. Note that the symbol name needs to be encased in the HIP_SYMBOL macro. This also applies to hipMemcpyFromSymbol, hipGetSymbolAddress, and hipGetSymbolSize. For detail usage, see the example at https://github.com/ROCm-Developer-Tools/HIP/blob/rocm-5.0.x/docs/markdown/hip_porting_guide.md. More...
hipError_t | hipMemcpyToSymbolAsync (const void *symbol, const void *src, size_t sizeBytes, size_t offset, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copies data to the given symbol on the device asynchronously. More...
hipError_t | hipMemcpyFromSymbol (void *dst, const void *symbol, size_t sizeBytes, size_t offset __dparm(0), hipMemcpyKind kind __dparm(hipMemcpyDeviceToHost))
| Copies data from the given symbol on the device. More...
hipError_t | hipMemcpyFromSymbolAsync (void *dst, const void *symbol, size_t sizeBytes, size_t offset, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copies data from the given symbol on the device asynchronously. More...
hipError_t | hipMemcpyAsync (void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copy data from src to dst asynchronously. More...
hipError_t | hipMemset (void *dst, int value, size_t sizeBytes)
| Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value value. More...
hipError_t | hipMemsetD8 (hipDeviceptr_t dest, unsigned char value, size_t count)
| Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value value. More...
hipError_t | hipMemsetD8Async (hipDeviceptr_t dest, unsigned char value, size_t count, hipStream_t stream __dparm(0))
| Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value value. More...
hipError_t | hipMemsetD16 (hipDeviceptr_t dest, unsigned short value, size_t count)
| Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant short value value. More...
hipError_t | hipMemsetD16Async (hipDeviceptr_t dest, unsigned short value, size_t count, hipStream_t stream __dparm(0))
| Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant short value value. More...
hipError_t | hipMemsetD32 (hipDeviceptr_t dest, int value, size_t count)
| Fills the memory area pointed to by dest with the constant integer value for specified number of times. More...
hipError_t | hipMemsetAsync (void *dst, int value, size_t sizeBytes, hipStream_t stream __dparm(0))
| Fills the first sizeBytes bytes of the memory area pointed to by dev with the constant byte value value. More...
hipError_t | hipMemsetD32Async (hipDeviceptr_t dst, int value, size_t count, hipStream_t stream __dparm(0))
| Fills the memory area pointed to by dev with the constant integer value for specified number of times. More...
hipError_t | hipMemset2D (void *dst, size_t pitch, int value, size_t width, size_t height)
| Fills the memory area pointed to by dst with the constant value. More...
hipError_t | hipMemset2DAsync (void *dst, size_t pitch, int value, size_t width, size_t height, hipStream_t stream __dparm(0))
| Fills asynchronously the memory area pointed to by dst with the constant value. More...
hipError_t | hipMemset3D (hipPitchedPtr pitchedDevPtr, int value, hipExtent extent)
| Fills synchronously the memory area pointed to by pitchedDevPtr with the constant value. More...
hipError_t | hipMemset3DAsync (hipPitchedPtr pitchedDevPtr, int value, hipExtent extent, hipStream_t stream __dparm(0))
| Fills asynchronously the memory area pointed to by pitchedDevPtr with the constant value. More...
hipError_t | hipMemGetInfo (size_t *free, size_t *total)
| Query memory info. Return snapshot of free memory, and total allocatable memory on the device. More...
hipError_t | hipMemPtrGetInfo (void *ptr, size_t *size)
hipError_t | hipMallocArray (hipArray **array, const hipChannelFormatDesc *desc, size_t width, size_t height __dparm(0), unsigned int flags __dparm(hipArrayDefault))
| Allocate an array on the device. More...
hipError_t | hipArrayCreate (hipArray **pHandle, const HIP_ARRAY_DESCRIPTOR *pAllocateArray)
hipError_t | hipArrayDestroy (hipArray *array)
hipError_t | hipArray3DCreate (hipArray **array, const HIP_ARRAY3D_DESCRIPTOR *pAllocateArray)
hipError_t | hipMalloc3D (hipPitchedPtr *pitchedDevPtr, hipExtent extent)
hipError_t | hipFreeArray (hipArray *array)
| Frees an array on the device. More...
hipError_t | hipFreeMipmappedArray (hipMipmappedArray_t mipmappedArray)
| Frees a mipmapped array on the device. More...
hipError_t | hipMalloc3DArray (hipArray **array, const struct hipChannelFormatDesc *desc, struct hipExtent extent, unsigned int flags)
| Allocate an array on the device. More...
hipError_t | hipMallocMipmappedArray (hipMipmappedArray_t *mipmappedArray, const struct hipChannelFormatDesc *desc, struct hipExtent extent, unsigned int numLevels, unsigned int flags __dparm(0))
| Allocate a mipmapped array on the device. More...
hipError_t | hipGetMipmappedArrayLevel (hipArray_t *levelArray, hipMipmappedArray_const_t mipmappedArray, unsigned int level)
| Gets a mipmap level of a HIP mipmapped array. More...
hipError_t | hipMemcpy2D (void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind)
| Copies data between host and device. More...
hipError_t | hipMemcpyParam2D (const hip_Memcpy2D *pCopy)
| Copies memory for 2D arrays. More...
hipError_t | hipMemcpyParam2DAsync (const hip_Memcpy2D *pCopy, hipStream_t stream __dparm(0))
| Copies memory for 2D arrays. More...
hipError_t | hipMemcpy2DAsync (void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copies data between host and device. More...
hipError_t | hipMemcpy2DToArray (hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind)
| Copies data between host and device. More...
hipError_t | hipMemcpy2DToArrayAsync (hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copies data between host and device. More...
hipError_t | hipMemcpyToArray (hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t count, hipMemcpyKind kind)
| Copies data between host and device. More...
hipError_t | hipMemcpyFromArray (void *dst, hipArray_const_t srcArray, size_t wOffset, size_t hOffset, size_t count, hipMemcpyKind kind)
| Copies data between host and device. More...
hipError_t | hipMemcpy2DFromArray (void *dst, size_t dpitch, hipArray_const_t src, size_t wOffset, size_t hOffset, size_t width, size_t height, hipMemcpyKind kind)
| Copies data between host and device. More...
hipError_t | hipMemcpy2DFromArrayAsync (void *dst, size_t dpitch, hipArray_const_t src, size_t wOffset, size_t hOffset, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0))
| Copies data between host and device asynchronously. More...
hipError_t | hipMemcpyAtoH (void *dst, hipArray *srcArray, size_t srcOffset, size_t count)
| Copies data between host and device. More...
hipError_t | hipMemcpyHtoA (hipArray *dstArray, size_t dstOffset, const void *srcHost, size_t count)
| Copies data between host and device. More...
hipError_t | hipMemcpy3D (const struct hipMemcpy3DParms *p)
| Copies data between host and device. More...
hipError_t | hipMemcpy3DAsync (const struct hipMemcpy3DParms *p, hipStream_t stream __dparm(0))
| Copies data between host and device asynchronously. More...
hipError_t | hipDrvMemcpy3D (const HIP_MEMCPY3D *pCopy)
| Copies data between host and device. More...
hipError_t | hipDrvMemcpy3DAsync (const HIP_MEMCPY3D *pCopy, hipStream_t stream)
| Copies data between host and device asynchronously. More...
hipError_t | hipDeviceCanAccessPeer (int *canAccessPeer, int deviceId, int peerDeviceId)
| Determine if a device can access a peer's memory. More...
hipError_t | hipDeviceEnablePeerAccess (int peerDeviceId, unsigned int flags)
| Enable direct access from current device's virtual address space to memory allocations physically located on a peer device. More...
hipError_t | hipDeviceDisablePeerAccess (int peerDeviceId)
| Disable direct access from current device's virtual address space to memory allocations physically located on a peer device. More...
hipError_t | hipMemGetAddressRange (hipDeviceptr_t *pbase, size_t *psize, hipDeviceptr_t dptr)
| Get information on memory allocations. More...
hipError_t | hipMemcpyPeer (void *dst, int dstDeviceId, const void *src, int srcDeviceId, size_t sizeBytes)
| Copies memory from one device to memory on another device. More...
hipError_t | hipMemcpyPeerAsync (void *dst, int dstDeviceId, const void *src, int srcDevice, size_t sizeBytes, hipStream_t stream __dparm(0))
| Copies memory from one device to memory on another device. More...
hipError_t | hipCtxCreate (hipCtx_t *ctx, unsigned int flags, hipDevice_t device)
| Create a context and set it as current/ default context. More...
hipError_t | hipCtxDestroy (hipCtx_t ctx)
| Destroy a HIP context. More...
hipError_t | hipCtxPopCurrent (hipCtx_t *ctx)
| Pop the current/default context and return the popped context. More...
hipError_t | hipCtxPushCurrent (hipCtx_t ctx)
| Push the context to be set as current/ default context. More...
hipError_t | hipCtxSetCurrent (hipCtx_t ctx)
| Set the passed context as current/default. More...
hipError_t | hipCtxGetCurrent (hipCtx_t *ctx)
| Get the handle of the current/ default context. More...
hipError_t | hipCtxGetDevice (hipDevice_t *device)
| Get the handle of the device associated with current/default context. More...
hipError_t | hipCtxGetApiVersion (hipCtx_t ctx, int *apiVersion)
| Returns the approximate HIP api version. More...
hipError_t | hipCtxGetCacheConfig (hipFuncCache_t *cacheConfig)
| Set Cache configuration for a specific function. More...
hipError_t | hipCtxSetCacheConfig (hipFuncCache_t cacheConfig)
| Set L1/Shared cache partition. More...
hipError_t | hipCtxSetSharedMemConfig (hipSharedMemConfig config)
| Set Shared memory bank configuration. More...
hipError_t | hipCtxGetSharedMemConfig (hipSharedMemConfig *pConfig)
| Get Shared memory bank configuration. More...
hipError_t | hipCtxSynchronize (void)
| Blocks until the default context has completed all preceding requested tasks. More...
hipError_t | hipCtxGetFlags (unsigned int *flags)
| Return flags used for creating default context. More...
hipError_t | hipCtxEnablePeerAccess (hipCtx_t peerCtx, unsigned int flags)
| Enables direct access to memory allocations in a peer context. More...
hipError_t | hipCtxDisablePeerAccess (hipCtx_t peerCtx)
| Disable direct access from current context's virtual address space to memory allocations physically located on a peer context.Disables direct access to memory allocations in a peer context and unregisters any registered allocations. More...
hipError_t | hipDevicePrimaryCtxGetState (hipDevice_t dev, unsigned int *flags, int *active)
| Get the state of the primary context. More...
hipError_t | hipDevicePrimaryCtxRelease (hipDevice_t dev)
| Release the primary context on the GPU. More...
hipError_t | hipDevicePrimaryCtxRetain (hipCtx_t *pctx, hipDevice_t dev)
| Retain the primary context on the GPU. More...
hipError_t | hipDevicePrimaryCtxReset (hipDevice_t dev)
| Resets the primary context on the GPU. More...
hipError_t | hipDevicePrimaryCtxSetFlags (hipDevice_t dev, unsigned int flags)
| Set flags for the primary context. More...
hipError_t | hipModuleLoad (hipModule_t *module, const char *fname)
| Loads code object from file into a hipModule_t. More...
hipError_t | hipModuleUnload (hipModule_t module)
| Frees the module. More...
hipError_t | hipModuleGetFunction (hipFunction_t *function, hipModule_t module, const char *kname)
| Function with kname will be extracted if present in module. More...
hipError_t | hipFuncGetAttributes (struct hipFuncAttributes *attr, const void *func)
| Find out attributes for a given function. More...
hipError_t | hipFuncGetAttribute (int *value, hipFunction_attribute attrib, hipFunction_t hfunc)
| Find out a specific attribute for a given function. More...
hipError_t | hipModuleGetTexRef (textureReference **texRef, hipModule_t hmod, const char *name)
| returns the handle of the texture reference with the name from the module. More...
hipError_t | hipModuleLoadData (hipModule_t *module, const void *image)
| builds module from code object which resides in host memory. Image is pointer to that location. More...
hipError_t | hipModuleLoadDataEx (hipModule_t *module, const void *image, unsigned int numOptions, hipJitOption *options, void **optionValues)
| builds module from code object which resides in host memory. Image is pointer to that location. Options are not used. hipModuleLoadData is called. More...
hipError_t | hipModuleLaunchKernel (hipFunction_t f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, hipStream_t stream, void **kernelParams, void **extra)
| launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra More...
hipError_t | hipLaunchCooperativeKernel (const void *f, dim3 gridDim, dim3 blockDimX, void **kernelParams, unsigned int sharedMemBytes, hipStream_t stream)
| launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra, where thread blocks can cooperate and synchronize as they execute More...
hipError_t | hipLaunchCooperativeKernelMultiDevice (hipLaunchParams *launchParamsList, int numDevices, unsigned int flags)
| Launches kernels on multiple devices where thread blocks can cooperate and synchronize as they execute. More...
hipError_t | hipExtLaunchMultiKernelMultiDevice (hipLaunchParams *launchParamsList, int numDevices, unsigned int flags)
| Launches kernels on multiple devices and guarantees all specified kernels are dispatched on respective streams before enqueuing any other work on the specified streams from any other threads. More...
hipError_t | hipModuleOccupancyMaxPotentialBlockSize (int *gridSize, int *blockSize, hipFunction_t f, size_t dynSharedMemPerBlk, int blockSizeLimit)
| determine the grid and block sizes to achieves maximum occupancy for a kernel More...
hipError_t | hipModuleOccupancyMaxPotentialBlockSizeWithFlags (int *gridSize, int *blockSize, hipFunction_t f, size_t dynSharedMemPerBlk, int blockSizeLimit, unsigned int flags)
| determine the grid and block sizes to achieves maximum occupancy for a kernel More...
hipError_t | hipModuleOccupancyMaxActiveBlocksPerMultiprocessor (int *numBlocks, hipFunction_t f, int blockSize, size_t dynSharedMemPerBlk)
| Returns occupancy for a device function. More...
hipError_t | hipModuleOccupancyMaxActiveBlocksPerMultiprocessorWithFlags (int *numBlocks, hipFunction_t f, int blockSize, size_t dynSharedMemPerBlk, unsigned int flags)
| Returns occupancy for a device function. More...
hipError_t | hipOccupancyMaxActiveBlocksPerMultiprocessor (int *numBlocks, const void *f, int blockSize, size_t dynSharedMemPerBlk)
| Returns occupancy for a device function. More...
hipError_t | hipOccupancyMaxActiveBlocksPerMultiprocessorWithFlags (int *numBlocks, const void *f, int blockSize, size_t dynSharedMemPerBlk, unsigned int flags __dparm(hipOccupancyDefault))
| Returns occupancy for a device function. More...
hipError_t | hipOccupancyMaxPotentialBlockSize (int *gridSize, int *blockSize, const void *f, size_t dynSharedMemPerBlk, int blockSizeLimit)
| determine the grid and block sizes to achieves maximum occupancy for a kernel More...
hipError_t | hipProfilerStart ()
| Start recording of profiling information When using this API, start the profiler with profiling disabled. (–startdisabled) More...
hipError_t | hipProfilerStop ()
| Stop recording of profiling information. When using this API, start the profiler with profiling disabled. (–startdisabled) More...
hipError_t | hipConfigureCall (dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
| Configure a kernel launch. More...
hipError_t | hipSetupArgument (const void *arg, size_t size, size_t offset)
| Set a kernel argument. More...
hipError_t | hipLaunchByPtr (const void *func)
| Launch a kernel. More...
hipError_t | __hipPushCallConfiguration (dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
| Push configuration of a kernel launch. More...
hipError_t | __hipPopCallConfiguration (dim3 *gridDim, dim3 *blockDim, size_t *sharedMem, hipStream_t *stream)
| Pop configuration of a kernel launch. More...
hipError_t | hipLaunchKernel (const void *function_address, dim3 numBlocks, dim3 dimBlocks, void **args, size_t sharedMemBytes __dparm(0), hipStream_t stream __dparm(0))
| C compliant kernel launch API. More...
hipError_t | hipDrvMemcpy2DUnaligned (const hip_Memcpy2D *pCopy)
hipError_t | hipExtLaunchKernel (const void *function_address, dim3 numBlocks, dim3 dimBlocks, void **args, size_t sharedMemBytes, hipStream_t stream, hipEvent_t startEvent, hipEvent_t stopEvent, int flags)
| Launches kernel from the pointer address, with arguments and shared memory on stream. More...
hipError_t | hipBindTextureToMipmappedArray (const textureReference *tex, hipMipmappedArray_const_t mipmappedArray, const hipChannelFormatDesc *desc)
| Binds a mipmapped array to a texture. More...
hipError_t | hipGetTextureReference (const textureReference **texref, const void *symbol)
| Gets the texture reference related with the symbol. More...
hipError_t | hipCreateTextureObject (hipTextureObject_t *pTexObject, const hipResourceDesc *pResDesc, const hipTextureDesc *pTexDesc, const struct hipResourceViewDesc *pResViewDesc)
| Creates a texture object. More...
hipError_t | hipDestroyTextureObject (hipTextureObject_t textureObject)
| Destroys a texture object. More...
hipError_t | hipGetChannelDesc (hipChannelFormatDesc *desc, hipArray_const_t array)
| Gets the channel descriptor in an array. More...
hipError_t | hipGetTextureObjectResourceDesc (hipResourceDesc *pResDesc, hipTextureObject_t textureObject)
| Gets resource descriptor for the texture object. More...
hipError_t | hipGetTextureObjectResourceViewDesc (struct hipResourceViewDesc *pResViewDesc, hipTextureObject_t textureObject)
| Gets resource view descriptor for the texture object. More...
hipError_t | hipGetTextureObjectTextureDesc (hipTextureDesc *pTexDesc, hipTextureObject_t textureObject)
| Gets texture descriptor for the texture object. More...
hipError_t | hipTexRefSetAddressMode (textureReference *texRef, int dim, enum hipTextureAddressMode am)
hipError_t | hipTexRefSetArray (textureReference *tex, hipArray_const_t array, unsigned int flags)
hipError_t | hipTexRefSetFilterMode (textureReference *texRef, enum hipTextureFilterMode fm)
hipError_t | hipTexRefSetFlags (textureReference *texRef, unsigned int Flags)
hipError_t | hipTexRefSetFormat (textureReference *texRef, hipArray_Format fmt, int NumPackedComponents)
hipError_t | hipTexObjectCreate (hipTextureObject_t *pTexObject, const HIP_RESOURCE_DESC *pResDesc, const HIP_TEXTURE_DESC *pTexDesc, const HIP_RESOURCE_VIEW_DESC *pResViewDesc)
hipError_t | hipTexObjectDestroy (hipTextureObject_t texObject)
hipError_t | hipTexObjectGetResourceDesc (HIP_RESOURCE_DESC *pResDesc, hipTextureObject_t texObject)
hipError_t | hipTexObjectGetResourceViewDesc (HIP_RESOURCE_VIEW_DESC *pResViewDesc, hipTextureObject_t texObject)
hipError_t | hipTexObjectGetTextureDesc (HIP_TEXTURE_DESC *pTexDesc, hipTextureObject_t texObject)
hipError_t | hipBindTexture (size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t size __dparm(UINT_MAX))
hipError_t | hipBindTexture2D (size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t width, size_t height, size_t pitch)
hipError_t | hipBindTextureToArray (const textureReference *tex, hipArray_const_t array, const hipChannelFormatDesc *desc)
hipError_t | hipGetTextureAlignmentOffset (size_t *offset, const textureReference *texref)
hipError_t | hipUnbindTexture (const textureReference *tex)
hipError_t | hipTexRefGetAddress (hipDeviceptr_t *dev_ptr, const textureReference *texRef)
hipError_t | hipTexRefGetAddressMode (enum hipTextureAddressMode *pam, const textureReference *texRef, int dim)
hipError_t | hipTexRefGetFilterMode (enum hipTextureFilterMode *pfm, const textureReference *texRef)
hipError_t | hipTexRefGetFlags (unsigned int *pFlags, const textureReference *texRef)
hipError_t | hipTexRefGetFormat (hipArray_Format *pFormat, int *pNumChannels, const textureReference *texRef)
hipError_t | hipTexRefGetMaxAnisotropy (int *pmaxAnsio, const textureReference *texRef)
hipError_t | hipTexRefGetMipmapFilterMode (enum hipTextureFilterMode *pfm, const textureReference *texRef)
hipError_t | hipTexRefGetMipmapLevelBias (float *pbias, const textureReference *texRef)
hipError_t | hipTexRefGetMipmapLevelClamp (float *pminMipmapLevelClamp, float *pmaxMipmapLevelClamp, const textureReference *texRef)
hipError_t | hipTexRefGetMipMappedArray (hipMipmappedArray_t *pArray, const textureReference *texRef)
hipError_t | hipTexRefSetAddress (size_t *ByteOffset, textureReference *texRef, hipDeviceptr_t dptr, size_t bytes)
hipError_t | hipTexRefSetAddress2D (textureReference *texRef, const HIP_ARRAY_DESCRIPTOR *desc, hipDeviceptr_t dptr, size_t Pitch)
hipError_t | hipTexRefSetMaxAnisotropy (textureReference *texRef, unsigned int maxAniso)
hipError_t | hipTexRefSetBorderColor (textureReference *texRef, float *pBorderColor)
hipError_t | hipTexRefSetMipmapFilterMode (textureReference *texRef, enum hipTextureFilterMode fm)
hipError_t | hipTexRefSetMipmapLevelBias (textureReference *texRef, float bias)
hipError_t | hipTexRefSetMipmapLevelClamp (textureReference *texRef, float minMipMapLevelClamp, float maxMipMapLevelClamp)
hipError_t | hipTexRefSetMipmappedArray (textureReference *texRef, struct hipMipmappedArray *mipmappedArray, unsigned int Flags)
hipError_t | hipMipmappedArrayCreate (hipMipmappedArray_t *pHandle, HIP_ARRAY3D_DESCRIPTOR *pMipmappedArrayDesc, unsigned int numMipmapLevels)
hipError_t | hipMipmappedArrayDestroy (hipMipmappedArray_t hMipmappedArray)
hipError_t | hipMipmappedArrayGetLevel (hipArray_t *pLevelArray, hipMipmappedArray_t hMipMappedArray, unsigned int level)
hipError_t | hipRegisterApiCallback (uint32_t id, void *fun, void *arg)
hipError_t | hipRemoveApiCallback (uint32_t id)
hipError_t | hipRegisterActivityCallback (uint32_t id, void *fun, void *arg)
hipError_t | hipRemoveActivityCallback (uint32_t id)
const char * | hipApiName (uint32_t id)
const char * | hipKernelNameRef (const hipFunction_t f)
const char * | hipKernelNameRefByPtr (const void *hostFunction, hipStream_t stream)
int | hipGetStreamDeviceId (hipStream_t stream)
hipError_t | hipStreamBeginCapture (hipStream_t stream, hipStreamCaptureMode mode)
| Begins graph capture on a stream. More...
hipError_t | hipStreamEndCapture (hipStream_t stream, hipGraph_t *pGraph)
| Ends capture on a stream, returning the captured graph. More...
hipError_t | hipStreamGetCaptureInfo (hipStream_t stream, hipStreamCaptureStatus *pCaptureStatus, unsigned long long *pId)
| Get capture status of a stream. More...
hipError_t | hipStreamGetCaptureInfo_v2 (hipStream_t stream, hipStreamCaptureStatus *captureStatus_out, unsigned long long *id_out __dparm(0), hipGraph_t *graph_out __dparm(0), const hipGraphNode_t **dependencies_out __dparm(0), size_t *numDependencies_out __dparm(0))
| Get stream's capture state. More...
hipError_t | hipStreamIsCapturing (hipStream_t stream, hipStreamCaptureStatus *pCaptureStatus)
| Get stream's capture state. More...
hipError_t | hipStreamUpdateCaptureDependencies (hipStream_t stream, hipGraphNode_t *dependencies, size_t numDependencies, unsigned int flags __dparm(0))
| Update the set of dependencies in a capturing stream. More...
hipError_t | hipGraphCreate (hipGraph_t *pGraph, unsigned int flags)
| Creates a graph. More...
hipError_t | hipGraphDestroy (hipGraph_t graph)
| Destroys a graph. More...
hipError_t | hipGraphAddDependencies (hipGraph_t graph, const hipGraphNode_t *from, const hipGraphNode_t *to, size_t numDependencies)
| Adds dependency edges to a graph. More...
hipError_t | hipGraphRemoveDependencies (hipGraph_t graph, const hipGraphNode_t *from, const hipGraphNode_t *to, size_t numDependencies)
| Removes dependency edges from a graph. More...
hipError_t | hipGraphGetEdges (hipGraph_t graph, hipGraphNode_t *from, hipGraphNode_t *to, size_t *numEdges)
| Returns a graph's dependency edges. More...
hipError_t | hipGraphGetNodes (hipGraph_t graph, hipGraphNode_t *nodes, size_t *numNodes)
| Returns graph nodes. More...
hipError_t | hipGraphGetRootNodes (hipGraph_t graph, hipGraphNode_t *pRootNodes, size_t *pNumRootNodes)
| Returns graph's root nodes. More...
hipError_t | hipGraphNodeGetDependencies (hipGraphNode_t node, hipGraphNode_t *pDependencies, size_t *pNumDependencies)
| Returns a node's dependencies. More...
hipError_t | hipGraphNodeGetDependentNodes (hipGraphNode_t node, hipGraphNode_t *pDependentNodes, size_t *pNumDependentNodes)
| Returns a node's dependent nodes. More...
hipError_t | hipGraphNodeGetType (hipGraphNode_t node, hipGraphNodeType *pType)
| Returns a node's type. More...
hipError_t | hipGraphDestroyNode (hipGraphNode_t node)
| Remove a node from the graph. More...
hipError_t | hipGraphClone (hipGraph_t *pGraphClone, hipGraph_t originalGraph)
| Clones a graph. More...
hipError_t | hipGraphNodeFindInClone (hipGraphNode_t *pNode, hipGraphNode_t originalNode, hipGraph_t clonedGraph)
| Finds a cloned version of a node. More...
hipError_t | hipGraphInstantiate (hipGraphExec_t *pGraphExec, hipGraph_t graph, hipGraphNode_t *pErrorNode, char *pLogBuffer, size_t bufferSize)
| Creates an executable graph from a graph. More...
hipError_t | hipGraphInstantiateWithFlags (hipGraphExec_t *pGraphExec, hipGraph_t graph, unsigned long long flags)
| Creates an executable graph from a graph. More...
hipError_t | hipGraphLaunch (hipGraphExec_t graphExec, hipStream_t stream)
| launches an executable graph in a stream More...
hipError_t | hipGraphExecDestroy (hipGraphExec_t graphExec)
| Destroys an executable graph. More...
hipError_t | hipGraphExecUpdate (hipGraphExec_t hGraphExec, hipGraph_t hGraph, hipGraphNode_t *hErrorNode_out, hipGraphExecUpdateResult *updateResult_out)
| Check whether an executable graph can be updated with a graph and perform the update if * possible. More...
hipError_t | hipGraphAddKernelNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, const hipKernelNodeParams *pNodeParams)
| Creates a kernel execution node and adds it to a graph. More...
hipError_t | hipGraphKernelNodeGetParams (hipGraphNode_t node, hipKernelNodeParams *pNodeParams)
| Gets kernel node's parameters. More...
hipError_t | hipGraphKernelNodeSetParams (hipGraphNode_t node, const hipKernelNodeParams *pNodeParams)
| Sets a kernel node's parameters. More...
hipError_t | hipGraphExecKernelNodeSetParams (hipGraphExec_t hGraphExec, hipGraphNode_t node, const hipKernelNodeParams *pNodeParams)
| Sets the parameters for a kernel node in the given graphExec. More...
hipError_t | hipGraphAddMemcpyNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, const hipMemcpy3DParms *pCopyParams)
| Creates a memcpy node and adds it to a graph. More...
hipError_t | hipGraphMemcpyNodeGetParams (hipGraphNode_t node, hipMemcpy3DParms *pNodeParams)
| Gets a memcpy node's parameters. More...
hipError_t | hipGraphMemcpyNodeSetParams (hipGraphNode_t node, const hipMemcpy3DParms *pNodeParams)
| Sets a memcpy node's parameters. More...
hipError_t | hipGraphExecMemcpyNodeSetParams (hipGraphExec_t hGraphExec, hipGraphNode_t node, hipMemcpy3DParms *pNodeParams)
| Sets the parameters for a memcpy node in the given graphExec. More...
hipError_t | hipGraphAddMemcpyNode1D (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, void *dst, const void *src, size_t count, hipMemcpyKind kind)
| Creates a 1D memcpy node and adds it to a graph. More...
hipError_t | hipGraphMemcpyNodeSetParams1D (hipGraphNode_t node, void *dst, const void *src, size_t count, hipMemcpyKind kind)
| Sets a memcpy node's parameters to perform a 1-dimensional copy. More...
hipError_t | hipGraphExecMemcpyNodeSetParams1D (hipGraphExec_t hGraphExec, hipGraphNode_t node, void *dst, const void *src, size_t count, hipMemcpyKind kind)
| Sets the parameters for a memcpy node in the given graphExec to perform a 1-dimensional copy. More...
hipError_t | hipGraphAddMemcpyNodeFromSymbol (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, void *dst, const void *symbol, size_t count, size_t offset, hipMemcpyKind kind)
| Creates a memcpy node to copy from a symbol on the device and adds it to a graph. More...
hipError_t | hipGraphMemcpyNodeSetParamsFromSymbol (hipGraphNode_t node, void *dst, const void *symbol, size_t count, size_t offset, hipMemcpyKind kind)
| Sets a memcpy node's parameters to copy from a symbol on the device. More...
hipError_t | hipGraphExecMemcpyNodeSetParamsFromSymbol (hipGraphExec_t hGraphExec, hipGraphNode_t node, void *dst, const void *symbol, size_t count, size_t offset, hipMemcpyKind kind)
| Sets the parameters for a memcpy node in the given graphExec to copy from a symbol on the. More...
hipError_t | hipGraphAddMemcpyNodeToSymbol (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, const void *symbol, const void *src, size_t count, size_t offset, hipMemcpyKind kind)
| Creates a memcpy node to copy to a symbol on the device and adds it to a graph. More...
hipError_t | hipGraphMemcpyNodeSetParamsToSymbol (hipGraphNode_t node, const void *symbol, const void *src, size_t count, size_t offset, hipMemcpyKind kind)
| Sets a memcpy node's parameters to copy to a symbol on the device. More...
hipError_t | hipGraphExecMemcpyNodeSetParamsToSymbol (hipGraphExec_t hGraphExec, hipGraphNode_t node, const void *symbol, const void *src, size_t count, size_t offset, hipMemcpyKind kind)
| Sets the parameters for a memcpy node in the given graphExec to copy to a symbol on the device. More...
hipError_t | hipGraphAddMemsetNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, const hipMemsetParams *pMemsetParams)
| Creates a memset node and adds it to a graph. More...
hipError_t | hipGraphMemsetNodeGetParams (hipGraphNode_t node, hipMemsetParams *pNodeParams)
| Gets a memset node's parameters. More...
hipError_t | hipGraphMemsetNodeSetParams (hipGraphNode_t node, const hipMemsetParams *pNodeParams)
| Sets a memset node's parameters. More...
hipError_t | hipGraphExecMemsetNodeSetParams (hipGraphExec_t hGraphExec, hipGraphNode_t node, const hipMemsetParams *pNodeParams)
| Sets the parameters for a memset node in the given graphExec. More...
hipError_t | hipGraphAddHostNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, const hipHostNodeParams *pNodeParams)
| Creates a host execution node and adds it to a graph. More...
hipError_t | hipGraphHostNodeGetParams (hipGraphNode_t node, hipHostNodeParams *pNodeParams)
| Returns a host node's parameters. More...
hipError_t | hipGraphHostNodeSetParams (hipGraphNode_t node, const hipHostNodeParams *pNodeParams)
| Sets a host node's parameters. More...
hipError_t | hipGraphExecHostNodeSetParams (hipGraphExec_t hGraphExec, hipGraphNode_t node, const hipHostNodeParams *pNodeParams)
| Sets the parameters for a host node in the given graphExec. More...
hipError_t | hipGraphAddChildGraphNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, hipGraph_t childGraph)
| Creates a child graph node and adds it to a graph. More...
hipError_t | hipGraphChildGraphNodeGetGraph (hipGraphNode_t node, hipGraph_t *pGraph)
| Gets a handle to the embedded graph of a child graph node. More...
hipError_t | hipGraphExecChildGraphNodeSetParams (hipGraphExec_t hGraphExec, hipGraphNode_t node, hipGraph_t childGraph)
| Updates node parameters in the child graph node in the given graphExec. More...
hipError_t | hipGraphAddEmptyNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies)
| Creates an empty node and adds it to a graph. More...
hipError_t | hipGraphAddEventRecordNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, hipEvent_t event)
| Creates an event record node and adds it to a graph. More...
hipError_t | hipGraphEventRecordNodeGetEvent (hipGraphNode_t node, hipEvent_t *event_out)
| Returns the event associated with an event record node. More...
hipError_t | hipGraphEventRecordNodeSetEvent (hipGraphNode_t node, hipEvent_t event)
| Sets an event record node's event. More...
hipError_t | hipGraphExecEventRecordNodeSetEvent (hipGraphExec_t hGraphExec, hipGraphNode_t hNode, hipEvent_t event)
| Sets the event for an event record node in the given graphExec. More...
hipError_t | hipGraphAddEventWaitNode (hipGraphNode_t *pGraphNode, hipGraph_t graph, const hipGraphNode_t *pDependencies, size_t numDependencies, hipEvent_t event)
| Creates an event wait node and adds it to a graph. More...
hipError_t | hipGraphEventWaitNodeGetEvent (hipGraphNode_t node, hipEvent_t *event_out)
| Returns the event associated with an event wait node. More...
hipError_t | hipGraphEventWaitNodeSetEvent (hipGraphNode_t node, hipEvent_t event)
| Sets an event wait node's event. More...
hipError_t | hipGraphExecEventWaitNodeSetEvent (hipGraphExec_t hGraphExec, hipGraphNode_t hNode, hipEvent_t event)
| Sets the event for an event record node in the given graphExec. More...
hipError_t | hipGLGetDevices (unsigned int *pHipDeviceCount, int *pHipDevices, unsigned int hipDeviceCount, hipGLDeviceList deviceList)
hipError_t | hipGraphicsGLRegisterBuffer (hipGraphicsResource **resource, GLuint buffer, unsigned int flags)
hipError_t | hipGraphicsGLRegisterImage (hipGraphicsResource **resource, GLuint image, GLenum target, unsigned int flags)
hipError_t | hipGraphicsMapResources (int count, hipGraphicsResource_t *resources, hipStream_t stream __dparm(0))
hipError_t | hipGraphicsSubResourceGetMappedArray (hipArray_t *array, hipGraphicsResource_t resource, unsigned int arrayIndex, unsigned int mipLevel)
hipError_t | hipGraphicsResourceGetMappedPointer (void **devPtr, size_t *size, hipGraphicsResource_t resource)
hipError_t | hipGraphicsUnmapResources (int count, hipGraphicsResource_t *resources, hipStream_t stream __dparm(0))
hipError_t | hipGraphicsUnregisterResource (hipGraphicsResource_t resource)

## Variables
| hipSuccess = 0
| Successful completion.
| hipErrorInvalidValue = 1
| hipErrorOutOfMemory = 2
| hipErrorMemoryAllocation = 2
| Memory allocation error.
| hipErrorNotInitialized = 3
| hipErrorInitializationError = 3
| hipErrorDeinitialized = 4
| hipErrorProfilerDisabled = 5
| hipErrorProfilerNotInitialized = 6
| hipErrorProfilerAlreadyStarted = 7
| hipErrorProfilerAlreadyStopped = 8
| hipErrorInvalidConfiguration = 9
| hipErrorInvalidPitchValue = 12
| hipErrorInvalidSymbol = 13
| hipErrorInvalidDevicePointer = 17
| Invalid Device Pointer.
| hipErrorInvalidMemcpyDirection = 21
| Invalid memory copy direction.
| hipErrorInsufficientDriver = 35
| hipErrorMissingConfiguration = 52
| hipErrorPriorLaunchFailure = 53
| hipErrorInvalidDeviceFunction = 98
| hipErrorNoDevice = 100
| Call to hipGetDeviceCount returned 0 devices.
| hipErrorInvalidDevice = 101
| DeviceID must be in range 0...#compute-devices.
| hipErrorInvalidImage = 200
| hipErrorInvalidContext = 201
| Produced when input context is invalid.
| hipErrorContextAlreadyCurrent = 202
| hipErrorMapFailed = 205
| hipErrorMapBufferObjectFailed = 205
| Produced when the IPC memory attach failed from ROCr.
| hipErrorUnmapFailed = 206
| hipErrorArrayIsMapped = 207
| hipErrorAlreadyMapped = 208
| hipErrorNoBinaryForGpu = 209
| hipErrorAlreadyAcquired = 210
| hipErrorNotMapped = 211
| hipErrorNotMappedAsArray = 212
| hipErrorNotMappedAsPointer = 213
| hipErrorECCNotCorrectable = 214
| hipErrorUnsupportedLimit = 215
| hipErrorContextAlreadyInUse = 216
| hipErrorPeerAccessUnsupported = 217
| hipErrorInvalidKernelFile = 218
| In CUDA DRV, it is CUDA_ERROR_INVALID_PTX.
| hipErrorInvalidGraphicsContext = 219
| hipErrorInvalidSource = 300
| hipErrorFileNotFound = 301
| hipErrorSharedObjectSymbolNotFound = 302
| hipErrorSharedObjectInitFailed = 303
| hipErrorOperatingSystem = 304
| hipErrorInvalidHandle = 400
| hipErrorInvalidResourceHandle = 400
| Resource handle (hipEvent_t or hipStream_t) invalid.
| hipErrorIllegalState = 401
| Resource required is not in a valid state to perform operation.
| hipErrorNotFound = 500
| hipErrorNotReady = 600
| hipErrorIllegalAddress = 700
| hipErrorLaunchOutOfResources = 701
| Out of resources error.
| hipErrorLaunchTimeOut = 702
| hipErrorPeerAccessAlreadyEnabled
| Peer access was already enabled from the current device. More...
| hipErrorPeerAccessNotEnabled
| Peer access was never enabled from the current device. More...
| hipErrorSetOnActiveProcess = 708
| hipErrorContextIsDestroyed = 709
| hipErrorAssert = 710
| Produced when the kernel calls assert.
| hipErrorHostMemoryAlreadyRegistered
| Produced when trying to lock a page-locked memory. More...
| hipErrorHostMemoryNotRegistered
| Produced when trying to unlock a non-page-locked memory. More...
| hipErrorLaunchFailure
| An exception occurred on the device while executing a kernel. More...
| hipErrorCooperativeLaunchTooLarge
| hipErrorNotSupported = 801
| Produced when the hip API is not supported/implemented.
| hipErrorStreamCaptureUnsupported = 900
| hipErrorStreamCaptureInvalidated = 901
| hipErrorStreamCaptureMerge = 902
| hipErrorStreamCaptureUnmatched = 903
| The capture was not initiated in this stream.
| hipErrorStreamCaptureUnjoined = 904
| hipErrorStreamCaptureIsolation = 905
| hipErrorStreamCaptureImplicit = 906
| hipErrorCapturedEvent = 907
| hipErrorStreamCaptureWrongThread = 908
| hipErrorGraphExecUpdateFailure = 910
| hipErrorUnknown = 999
| hipErrorRuntimeMemory = 1052
| hipErrorRuntimeOther = 1053

## Detailed Description

Defines the API signatures for HIP runtime. This file can be compiled with a standard compiler.

## Typedef Documentation

## ◆ hipDeviceProp_t

typedef struct hipDeviceProp_t hipDeviceProp_t

hipDeviceProp

## ◆ hipMemoryType

typedef enum hipMemoryType hipMemoryType

Memory type (for pointer attributes)

## ◆ hipPointerAttribute_t

typedef struct hipPointerAttribute_t hipPointerAttribute_t

Pointer attributes

## Enumeration Type Documentation

## ◆ hipMemoryType

enum hipMemoryType

Memory type (for pointer attributes)

Enumerator
hipMemoryTypeHost | Memory is physically located on host.
hipMemoryTypeDevice | Memory is physically located on device. (see deviceId for specific device)
hipMemoryTypeArray | Array memory, physically located on device. (see deviceId for specific device)
hipMemoryTypeUnified | Not used currently.

## Variable Documentation

## ◆ hipErrorCapturedEvent

hipErrorCapturedEvent = 907

The operation is not permitted on an event which was last recorded in a capturing stream.

## ◆ hipErrorCooperativeLaunchTooLarge

hipErrorCooperativeLaunchTooLarge

Initial value:
=
720

This error indicates that the number of blocks launched per grid for a kernel that was launched via cooperative launch APIs exceeds the maximum number of allowed blocks for the current device

## ◆ hipErrorGraphExecUpdateFailure

hipErrorGraphExecUpdateFailure = 910

This error indicates that the graph update not performed because it included changes which violated constraintsspecific to instantiated graph update.

## ◆ hipErrorHostMemoryAlreadyRegistered

hipErrorHostMemoryAlreadyRegistered

Initial value:
=
712

Produced when trying to lock a page-locked memory.

## ◆ hipErrorHostMemoryNotRegistered

hipErrorHostMemoryNotRegistered

Initial value:
=
713

Produced when trying to unlock a non-page-locked memory.

## ◆ hipErrorInvalidValue

hipErrorInvalidValue = 1

One or more of the parameters passed to the API call is NULL or not in an acceptable range.

## ◆ hipErrorLaunchFailure

hipErrorLaunchFailure

Initial value:
=
719

An exception occurred on the device while executing a kernel.

## ◆ hipErrorNotReady

hipErrorNotReady = 600

Indicates that asynchronous operations enqueued earlier are not ready. This is not actually an error, but is used to distinguish from hipSuccess (which indicates completion). APIs that return this error include hipEventQuery and hipStreamQuery.

## ◆ hipErrorPeerAccessAlreadyEnabled

hipErrorPeerAccessAlreadyEnabled

Initial value:
=
704

Peer access was already enabled from the current device.

## ◆ hipErrorPeerAccessNotEnabled

hipErrorPeerAccessNotEnabled

Initial value:
=
705

Peer access was never enabled from the current device.

## ◆ hipErrorRuntimeMemory

hipErrorRuntimeMemory = 1052

HSA runtime memory call returned error. Typically not seen in production systems.

## ◆ hipErrorRuntimeOther

hipErrorRuntimeOther = 1053

HSA runtime call other than memory returned error. Typically not seen in production systems.

## ◆ hipErrorStreamCaptureImplicit

hipErrorStreamCaptureImplicit = 906

The operation would have resulted in a disallowed implicit dependency on a current capture sequence from hipStreamLegacy.

## ◆ hipErrorStreamCaptureInvalidated

hipErrorStreamCaptureInvalidated = 901

The current capture sequence on the stream has been invalidated due to a previous error.

## ◆ hipErrorStreamCaptureIsolation

hipErrorStreamCaptureIsolation = 905

A dependency would have been created which crosses the capture sequence boundary. Only implicit in-stream ordering dependencies are allowed to cross the boundary

## ◆ hipErrorStreamCaptureMerge

hipErrorStreamCaptureMerge = 902

The operation would have resulted in a merge of two independent capture sequences.

## ◆ hipErrorStreamCaptureUnjoined

hipErrorStreamCaptureUnjoined = 904

The capture sequence contains a fork that was not joined to the primary stream.

## ◆ hipErrorStreamCaptureUnsupported

hipErrorStreamCaptureUnsupported = 900

The operation is not permitted when the stream is capturing.

## ◆ hipErrorStreamCaptureWrongThread

hipErrorStreamCaptureWrongThread = 908

A stream capture sequence not initiated with the hipStreamCaptureModeRelaxed argument to hipStreamBeginCapture was passed to hipStreamEndCapture in a different thread.