diff --git a/projects/hip/include/hip/hip_runtime_api.h b/projects/hip/include/hip/hip_runtime_api.h index 8001bc341d..b2421c86ad 100644 --- a/projects/hip/include/hip/hip_runtime_api.h +++ b/projects/hip/include/hip/hip_runtime_api.h @@ -6399,8 +6399,22 @@ hipError_t hipGetDriverEntryPoint(const char* symbol, void** funcPtr, unsigned l */ hipError_t hipModuleGetTexRef(textureReference** texRef, hipModule_t hmod, const char* name); /** - * @brief builds module from code object which resides in host memory. Image is pointer to that - * location. + * @brief builds module from code object data which resides in host memory. + * + * The "image" is a pointer to the location of code object data. This data can be either + * a single code object or a fat binary (fatbin), which serves as the entry point for loading and + * launching device-specific kernel executions. + * + * By default, the following command generates a fatbin: + * + * "amdclang++ -O3 -c --offload-device-only --offload-arch= -o " + * + * For more details, refer to: + * + * Kernel Compilation in the HIP kernel language C++ support, or + * HIP runtime compilation (HIP RTC). * * @param [in] image The pointer to the location of data * @param [out] module Retuned module