README.md
1# Intel(R) C for Metal Runtime
2
3
4## Introduction
5
6cmrtlib is a runtime library needed when user wants to execute their own GPU kernels on render engine. It calls iHD media driver to load the kernels and allocate the resources. It provides a set of APIs for user to call directly from application.
7
8## License
9
10The Intel(R) C for Metal Runtime is distributed under the MIT license.
11You may obtain a copy of the License at:
12
13https://opensource.org/licenses/MIT
14
15## Building and Install
16
17cmrtlib is recommended to be built and installed together with media driver. Using the CMakeLists.txt in the root path will involve the building and installation of cmrtlib by default. Please refer to the readme in the root path. Besides, cmrtlib/CMakeLists.txt can also be used as an entry to build and install.
18For API usage, please refer to the cm_rt*.h headers installed.
19For application that uses this library, please refer to igfxcmrt.pc installed for the compiling and linking flags.
20
21## Backward compatibility
22
23cmrtlib maintains the backward compatibility in both API level and ABI level
24
25## Notes
26
27This cmrtlib library is a separate effort from a similar library (https://github.com/intel/cmrt). They may provide the same functionalities but this is not intended to replace the other. This cmrtlib works and is maintained to support the following platforms: https://github.com/intel/media-driver#supported-platforms.
28