HIP API

HIP API#

HIP Runtime API Reference: HIP API
Modules | Functions | Variables
HIP API
Collaboration diagram for HIP API:

Modules

 Initialization and Version
 
 Device Management
 
 Execution Control
 
 Error Handling
 
 Stream Management
 
 Stream Memory Operations
 
 Event Management
 
 Memory Management
 
 PeerToPeer Device Memory Access
 
 Context Management [Deprecated]
 
 Module Management
 
 Occupancy
 
 Profiler Control [Deprecated]
 
 Launch API to support the triple-chevron syntax
 
 Texture Management
 
 Runtime Compilation
 
 Callback Activity APIs
 
 Graph Management
 
 Virtual Memory Management
 
 Graphics Interoperability
 
 Surface Object
 
 OpenGL Interoperability
 
 Cooperative Groups
 

Functions

hipError_t hipExtEnableLogging ()
 Enable HIP runtime logging.
 
hipError_t hipExtDisableLogging ()
 Disable HIP runtime logging.
 
hipError_t hipExtSetLoggingParams (size_t log_level, size_t log_size, size_t log_mask)
 Set HIP runtime logging parameters.
 
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode HIP_DEPRECATED (HIP_DEPRECATED_MSG) static inline hipError_t hipBindTexture(size_t *offset
 
 return (err==hipSuccess) ? hipBindTextureToArray(&tex
 
 if (err !=hipSuccess)
 

Variables

const struct texture< T, dim, readMode > & tex
 
const struct texture< T, dim, readMode > const void * devPtr
 
const struct texture< T, dim, readMode > const void size_t size
 
const struct texture< T, dim, readMode > const void size_t int dim
 
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc & desc
 
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t width
 
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t size_t height
 
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t size_t size_t pitch
 
readMode hipArray_const_t array
 
hipError_t err = hipGetChannelDesc(&desc, array)
 
readMode hipMipmappedArray_const_t mipmappedArray
 
hipArray_t levelArray
 

Detailed Description

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

Function Documentation

◆ HIP_DEPRECATED()

const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode HIP_DEPRECATED ( HIP_DEPRECATED_MSG  )

◆ hipExtDisableLogging()

hipError_t hipExtDisableLogging ( )

Disable HIP runtime logging.

This function disables the HIP runtime logging mechanism, stopping the capture of diagnostic and trace information during HIP API execution.

Returns
hipSuccess
See also
hipExtEnableLogging, hipExtSetLoggingParams

◆ hipExtEnableLogging()

hipError_t hipExtEnableLogging ( )

Enable HIP runtime logging.

This function enables the HIP runtime logging mechanism, allowing diagnostic and trace information to be captured during HIP API execution.

Returns
hipSuccess
See also
hipExtDisableLogging, hipExtSetLoggingParams

◆ hipExtSetLoggingParams()

hipError_t hipExtSetLoggingParams ( size_t  log_level,
size_t  log_size,
size_t  log_mask 
)

Set HIP runtime logging parameters.

This function configures the logging behavior of the HIP runtime, including the verbosity level, buffer size, and which components to log.

Parameters
[in]log_levelThe logging verbosity level. Higher values produce more detailed output.
[in]log_sizeReserved for future use. Currently not implemented.
[in]log_maskA bitmask specifying which HIP runtime components to log.
Returns
hipSuccess, hipErrorInvalidValue
See also
hipExtEnableLogging, hipExtDisableLogging

◆ if()

if ( err !  = hipSuccess)

◆ return()

return ( err  = = hipSuccess) &

Variable Documentation

◆ array

readMode hipArray_const_t array
Initial value:
{
struct hipChannelFormatDesc desc
desc
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc & desc
Definition hip_runtime_api.h:10087
hipChannelFormatDesc
Definition driver_types.h:59

◆ desc

readMode hipMipmappedArray_const_t const struct hipChannelFormatDesc & desc
Initial value:
{
return hipBindTextureToArray(&tex, array, &desc)
tex
const struct texture< T, dim, readMode > & tex
Definition hip_runtime_api.h:10066
array
readMode hipArray_const_t array
Definition hip_runtime_api.h:10147
hipBindTextureToArray
hipError_t hipBindTextureToArray(const textureReference *tex, hipArray_const_t array, const hipChannelFormatDesc *desc)
Binds a memory area to a texture [Deprecated].

◆ devPtr

const struct texture< T, dim, readMode > const void * devPtr

◆ dim

const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int dim

◆ err

hipError_t err = hipGetChannelDesc(&desc, array)

◆ height

const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t size_t height

◆ levelArray

hipArray_t levelArray

◆ mipmappedArray

readMode hipMipmappedArray_const_t mipmappedArray
Initial value:
{
struct hipChannelFormatDesc desc

◆ pitch

const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t size_t size_t pitch
Initial value:
{
return hipBindTexture2D(offset, &tex, devPtr, &tex.channelDesc, width, height, pitch)
pitch
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t size_t size_t pitch
Definition hip_runtime_api.h:10108
height
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t size_t height
Definition hip_runtime_api.h:10108
devPtr
const struct texture< T, dim, readMode > const void * devPtr
Definition hip_runtime_api.h:10067
width
const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void size_t width
Definition hip_runtime_api.h:10108
hipBindTexture2D
hipError_t hipBindTexture2D(size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t width, size_t height, size_t pitch)
Binds a 2D memory area to a texture [Deprecated].

◆ size

const struct texture< T, dim, readMode > const void size_t int enum hipTextureReadMode readMode const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t size
Initial value:
= UINT_MAX) {
return hipBindTexture(offset, &tex, devPtr, &tex.channelDesc, size);
}
template <class T
size
const struct texture< T, dim, readMode > const void size_t size
Definition hip_runtime_api.h:10067
hipBindTexture
hipError_t hipBindTexture(size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t size)
Binds a memory area to a texture [Deprecated].

◆ tex

readMode & tex
Initial value:
{
return hipUnbindTexture(&tex)
hipUnbindTexture
hipError_t hipUnbindTexture(const textureReference *tex)
Unbinds a texture [Deprecated].

◆ width

const struct texture< T, dim, readMode > const void const struct hipChannelFormatDesc size_t width