This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipArrayMapInfo Struct Reference

hipArrayMapInfo Struct Reference#

HIP Runtime API Reference: hipArrayMapInfo Struct Reference
hipArrayMapInfo Struct Reference

#include <hip_runtime_api.h>

Collaboration diagram for hipArrayMapInfo:
[legend]

Data Fields

hipResourceType resourceType
 Resource type. More...
 
union {
   hipMipmappedArray   mipmap
 
   hipArray_t   array
 
resource
 
hipArraySparseSubresourceType subresourceType
 Sparse subresource type. More...
 
union {
   struct {
      unsigned int   level
 For mipmapped arrays must be a valid mipmap level. For arrays must be zero. More...
 
      unsigned int   layer
 For layered arrays must be a valid layer index. Otherwise, must be zero. More...
 
      unsigned int   offsetX
 X offset in elements. More...
 
      unsigned int   offsetY
 Y offset in elements. More...
 
      unsigned int   offsetZ
 Z offset in elements. More...
 
      unsigned int   extentWidth
 Width in elements. More...
 
      unsigned int   extentHeight
 Height in elements. More...
 
      unsigned int   extentDepth
 Depth in elements. More...
 
   }   sparseLevel
 
   struct {
      unsigned int   layer
 For layered arrays must be a valid layer index. Otherwise, must be zero. More...
 
      unsigned long long   offset
 Offset within mip tail. More...
 
      unsigned long long   size
 Extent in bytes. More...
 
   }   miptail
 
subresource
 
hipMemOperationType memOperationType
 Memory operation type. More...
 
hipMemHandleType memHandleType
 Memory handle type. More...
 
union {
   hipMemGenericAllocationHandle_t   memHandle
 
memHandle
 
unsigned int deviceBitMask
 Device ordinal bit mask. More...
 
unsigned int flags
 flags for future use, must be zero now. More...
 
unsigned int reserved [2]
 Reserved for future use, must be zero now. More...
 

Detailed Description

Map info for arrays

Field Documentation

◆ array

hipArray_t hipArrayMapInfo::array

◆ deviceBitMask

unsigned int hipArrayMapInfo::deviceBitMask

Device ordinal bit mask.

◆ extentDepth

unsigned int hipArrayMapInfo::extentDepth

Depth in elements.

◆ extentHeight

unsigned int hipArrayMapInfo::extentHeight

Height in elements.

◆ extentWidth

unsigned int hipArrayMapInfo::extentWidth

Width in elements.

◆ flags

unsigned int hipArrayMapInfo::flags

flags for future use, must be zero now.

◆ layer

unsigned int hipArrayMapInfo::layer

For layered arrays must be a valid layer index. Otherwise, must be zero.

◆ level

unsigned int hipArrayMapInfo::level

For mipmapped arrays must be a valid mipmap level. For arrays must be zero.

◆ memHandle [1/2]

hipMemGenericAllocationHandle_t hipArrayMapInfo::memHandle

◆  [2/2]

union { ... } hipArrayMapInfo::memHandle

◆ memHandleType

hipMemHandleType hipArrayMapInfo::memHandleType

Memory handle type.

◆ memOperationType

hipMemOperationType hipArrayMapInfo::memOperationType

Memory operation type.

◆ mipmap

hipMipmappedArray hipArrayMapInfo::mipmap

◆ 

struct { ... } hipArrayMapInfo::miptail

◆ offset

unsigned long long hipArrayMapInfo::offset

Offset within mip tail.

Offset within the memory.

◆ offsetX

unsigned int hipArrayMapInfo::offsetX

X offset in elements.

◆ offsetY

unsigned int hipArrayMapInfo::offsetY

Y offset in elements.

◆ offsetZ

unsigned int hipArrayMapInfo::offsetZ

Z offset in elements.

◆ reserved

unsigned int hipArrayMapInfo::reserved[2]

Reserved for future use, must be zero now.

◆ 

union { ... } hipArrayMapInfo::resource

◆ resourceType

hipResourceType hipArrayMapInfo::resourceType

Resource type.

◆ size

unsigned long long hipArrayMapInfo::size

Extent in bytes.

◆ 

struct { ... } hipArrayMapInfo::sparseLevel

◆ 

union { ... } hipArrayMapInfo::subresource

◆ subresourceType

hipArraySparseSubresourceType hipArrayMapInfo::subresourceType

Sparse subresource type.


The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/develop/include/hip/hip_runtime_api.h