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

hipFunctionLaunchParams Struct Reference

hipFunctionLaunchParams Struct Reference#

HIP Runtime API Reference: hipFunctionLaunchParams Struct Reference
hipFunctionLaunchParams Struct Reference

#include <hip_runtime_api.h>

Data Fields

hipFunction_t function
 Kernel to launch. More...
 
unsigned int gridDimX
 Width(X) of grid in blocks. More...
 
unsigned int gridDimY
 Height(Y) of grid in blocks. More...
 
unsigned int gridDimZ
 Depth(Z) of grid in blocks. More...
 
unsigned int blockDimX
 X dimension of each thread block. More...
 
unsigned int blockDimY
 Y dimension of each thread block. More...
 
unsigned int blockDimZ
 Z dimension of each thread block. More...
 
unsigned int sharedMemBytes
 Shared memory. More...
 
hipStream_t hStream
 Stream identifier. More...
 
void ** kernelParams
 Kernel parameters. More...
 

Detailed Description

struct hipFunctionLaunchParams_t

Field Documentation

◆ blockDimX

unsigned int hipFunctionLaunchParams::blockDimX

X dimension of each thread block.

◆ blockDimY

unsigned int hipFunctionLaunchParams::blockDimY

Y dimension of each thread block.

◆ blockDimZ

unsigned int hipFunctionLaunchParams::blockDimZ

Z dimension of each thread block.

◆ function

hipFunction_t hipFunctionLaunchParams::function

Kernel to launch.

◆ gridDimX

unsigned int hipFunctionLaunchParams::gridDimX

Width(X) of grid in blocks.

◆ gridDimY

unsigned int hipFunctionLaunchParams::gridDimY

Height(Y) of grid in blocks.

◆ gridDimZ

unsigned int hipFunctionLaunchParams::gridDimZ

Depth(Z) of grid in blocks.

◆ hStream

hipStream_t hipFunctionLaunchParams::hStream

Stream identifier.

◆ kernelParams

void** hipFunctionLaunchParams::kernelParams

Kernel parameters.

◆ sharedMemBytes

unsigned int hipFunctionLaunchParams::sharedMemBytes

Shared memory.


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