README.md

   1 SwiftShader\r
   2 ==========\r
   3 \r
   4 Introduction\r
   5 -----------------\r
   6 \r
   7 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
   8 \r
   9 Usage\r
  10 --------\r
  11 \r
  12 The SwiftShader libraries act as drop-in replacements for graphics drivers.\r
  13 \r
  14 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
  15 \r
  16 Prebuilt binaries can be found at: https://goo.gl/5MOcdb\r
  17 \r
  18 Contributing\r
  19 -----------------\r
  20 \r
  21 See [CONTRIBUTING.txt](CONTRIBUTING.txt) for important contributing requirements.\r
  22 \r
  23 The canonical repository for SwiftShader is hosted at:\r
  24 https://swiftshader.googlesource.com/SwiftShader\r
  25 \r
  26 All changes must be reviewed and approved in the [Gerrit](https://www.gerritcodereview.com/) review tool at:\r
  27 https://swiftshader-review.googlesource.com\r
  28 \r
  29 Authenticate your account here:\r
  30 https://swiftshader-review.googlesource.com/new-password\r
  31 \r
  32 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
  33 https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go: \r
  34 \r
  35     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
  36 \r
  37 Changes are uploaded to Gerrit by performing:\r
  38 \r
  39     git push origin HEAD:refs/for/master\r
  40 \r
  41 Documentation\r
  42 -------------\r
  43 \r
  44 See [docs/Index.md](docs/Index.md).\r
  45 \r
  46 Contact\r
  47 -----------\r
  48 \r
  49 Public mailing list: [swiftshader@googlegroups.com](https://groups.google.com/forum/#!forum/swiftshader)\r
  50 \r
  51 Bug tracker: https://bugs.chromium.org/p/swiftshader\r
  52 \r
  53 License\r
  54 ----------\r
  55 \r
  56 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
  57 \r
  58 Files in the third_party folder are subject to their respective license.\r
  59 \r
  60 Authors and Contributors\r
  61 -----------------------------------\r
  62 \r
  63 The legal authors for copyright purposes are listed in [AUTHORS.txt](AUTHORS.txt).\r
  64 \r
  65 [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
  66 \r
  67 Disclaimer\r
  68 ---------------\r
  69 \r
  70 1. Trademarks are the property of their respective owners.\r
  71 2. We do not claim official conformance with any graphics APIs at this moment.\r
  72 3. This is not an official Google product.