ROCm CMake build tools

Applies to Linux and Windows

2024-08-21

2 min read time

ROCm CMake build tools (also known as “rocm-cmake”) is a collection of functions that unify and simplify the CMake code of ROCm components, as well as ensuring consistency across these different components. The ROCm CMake build tools are used when building and developing many AMD ROCm libraries, but are not runtime dependencies for any libraries, packages or executables.

Important

ROCm CMake tools are not required when building or compiling an application that uses ROCm or HIP components.

The build tools can be included into a CMake project by running:

find_package(ROCmCMakeBuildTools)
# or
find_package(ROCM) # deprecated, but included for backwards compatibility

Once the tools have been included in this manner, individual files may be included by running include(<file_name>). The file names, the functions, variables, and macros accessible using each file are described in this documentation.

You can access the build tools on the ROCm CMake GitHub repository. For a complete listing of the features of ROCm CMake refer to Modules and functions.

To contribute to the documentation, refer to Contributing to ROCm.

You can find licensing information on the Licensing page.