xref: /aosp_15_r20/external/intel-media-driver/cmrtlib/README.md (revision ba62d9d3abf0e404f2022b4cd7a85e107f48596f)
1*ba62d9d3SAndroid Build Coastguard Worker# Intel(R) C for Metal Runtime
2*ba62d9d3SAndroid Build Coastguard Worker
3*ba62d9d3SAndroid Build Coastguard Worker
4*ba62d9d3SAndroid Build Coastguard Worker## Introduction
5*ba62d9d3SAndroid Build Coastguard Worker
6*ba62d9d3SAndroid Build Coastguard Workercmrtlib 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*ba62d9d3SAndroid Build Coastguard Worker
8*ba62d9d3SAndroid Build Coastguard Worker## License
9*ba62d9d3SAndroid Build Coastguard Worker
10*ba62d9d3SAndroid Build Coastguard WorkerThe Intel(R) C for Metal Runtime is distributed under the MIT license.
11*ba62d9d3SAndroid Build Coastguard WorkerYou may obtain a copy of the License at:
12*ba62d9d3SAndroid Build Coastguard Worker
13*ba62d9d3SAndroid Build Coastguard Workerhttps://opensource.org/licenses/MIT
14*ba62d9d3SAndroid Build Coastguard Worker
15*ba62d9d3SAndroid Build Coastguard Worker## Building and Install
16*ba62d9d3SAndroid Build Coastguard Worker
17*ba62d9d3SAndroid Build Coastguard Workercmrtlib 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.
18*ba62d9d3SAndroid Build Coastguard WorkerFor API usage, please refer to the cm_rt*.h headers installed.
19*ba62d9d3SAndroid Build Coastguard WorkerFor application that uses this library, please refer to igfxcmrt.pc installed for the compiling and linking flags.
20*ba62d9d3SAndroid Build Coastguard Worker
21*ba62d9d3SAndroid Build Coastguard Worker## Backward compatibility
22*ba62d9d3SAndroid Build Coastguard Worker
23*ba62d9d3SAndroid Build Coastguard Workercmrtlib maintains the backward compatibility in both API level and ABI level
24*ba62d9d3SAndroid Build Coastguard Worker
25*ba62d9d3SAndroid Build Coastguard Worker## Notes
26*ba62d9d3SAndroid Build Coastguard Worker
27*ba62d9d3SAndroid Build Coastguard WorkerThis 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