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

hipMemPoolProps Struct Reference

hipMemPoolProps Struct Reference#

HIP Runtime API Reference: hipMemPoolProps Struct Reference
hipMemPoolProps Struct Reference

#include <hip_runtime_api.h>

Collaboration diagram for hipMemPoolProps:
[legend]

Data Fields

hipMemAllocationType allocType
 Allocation type. Currently must be specified as hipMemAllocationTypePinned. More...
 
hipMemAllocationHandleType handleTypes
 Handle types that will be supported by allocations from the pool. More...
 
hipMemLocation location
 Location where allocations should reside. More...
 
void * win32SecurityAttributes
 
size_t maxSize
 Maximum pool size. When set to 0, defaults to a system dependent value. More...
 
unsigned char reserved [56]
 Reserved for future use, must be 0. More...
 

Detailed Description

Specifies the properties of allocations made from the pool.

Field Documentation

◆ allocType

hipMemAllocationType hipMemPoolProps::allocType

Allocation type. Currently must be specified as hipMemAllocationTypePinned.

◆ handleTypes

hipMemAllocationHandleType hipMemPoolProps::handleTypes

Handle types that will be supported by allocations from the pool.

◆ location

hipMemLocation hipMemPoolProps::location

Location where allocations should reside.

◆ maxSize

size_t hipMemPoolProps::maxSize

Maximum pool size. When set to 0, defaults to a system dependent value.

◆ reserved

unsigned char hipMemPoolProps::reserved[56]

Reserved for future use, must be 0.

◆ win32SecurityAttributes

void* hipMemPoolProps::win32SecurityAttributes

Windows-specific LPSECURITYATTRIBUTES required when hipMemHandleTypeWin32 is specified


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