Merge pull request #283 from imirkin/master
[platform/upstream/VK-GL-CTS.git] / README.md
1 dEQP README
2 ===========
3
4 This repository contains a GPU testing suite called dEQP (drawElements Quality Program).
5 dEQP contains tests for several graphics APIs, including OpenGL ES, EGL, and Vulkan.
6
7 Documentation
8 -------------
9
10 Up-to-date documentation for dEQP is available at:
11
12 * [The VK-GL-CTS wiki for Khronos members](https://gitlab.khronos.org/Tracker/vk-gl-cts/wikis/home)
13 * [The VK-GL-CTS wiki for non-Khronos members](https://github.com/KhronosGroup/VK-GL-CTS/wiki)
14
15 The .qpa logs generated by the conformance tests may contain embedded PNG images of the results.
16 These can be viewed with `scripts/qpa_image_viewer.html`, by opening the file
17 with a web browser and following its instructions, or using the
18 [Cherry](https://android.googlesource.com/platform/external/cherry/+/master)
19 tool.
20
21 Khronos Vulkan Conformance Tests
22 --------------------------------
23
24 This repository includes Khronos Vulkan CTS under `external/vulkancts` directory.
25 For more information see [Vulkan CTS README](external/vulkancts/README.md).
26
27 Khronos OpenGL / OpenGL ES Conformance Tests
28 --------------------------------
29
30 This repository includes Khronos OpenGL / OpenGL ES CTS under `external/openglcts` directory.
31 For more information see [OpenGL / OpenGL ES CTS README](external/openglcts/README.md).
32
33 ANGLE for Android
34 --------------------------------
35
36 ANGLE can be built for Android by following the instructions
37 [here](https://chromium.googlesource.com/angle/angle.git/+/HEAD/doc/DevSetup.md#building-angle-for-android).
38
39 The resulting ANGLE shared object libraries can be linked against and embedded into `dEQP.apk` with
40 the `--angle-path` option.   This will cause `dEQP.apk` to use the ANGLE libraries for OpenGL ES
41 calls, rather than the native drivers.
42
43 An ABI must be specified and the directory structure containing the ANGLE shared objects must match
44 it so the build system can find the correct `*.so` files.
45
46 Assuming ANGLE shared objects are generated into `~/chromium/src/out/Release/` and `dEQP.apk` will
47 be generated with `--abis arm64-v8a`, issue the following commands:
48
49         cd ~/chromium/src/out/Release/
50         mkdir arm64-v8a && cd arm64-v8a
51         cp ../lib*_angle.so .
52
53 The `--angle-path ~/chromium/src/out/Release/` option can then be used to link against and embed the
54 ANGLE shared object files.   The full command would be:
55
56         python scripts/android/build_apk.py --sdk <path to Android SDK> --ndk <path to Android NDK> --abis arm64-v8a --angle-path ~/chromium/src/out/Release/