| 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 |
|
| 16 | Contributing
|
| 17 | -----------------
|
| 18 |
|
| 19 | See CONTRIBUTING.txt for important contributing requirements.
|
| 20 |
|
| 21 | The canonical repository for SwiftShader is hosted at
|
| 22 | https://swiftshader.googlesource.com/SwiftShader
|
| 23 |
|
| 24 | All changes must be reviewed and approved in the Gerrit review tool at
|
| 25 | https://swiftshader-review.googlesource.com
|
| 26 |
|
| 27 | All changes require a Change-ID tag in the commit message. A commit hook may be used to add this tag automatically, and can be found at:
|
| 28 | https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go:
|
| 29 |
|
| 30 | 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)
|
| 31 |
|
| 32 | Changes are uploaded to Gerrit by performing
|
| 33 |
|
| 34 | git push origin HEAD:refs/for/master
|
| 35 |
|
| 36 | Contact
|
| 37 | -----------
|
| 38 |
|
| 39 | Public mailing list: swiftshader@googlegroups.com
|
| 40 |
|
| 41 | License
|
| 42 | ----------
|
| 43 |
|
| 44 | The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in LICENSE.txt.
|
| 45 |
|
| 46 | Files in the third_party folder are subject to their respective license.
|
| 47 |
|
| 48 | Authors and Contributors
|
| 49 | -----------------------------------
|
| 50 |
|
| 51 | The legal authors for copyright purposes are listed in AUTHORS.txt.
|
| 52 |
|
| 53 | 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 and have contributed more than a formatting change, feel free to request to be added.
|
| 54 |
|
| 55 | Disclaimer
|
| 56 | ---------------
|
| 57 |
|
| 58 | 1. Trademarks are the property of their respective owners.
|
| 59 | 2. We do not claim official conformance with any graphics APIs at this moment.
|
| 60 | 3. This is not an official Google product. |
