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