Blame - README.md - SwiftShader

blob: 8cfa3481797eefae42b66489ad4043a1b7599b2e [file] [log] [blame] [view]

Nicolas Capens	a5eaa8d	2017-07-26 13:55:52 -0400	[diff] [blame]	1	# SwiftShader
Nicolas Capens	c9d61ae	2017-06-28 00:58:48 -0400	[diff] [blame]	2
Nicolas Capens	a5eaa8d	2017-07-26 13:55:52 -0400	[diff] [blame]	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)
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	4
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	5	Introduction
				6	------------
				7
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	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.
				9
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	10	Building
				11	--------
				12
Ben Clayton	e2d8b12	2019-02-07 18:13:16 +0000	[diff] [blame]	13	SwiftShader libraries can be built for Windows, Linux, and Mac OS X.\
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	14	Android and Chrome (OS) build environments are also supported.
				15
				16	* Visual Studio
Ben Clayton	e2d8b12	2019-02-07 18:13:16 +0000	[diff] [blame]	17	\
Nicolas Capens	64d537a	2018-10-02 12:40:12 -0400	[diff] [blame]	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.
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	19
				20	* CMake
				21
				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:
				23
Ben Clayton	e2d8b12	2019-02-07 18:13:16 +0000	[diff] [blame]	24	cd build
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	25	cmake ..
				26	make --jobs=8
				27
Nicolas Capens	64d537a	2018-10-02 12:40:12 -0400	[diff] [blame]	28	./unittests
				29	./OGLES2HelloAPI
				30
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	31	Usage
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	32	-----
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	33
				34	The SwiftShader libraries act as drop-in replacements for graphics drivers.
				35
				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.
				37
				38	Contributing
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	39	------------
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	40
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	41	See [CONTRIBUTING.txt](CONTRIBUTING.txt) for important contributing requirements.
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	42
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	43	The canonical repository for SwiftShader is hosted at:
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	44	https://swiftshader.googlesource.com/SwiftShader
				45
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	46	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]	47	https://swiftshader-review.googlesource.com
				48
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	49	Authenticate your account here:
				50	https://swiftshader-review.googlesource.com/new-password
				51
				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:
Ben Clayton	e2d8b12	2019-02-07 18:13:16 +0000	[diff] [blame]	53	https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go:
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	54
				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)
				56
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	57	Changes are uploaded to Gerrit by executing:
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	58
				59	git push origin HEAD:refs/for/master
				60
Nicolas Capens	fe5861b	2018-08-03 16:01:48 -0400	[diff] [blame]	61	Testing
				62	-------
				63
				64	SwiftShader's OpenGL ES implementation can be tested using the [dEQP](https://source.android.com/devices/graphics/testing) test suite.
				65
				66	See [docs/dEQP.md](docs/dEQP.md) for details.
				67
Nicolas Capens	3532c69	2017-05-18 11:22:26 -0400	[diff] [blame]	68	Third-Party Dependencies
				69	------------------------
				70
				71	The [third_party](third_party/) directory contains projects which originated outside of SwiftShader:
				72
				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.
				74
				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.
				76
				77	[llvm-subzero](third_party/llvm-subzero/) contains a minimized set of LLVM dependencies of the Subzero project.
				78
				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.
				80
				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.
				82
Nicolas Capens	6388302	2016-05-30 11:03:26 -0400	[diff] [blame]	83	Documentation
				84	-------------
				85
Nicolas Capens	1bc6138	2016-05-30 15:29:09 -0400	[diff] [blame]	86	See [docs/Index.md](docs/Index.md).
Nicolas Capens	6388302	2016-05-30 11:03:26 -0400	[diff] [blame]	87
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	88	Contact
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	89	-------
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	90
Nicolas Capens	d851f23	2016-08-01 15:36:23 -0400	[diff] [blame]	91	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]	92
Ben Clayton	e2d8b12	2019-02-07 18:13:16 +0000	[diff] [blame]	93	General bug tracker: https://g.co/swiftshaderbugs\
Nicolas Capens	db309b6	2018-05-22 14:49:35 -0400	[diff] [blame]	94	Chrome specific bugs: https://bugs.chromium.org/p/swiftshader
Nicolas Capens	22b17b0	2016-06-17 13:39:18 -0400	[diff] [blame]	95
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	96	License
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	97	-------
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	98
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	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).
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	100
				101	Files in the third_party folder are subject to their respective license.
				102
				103	Authors and Contributors
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	104	------------------------
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	105
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	106	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]	107
Nicolas Capens	cf83d16	2016-07-02 23:41:30 -0400	[diff] [blame]	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.
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	109
				110	Disclaimer
Nicolas Capens	9eaa19c	2017-06-28 11:13:55 -0400	[diff] [blame]	111	----------
Nicolas Capens	1703e0f	2016-05-12 17:27:05 -0400	[diff] [blame]	112
				113	1. Trademarks are the property of their respective owners.
				114	2. We do not claim official conformance with any graphics APIs at this moment.
Nicolas Capens	88f5ec6	2017-06-13 10:10:22 -0400	[diff] [blame]	115	3. This is not an official Google product.