HIP: Heterogenous-computing Interface for Portability
Modules | Classes | Typedefs | Enumerations
HIP API

Defines the HIP API. See the individual sections for more information. More...

Collaboration diagram for HIP API:

Modules

 Initialization and Version
 This section describes the initializtion and version functions of HIP runtime API.
 
 Device Management
 This section describes the device management functions of HIP runtime API.
 
 Execution Control
 This section describes the execution control functions of HIP runtime API.
 
 Error Handling
 This section describes the error handling functions of HIP runtime API.
 
 Stream Management
 This section describes the stream management functions of HIP runtime API. The following Stream APIs are not (yet) supported in HIP:
 
 Event Management
 This section describes the event management functions of HIP runtime API.
 
 Memory Management
 This section describes the memory management functions of HIP runtime API. The following CUDA APIs are not currently supported:
 
 PeerToPeer Device Memory Access
 
 Context Management
 This section describes the context management functions of HIP runtime API.
 
 Module Management
 This section describes the module management functions of HIP runtime API.
 
 Occupancy
 This section describes the occupancy functions of HIP runtime API.
 
 Profiler Control[Deprecated]
 This section describes the profiler control functions of HIP runtime API.
 
 Launch API to support the triple-chevron syntax
 This section describes the API to support the triple-chevron syntax.
 
 Texture Management
 This section describes the texture management functions of HIP runtime API.
 
 Runtime Compilation
 This section describes the runtime compilation functions of HIP runtime API.
 
 Callback Activity APIs
 This section describes the callback/Activity of HIP runtime API.
 
 Graph Management
 This section describes the graph management types & functions of HIP runtime API.
 
 Memory Management
 This section describes the virtual memory management functions of HIP runtime API.
 
 Interop
 This section describes Stream Memory Wait and Write functions of HIP runtime API.
 

Classes

struct  hipMemAllocationProp
 
struct  hipArrayMapInfo
 

Typedefs

typedef struct hipMemAllocationProp hipMemAllocationProp
 
typedef struct ihipMemGenericAllocationHandle * hipMemGenericAllocationHandle_t
 
typedef enum hipMemAllocationGranularity_flags hipMemAllocationGranularity_flags
 
typedef enum hipMemHandleType hipMemHandleType
 
typedef enum hipMemOperationType hipMemOperationType
 
typedef enum hipArraySparseSubresourceType hipArraySparseSubresourceType
 
typedef struct hipArrayMapInfo hipArrayMapInfo
 

Enumerations

enum  hipMemAllocationGranularity_flags { hipMemAllocationGranularityMinimum = 0x0, hipMemAllocationGranularityRecommended = 0x1 }
 
enum  hipMemHandleType { hipMemHandleTypeGeneric = 0x0 }
 
enum  hipMemOperationType { hipMemOperationTypeMap = 0x1, hipMemOperationTypeUnmap = 0x2 }
 
enum  hipArraySparseSubresourceType { hipArraySparseSubresourceTypeSparseLevel = 0x0, hipArraySparseSubresourceTypeMiptail = 0x1 }
 

Detailed Description

Defines the HIP API. See the individual sections for more information.

Typedef Documentation

◆ hipArrayMapInfo

Map info for arrays

◆ hipMemAllocationProp

Memory allocation properties

◆ hipMemGenericAllocationHandle_t

typedef struct ihipMemGenericAllocationHandle* hipMemGenericAllocationHandle_t

Generic handle for memory allocation

Enumeration Type Documentation

◆ hipArraySparseSubresourceType

Enumerator
hipArraySparseSubresourceTypeSparseLevel 

Sparse level.

hipArraySparseSubresourceTypeMiptail 

Miptail.

◆ hipMemAllocationGranularity_flags

Enumerator
hipMemAllocationGranularityMinimum 

Minimum granularity.

hipMemAllocationGranularityRecommended 

Recommended granularity for performance.

◆ hipMemHandleType

Enumerator
hipMemHandleTypeGeneric 

Generic handle type.

◆ hipMemOperationType

Enumerator
hipMemOperationTypeMap 

Map operation.

hipMemOperationTypeUnmap 

Unmap operation.