README.md

   1 # SwiftShader\r
   2 \r
   3 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build Status](https://travis-ci.org/google/swiftshader.svg?branch=master)](https://travis-ci.org/google/swiftshader) [![Build status](https://ci.appveyor.com/api/projects/status/yrmyvb34j22jg1uj?svg=true)](https://ci.appveyor.com/project/c0d1f1ed/swiftshader)\r
   4 \r
   5 Introduction\r
   6 ------------\r
   7 \r
   8 SwiftShader is a high-performance CPU-based implementation of the OpenGL ES and Direct3D 9 graphics APIs<sup>1</sup><sup>2</sup>. Its goal is to provide hardware independence for advanced 3D graphics.\r
   9 \r
  10 Building\r
  11 --------\r
  12 \r
  13 SwiftShader libraries can be built for Windows, Linux, and Mac OS X.\\r
  14 Android and Chrome (OS) build environments are also supported.\r
  15 \r
  16 * **Visual Studio**\r
  17 \\r
  18   On Windows, open the [SwiftShader.sln](SwiftShader.sln) file using [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) or compatible version, and build the solution. Output DLLs will be placed in the _out_ subfolder. Sample executables such as _OGLES3ColourGrading_ can be found under the Tests solution folder and can be run from the IDE.\r
  19 \r
  20 * **CMake**\r
  21 \r
  22   [Install CMake](https://cmake.org/download/) for Linux, Mac OS X, or Windows and use either [the IDE](https://cmake.org/runningcmake/) or run the following terminal commands:\r
  23 \r
  24       cd build\r
  25       cmake ..\r
  26       make --jobs=8\r
  27 \r
  28       ./unittests\r
  29       ./OGLES2HelloAPI\r
  30 \r
  31 Usage\r
  32 -----\r
  33 \r
  34 The SwiftShader libraries act as drop-in replacements for graphics drivers.\r
  35 \r
  36 On Windows, most applications can be made to use SwiftShader's DLLs by placing them in the same folder as the executable. On Linux, the LD\_LIBRARY\_PATH environment variable or -rpath linker option can be used to direct applications to search for shared libraries in the indicated directory first.\r
  37 \r
  38 Contributing\r
  39 ------------\r
  40 \r
  41 See [CONTRIBUTING.txt](CONTRIBUTING.txt) for important contributing requirements.\r
  42 \r
  43 The canonical repository for SwiftShader is hosted at:\r
  44 https://swiftshader.googlesource.com/SwiftShader\r
  45 \r
  46 All changes must be reviewed and approved in the [Gerrit](https://www.gerritcodereview.com/) review tool at:\r
  47 https://swiftshader-review.googlesource.com\r
  48 \r
  49 Authenticate your account here:\r
  50 https://swiftshader-review.googlesource.com/new-password\r
  51 \r
  52 All changes require a [Change-ID](https://gerrit-review.googlesource.com/Documentation/user-changeid.html) tag in the commit message. A commit hook may be used to add this tag automatically, and can be found at:\r
  53 https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go:\r
  54 \r
  55     git clone https://swiftshader.googlesource.com/SwiftShader && (cd SwiftShader && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)\r
  56 \r
  57 Changes are uploaded to Gerrit by executing:\r
  58 \r
  59     git push origin HEAD:refs/for/master\r
  60 \r
  61 Testing\r
  62 -------\r
  63 \r
  64 SwiftShader's OpenGL ES implementation can be tested using the [dEQP](https://source.android.com/devices/graphics/testing) test suite.\r
  65 \r
  66 See [docs/dEQP.md](docs/dEQP.md) for details.\r
  67 \r
  68 Third-Party Dependencies\r
  69 ------------------------\r
  70 \r
  71 The [third_party](third_party/) directory contains projects which originated outside of SwiftShader:\r
  72 \r
  73 [LLVM](third_party/LLVM/) contains an outdated and diverged copy of the [LLVM](http://llvm.org/) compiler framework. Until further notice, maintenance fixes can be made directly in the SwiftShader repository.\r
  74 \r
  75 [subzero](third_party/subzero/) contains a fork of the [Subzero](https://chromium.googlesource.com/native_client/pnacl-subzero/) project. It is part of Google Chrome's (Portable) [Native Client](https://developer.chrome.com/native-client) project. Its authoritative source is at [https://chromium.googlesource.com/native_client/pnacl-subzero/](https://chromium.googlesource.com/native_client/pnacl-subzero/). The fork was made using [git-subtree](https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt) to include all of Subzero's history, and until further notice it should **not** diverge from the upstream project. Contributions must be tested using the [README](third_party/subzero/docs/README.rst) instructions, reviewed at [https://chromium-review.googlesource.com](https://chromium-review.googlesource.com/q/project:native_client%252Fpnacl-subzero), and then pulled into the SwiftShader repository.\r
  76 \r
  77 [llvm-subzero](third_party/llvm-subzero/) contains a minimized set of LLVM dependencies of the Subzero project.\r
  78 \r
  79 [PowerVR_SDK](third_party/PowerVR_SDK/) contains a subset of the [PowerVR Graphics Native SDK](https://github.com/powervr-graphics/Native_SDK) for running several sample applications.\r
  80 \r
  81 [googletest](third_party/googletest/) contains the [Google Test](https://github.com/google/googletest) project, as a Git submodule. It is used for running unit tests for Chromium, and Reactor unit tests. Run `git submodule update --init` to obtain/update the code. Any contributions should be made upstream.\r
  82 \r
  83 Documentation\r
  84 -------------\r
  85 \r
  86 See [docs/Index.md](docs/Index.md).\r
  87 \r
  88 Contact\r
  89 -------\r
  90 \r
  91 Public mailing list: [swiftshader@googlegroups.com](https://groups.google.com/forum/#!forum/swiftshader)\r
  92 \r
  93 General bug tracker:  https://g.co/swiftshaderbugs\\r
  94 Chrome specific bugs: https://bugs.chromium.org/p/swiftshader\r
  95 \r
  96 License\r
  97 -------\r
  98 \r
  99 The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in [LICENSE.txt](LICENSE.txt).\r
 100 \r
 101 Files in the third_party folder are subject to their respective license.\r
 102 \r
 103 Authors and Contributors\r
 104 ------------------------\r
 105 \r
 106 The legal authors for copyright purposes are listed in [AUTHORS.txt](AUTHORS.txt).\r
 107 \r
 108 [CONTRIBUTORS.txt](CONTRIBUTORS.txt) contains a list of names of individuals who have contributed to SwiftShader. If you're not on the list, but you've signed the [Google CLA](https://cla.developers.google.com/clas) and have contributed more than a formatting change, feel free to request to be added.\r
 109 \r
 110 Disclaimer\r
 111 ----------\r
 112 \r
 113 1. Trademarks are the property of their respective owners.\r
 114 2. We do not claim official conformance with any graphics APIs at this moment.\r
 115 3. This is not an official Google product.\r