Commit c677795f by Frank Henigman Committed by Commit Bot

docs: fix links and typos

Update stale/broken links. Use consistent link style: - links between our files should relative - omit filename for links within same file - don't specify heading id Don't use same heading twice in one file because the markdown compilers on googlesource.com and github have different ways of disambiguating them, so this is the easiest way to have links work on both sites. BUG=angleproject:1569 Change-Id: Iefd5ab8014d582a017f64e383f301ea0b8e60433 Reviewed-on: https://chromium-review.googlesource.com/789445Reviewed-by: 's avatarYuly Novikov <ynovikov@chromium.org> Reviewed-by: 's avatarGeoff Lang <geofflang@chromium.org> Commit-Queue: Frank Henigman <fjhenigman@chromium.org>
parent d3e213bc
...@@ -55,13 +55,13 @@ View the [Dev setup instructions](doc/DevSetup.md). For generating a Windows Sto ...@@ -55,13 +55,13 @@ View the [Dev setup instructions](doc/DevSetup.md). For generating a Windows Sto
* Join our [Google group](https://groups.google.com/group/angleproject) to keep up to date. * Join our [Google group](https://groups.google.com/group/angleproject) to keep up to date.
* Join us on IRC in the #ANGLEproject channel on FreeNode. * Join us on IRC in the #ANGLEproject channel on FreeNode.
* File bugs in the [issue tracker](http://code.google.com/p/angleproject/issues/list) (preferably with an isolated test-case). * File bugs in the [issue tracker](https://bugs.chromium.org/p/angleproject/issues/list) (preferably with an isolated test-case).
* [Choose an ANGLE branch](doc/ChoosingANGLEBranch.md) to track in your own project. * [Choose an ANGLE branch](doc/ChoosingANGLEBranch.md) to track in your own project.
* Read ANGLE development [documentation](doc). * Read ANGLE development [documentation](doc).
* Look at [pending](https://chromium-review.googlesource.com/#/q/project:angle/angle+status:open) * Look at [pending](https://chromium-review.googlesource.com/q/project:angle/angle+status:open)
and [merged](https://chromium-review.googlesource.com/#/q/project:angle/angle+status:merged) changes. and [merged](https://chromium-review.googlesource.com/q/project:angle/angle+status:merged) changes.
* Become a [code contributor](doc/ContributingCode.md). * Become a [code contributor](doc/ContributingCode.md).
* Use ANGLE's [coding standard](doc/CodingStandard.md). * Use ANGLE's [coding standard](doc/CodingStandard.md).
* Learn how to [build ANGLE for Chromium development](doc/BuildingAngleForChromiumDevelopment.md). * Learn how to [build ANGLE for Chromium development](doc/BuildingAngleForChromiumDevelopment.md).
......
...@@ -33,7 +33,7 @@ Gyp will generate multiple VS2015 solution files ...@@ -33,7 +33,7 @@ Gyp will generate multiple VS2015 solution files
### Building ANGLE ### Building ANGLE
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](BuildingAngleForWindowsStore.md#Development-setup-Getting-the-source)). 1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](#getting-the-source)).
2. Select Build -> Configuration Manager 2. Select Build -> Configuration Manager
3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager. 3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager.
4. Select Build -> Build Solution. 4. Select Build -> Build Solution.
...@@ -46,11 +46,11 @@ Once the build completes, the output directory for your selected configuration ( ...@@ -46,11 +46,11 @@ Once the build completes, the output directory for your selected configuration (
* Right-click your project in the _Solution Explorer_, and select _Properties_. * Right-click your project in the _Solution Explorer_, and select _Properties_.
* Under the _Configuration Properties_ branch, click _C/C++_. * Under the _Configuration Properties_ branch, click _C/C++_.
* Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_. * Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_.
3. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSteup.md#Building-ANGLE)). 3. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSetup.md#building-angle-on-windows)).
* For Visual C++ * For Visual C++
* Right-click your project in the _Solution Explorer_, and select _Properties_. * Right-click your project in the _Solution Explorer_, and select _Properties_.
* Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_. * Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_.
* Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon. * Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon.
4. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#Building-ANGLE)) into your application folder or packages location if a ANGLE Windows Store NuGet was used. 4. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#building-angle-on-windows)) into your application folder or packages location if a ANGLE Windows Store NuGet was used.
5. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs. 5. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs.
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## Google Style Guide ## Google Style Guide
We generally use the [Google C++ Style Guide] We generally use the [Google C++ Style Guide]
(http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) as a basis for (https://google.github.io/styleguide/cppguide.html) as a basis for
our Coding Standard, however we will deviate from it in a few areas, as noted our Coding Standard, however we will deviate from it in a few areas, as noted
below. below.
...@@ -13,23 +13,23 @@ Items marked {DEV} indicate a deviation from the Google guidelines. Items marked ...@@ -13,23 +13,23 @@ Items marked {DEV} indicate a deviation from the Google guidelines. Items marked
Before you upload code to Gerrit, use `git cl format` to auto-format your code. Before you upload code to Gerrit, use `git cl format` to auto-format your code.
This will catch most of the trivial formatting errors and save you time. This will catch most of the trivial formatting errors and save you time.
### [Header Files](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Header_Files) ### [Header Files](https://google.github.io/styleguide/cppguide.html#Header_Files)
* We will use **`.h`** for C++ headers. * We will use **`.h`** for C++ headers.
* {DEV} #define guards should be of the form: `<PATH>_<FILE>_H_`. (Compiler * {DEV} #define guards should be of the form: `<PATH>_<FILE>_H_`. (Compiler
codebase is varied, including `<PROJECT>_` makes the names excessively codebase is varied, including `<PROJECT>_` makes the names excessively
long). long).
### [Scoping](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Scoping) ### [Scoping](https://google.github.io/styleguide/cppguide.html#Scoping)
* {DO} avoid globally scoped variables, unless absolutely necessary. * {DO} avoid globally scoped variables, unless absolutely necessary.
### [Classes](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Classes) ### [Classes](https://google.github.io/styleguide/cppguide.html#Classes)
* {DEV} Inherit (privately) from angle::NonCopyable helper class (defined in * {DEV} Inherit (privately) from angle::NonCopyable helper class (defined in
common/angleutils.h) to disable default copy and assignment operators. common/angleutils.h) to disable default copy and assignment operators.
### [Other C++ Features](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Other_C++_Features) ### [Other C++ Features](https://google.github.io/styleguide/cppguide.html#Other_C++_Features)
* {DEV} all parameters passed by reference, except for STL containers (e.g. * {DEV} all parameters passed by reference, except for STL containers (e.g.
std::vector, std::list), must be labeled `const`. For return parameters std::vector, std::list), must be labeled `const`. For return parameters
...@@ -42,7 +42,7 @@ This will catch most of the trivial formatting errors and save you time. ...@@ -42,7 +42,7 @@ This will catch most of the trivial formatting errors and save you time.
* {DO} use C++11 according to the [Chromium guide on C++11] * {DO} use C++11 according to the [Chromium guide on C++11]
(http://chromium-cpp.appspot.com/). (http://chromium-cpp.appspot.com/).
### [Naming ](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Naming) ### [Naming](https://google.github.io/styleguide/cppguide.html#Naming)
#### File Names #### File Names
...@@ -74,7 +74,7 @@ use CamelCase (chosen for consistency) ...@@ -74,7 +74,7 @@ use CamelCase (chosen for consistency)
* macros: all uppercase with underscores * macros: all uppercase with underscores
* exceptions to naming: use common sense! * exceptions to naming: use common sense!
### [Comments](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Comments) ### [Comments](https://google.github.io/styleguide/cppguide.html#Comments)
* {DO} read and follow Google's recommendations. * {DO} read and follow Google's recommendations.
* Each file **must** start with the following boilerplate notice: * Each file **must** start with the following boilerplate notice:
...@@ -87,7 +87,7 @@ use CamelCase (chosen for consistency) ...@@ -87,7 +87,7 @@ use CamelCase (chosen for consistency)
// //
``` ```
### [Formatting](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Formatting) ### [Formatting](https://google.github.io/styleguide/cppguide.html#Formatting)
* {DEV} Avoid excessively long lines. Please keep lines under 100 columns * {DEV} Avoid excessively long lines. Please keep lines under 100 columns
long. long.
...@@ -149,7 +149,7 @@ char *c; ...@@ -149,7 +149,7 @@ char *c;
const string &str; const string &str;
``` ```
### [Exceptions to the Rules](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Exceptions_to_the_Rules) ### [Exceptions to the Rules](https://google.github.io/styleguide/cppguide.html#Exceptions_to_the_Rules)
* If modifying pre-existing code that does not match the standard, the altered * If modifying pre-existing code that does not match the standard, the altered
portions of the code should be changed to match the standard. portions of the code should be changed to match the standard.
...@@ -10,8 +10,7 @@ about how to do this. ...@@ -10,8 +10,7 @@ about how to do this.
Pull top of tree ANGLE. Pull top of tree ANGLE.
Install the Emscripten toolchain per the [instructions] Install the Emscripten toolchain per the [instructions](http://emscripten.org/).
(http://kripken.github.io/emscripten-site/).
Symlink (preferred) or copy the ANGLE directory into ...emsdk/emscripten/master. Symlink (preferred) or copy the ANGLE directory into ...emsdk/emscripten/master.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## Communicate ## Communicate
* Whether you're writing a new feature or fixing an existing bug, it pays to get a second opinion before you get too far. If it's a new feature idea, post to the discussion group ([angleproject](https://groups.google.com/forum/?fromgroups#!forum/angleproject)) and propose it or talk with the ANGLE team on IRC in the #ANGLEproject channel on FreeNode. * Whether you're writing a new feature or fixing an existing bug, it pays to get a second opinion before you get too far. If it's a new feature idea, post to the discussion group ([angleproject](https://groups.google.com/forum/?fromgroups#!forum/angleproject)) and propose it or talk with the ANGLE team on IRC in the #ANGLEproject channel on FreeNode.
* Not all bugs in our [bug system](https://code.google.com/p/angleproject/issues/list) are assigned, but if the one you're interested in fixing is, send a note to the person it's assigned to and ask if they would like a patch. * Not all bugs in our [bug system](https://bugs.chromium.org/p/angleproject/issues/list) are assigned, but if the one you're interested in fixing is, send a note to the person it's assigned to and ask if they would like a patch.
* Behavior changes and anything nontrivial (i.e. anything other than simple cleanups and style fixes) should generally be tracked in the bug system. Please [file a bug](http://anglebug.com/new) and describe what you're doing if there isn't one already. * Behavior changes and anything nontrivial (i.e. anything other than simple cleanups and style fixes) should generally be tracked in the bug system. Please [file a bug](http://anglebug.com/new) and describe what you're doing if there isn't one already.
## Get your code ready ## Get your code ready
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
### Build maintenance ### Build maintenance
1. If you added or removed source files: 1. If you added or removed source files:
* You _must_ update the gyp build scripts lists with your changes. See `src/libEGL.gypi`, `src/libGLESv2.gypi`, and `src/compiler.gypi`. * You _must_ update the gyp build scripts lists with your changes. See `src/libEGL.gypi`, `src/libGLESv2.gypi`, and `src/compiler.gypi`.
2. ANGLE also now maintains a BUILD.gn script for [Chromium's gn build](https://code.google.com/p/chromium/wiki/gn). If you changed the gyp files other than to add or remove new files, you will also need to update BUILD.gn. Ask a project member for help with testing if you don't have a Chromium checkout. 2. ANGLE also now maintains a BUILD.gn script for [Chromium's gn build](https://www.chromium.org/developers/gn-build-configuration). If you changed the gyp files other than to add or remove new files, you will also need to update BUILD.gn. Ask a project member for help with testing if you don't have a Chromium checkout.
3. If you modified `glslang.y` or `glslang.l`: 3. If you modified `glslang.y` or `glslang.l`:
* You _must_ update the bison-generated compiler sources. Download and install the latest 64-bit Bison and flex from official [Cygwin](https://cygwin.com/install.html) on _Windows_. From the Cygwin shell run `generate_parser.sh` in `src/compiler/translator` and update your CL. Do not edit the generated files by hand. * You _must_ update the bison-generated compiler sources. Download and install the latest 64-bit Bison and flex from official [Cygwin](https://cygwin.com/install.html) on _Windows_. From the Cygwin shell run `generate_parser.sh` in `src/compiler/translator` and update your CL. Do not edit the generated files by hand.
* _NOTE:_ You can ignore failing chunk messages if there are no compile errors. * _NOTE:_ You can ignore failing chunk messages if there are no compile errors.
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
### Testing ### Testing
* ANGLE uses trybots to test on a variety of platforms. Please run your changes against our bots and check the results before landing changes or requesting reviews. * ANGLE uses trybots to test on a variety of platforms. Please run your changes against our bots and check the results before landing changes or requesting reviews.
* Upload your change (see [Making changes](ContributingCode.md#making-changes)). * Upload your change (see [Making changes](#making-changes)).
* To kick of a try job, use the 'CQ Dry Run' button, or set the Commit-Queue +1 label to trigger a dry run of the CQ (will not land the change). * To kick of a try job, use the 'CQ Dry Run' button, or set the Commit-Queue +1 label to trigger a dry run of the CQ (will not land the change).
* If you are not part of the `angle-committers` group, you will need to either ask to be added or ask a member of the group to submit the tryjob for you. Add jmadill or geofflang as a reviewer for assistance. * If you are not part of the `angle-committers` group, you will need to either ask to be added or ask a member of the group to submit the tryjob for you. Add jmadill or geofflang as a reviewer for assistance.
* Wait for the bots to report the result on the code review page. The bot results should be visible in Gerrit as yellow (in-progress), green (passed), or red (failed). This can take up to two hours for some of the debug bots. Click on the colored rectangle to open the bot log to triage failed tests. * Wait for the bots to report the result on the code review page. The bot results should be visible in Gerrit as yellow (in-progress), green (passed), or red (failed). This can take up to two hours for some of the debug bots. Click on the colored rectangle to open the bot log to triage failed tests.
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
* ANGLE also includes the [drawElements Quality Program (dEQP)](dEQP.md) for additional testing. If you're working on a new feature, there may be some extensive tests for it already written. * ANGLE also includes the [drawElements Quality Program (dEQP)](dEQP.md) for additional testing. If you're working on a new feature, there may be some extensive tests for it already written.
### Legal ### Legal
1. You must complete the [Individual Contributor License Agreement](http://code.google.com/legal/individual-cla-v1.0.html). You can do this online, and it only takes a minute. If you are contributing on behalf of a corporation, you must fill out the [Corporate Contributor License Agreement](http://code.google.com/legal/corporate-cla-v1.0.html) and send it to Google as described on that page. 1. You must complete the [Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual). You can do this online, and it only takes a minute. If you are contributing on behalf of a corporation, you must fill out the [Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate) and send it to Google as described on that page.
2. Once you've submitted the CLA, please email the following information (as entered on the CLA) to `shannonwoods at chromium dot org` for record keeping purposes: 2. Once you've submitted the CLA, please email the following information (as entered on the CLA) to `shannonwoods at chromium dot org` for record keeping purposes:
* Full Name: * Full Name:
* Email: * Email:
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
* Download the hook from [https://chromium-review.googlesource.com/tools/hooks/commit-msg](https://chromium-review.googlesource.com/tools/hooks/commit-msg) and copy this file to `.git/hooks/commit-msg` within your local repository. On non-Windows, platforms, ensure that permissions are set to allow execution. * Download the hook from [https://chromium-review.googlesource.com/tools/hooks/commit-msg](https://chromium-review.googlesource.com/tools/hooks/commit-msg) and copy this file to `.git/hooks/commit-msg` within your local repository. On non-Windows, platforms, ensure that permissions are set to allow execution.
* *BE AWARE:* Some patch management tools, such as StGit, currently bypass git hooks. They should not currently be used with changes intended for review. * *BE AWARE:* Some patch management tools, such as StGit, currently bypass git hooks. They should not currently be used with changes intended for review.
### Making changes {#making-changes} ### Making changes
1. Commit your changes locally: 1. Commit your changes locally:
* `git add src/../FileName.cpp` * `git add src/../FileName.cpp`
* `git commit` * `git commit`
...@@ -79,7 +79,7 @@ ...@@ -79,7 +79,7 @@
3. Upload the change list 3. Upload the change list
* `git cl upload` * `git cl upload`
* The change list and modified files will be uploaded to * The change list and modified files will be uploaded to
[ANGLE Gerrit](https://chromium-review.googlesource.com/#/q/project:angle/angle). [ANGLE Gerrit](https://chromium-review.googlesource.com/q/project:angle/angle).
* Follow the generated URL to the new issue. * Follow the generated URL to the new issue.
* Take a moment to perform a self-review of your code. Gerrit's viewer makes it easy to see whitespace errors, erroneous tabs, and other simple style problems. * Take a moment to perform a self-review of your code. Gerrit's viewer makes it easy to see whitespace errors, erroneous tabs, and other simple style problems.
* Designate reviewers-- if you don't do this, reviewers may not realize you're requesting a review! * Designate reviewers-- if you don't do this, reviewers may not realize you're requesting a review!
...@@ -98,7 +98,7 @@ ...@@ -98,7 +98,7 @@
See also: See also:
* [ANGLE Gerrit](https://chromium-review.googlesource.com/#/q/project:angle/angle) * [ANGLE Gerrit](https://chromium-review.googlesource.com/q/project:angle/angle)
* [Chromium Projects: Contributing Code](http://www.chromium.org/developers/contributing-code/) * [Chromium Projects: Contributing Code](http://www.chromium.org/developers/contributing-code/)
* [depot_tools tutorial](http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html) * [depot_tools tutorial](http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html)
......
...@@ -59,12 +59,12 @@ git checkout master ...@@ -59,12 +59,12 @@ git checkout master
GYP will generate the project files, if you update ANGLE or make a change to the projects, they can be regenerated by executing `gclient runhooks`. GYP will generate the project files, if you update ANGLE or make a change to the projects, they can be regenerated by executing `gclient runhooks`.
On Windows GYP will generate the main VS2015 solution file as gyp/ANGLE.sln. For generating a Windows Store version of ANGLE view the [Windows Store instructions](doc/BuildingAngleForWindowsStore.md). On Windows GYP will generate the main VS2015 solution file as gyp/ANGLE.sln. For generating a Windows Store version of ANGLE view the [Windows Store instructions](BuildingAngleForWindowsStore.md).
On Linux and MacOS, GYP will generate the `out/Debug` and `out/Release` directories. On Linux and MacOS, GYP will generate the `out/Debug` and `out/Release` directories.
### Building ANGLE on Windows ### Building ANGLE on Windows
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](DevSetup.md#Development-setup-Getting-the-source)). 1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](#getting-the-source)).
2. Select Build -> Configuration Manager 2. Select Build -> Configuration Manager
3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager. 3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager.
4. Select Build -> Build Solution. 4. Select Build -> Build Solution.
...@@ -78,7 +78,7 @@ Once the build completes, the `out/Debug` or `out/Release` directories will cont ...@@ -78,7 +78,7 @@ Once the build completes, the `out/Debug` or `out/Release` directories will cont
Presently, it is not possible to build standalone ANGLE for Android. Presently, it is not possible to build standalone ANGLE for Android.
But, ANGLE for Android can be built within a Chromium checkout. But, ANGLE for Android can be built within a Chromium checkout.
The reason for that is a dependency on Chromium for Android toolchain and that it only supports GN. The reason for that is a dependency on Chromium for Android toolchain and that it only supports GN.
Also, it can only be built on Linux, as this is the only platfrom that Chromium for Android supports. Also, it can only be built on Linux, as this is the only platform that Chromium for Android supports.
In theory, once ANGLE supports standalone GN build, it may be possible to put Chromium for Android toolchain in `third_party` or `buildtools` to build standalone ANGLE for Android. In theory, once ANGLE supports standalone GN build, it may be possible to put Chromium for Android toolchain in `third_party` or `buildtools` to build standalone ANGLE for Android.
But, for now, the steps in [Checking out and building Chromium for Android](https://chromium.googlesource.com/chromium/src/+/master/docs/android_build_instructions.md) should be followed to check out Chromium for Android and set up build environment. But, for now, the steps in [Checking out and building Chromium for Android](https://chromium.googlesource.com/chromium/src/+/master/docs/android_build_instructions.md) should be followed to check out Chromium for Android and set up build environment.
...@@ -114,7 +114,7 @@ adb pull /sdcard/chromium_tests_root/third_party/deqp/src/data/TestResults.qpa . ...@@ -114,7 +114,7 @@ adb pull /sdcard/chromium_tests_root/third_party/deqp/src/data/TestResults.qpa .
In order to run GPU telemetry tests, build `chrome_public_apk` target. Then follow [GPU Testing](http://www.chromium.org/developers/testing/gpu-testing#TOC-Running-the-GPU-Tests-Locally) doc, using `--browser=android-chromium` argument. Make sure to set your `CHROMIUM_OUT_DIR` environment variable, so that your browser is found, otherwise the stock one will run. In order to run GPU telemetry tests, build `chrome_public_apk` target. Then follow [GPU Testing](http://www.chromium.org/developers/testing/gpu-testing#TOC-Running-the-GPU-Tests-Locally) doc, using `--browser=android-chromium` argument. Make sure to set your `CHROMIUM_OUT_DIR` environment variable, so that your browser is found, otherwise the stock one will run.
Also, follow [How to build ANGLE in Chromium for dev](https://chromium.googlesource.com/angle/angle/+/HEAD/doc/BuildingAngleForChromiumDevelopment.md) to work with Top of Tree ANGLE in Chromium. Also, follow [How to build ANGLE in Chromium for dev](BuildingAngleForChromiumDevelopment.md) to work with Top of Tree ANGLE in Chromium.
## Application Development with ANGLE ## Application Development with ANGLE
This sections describes how to use ANGLE to build an OpenGL ES application. This sections describes how to use ANGLE to build an OpenGL ES application.
...@@ -137,12 +137,12 @@ On Windows: ...@@ -137,12 +137,12 @@ On Windows:
* Right-click your project in the _Solution Explorer_, and select _Properties_. * Right-click your project in the _Solution Explorer_, and select _Properties_.
* Under the _Configuration Properties_ branch, click _C/C++_. * Under the _Configuration Properties_ branch, click _C/C++_.
* Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_. * Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_.
2. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSteup.md#Building-ANGLE)). 2. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](#building-angle-on-windows)).
* For Visual C++ * For Visual C++
* Right-click your project in the _Solution Explorer_, and select _Properties_. * Right-click your project in the _Solution Explorer_, and select _Properties_.
* Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_. * Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_.
* Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon. * Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon.
3. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#Building-ANGLE)) into your application folder. 3. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](#building-angle-on-windows)) into your application folder.
4. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs. 4. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs.
On Linux and MacOS, either: On Linux and MacOS, either:
...@@ -153,8 +153,9 @@ On Linux and MacOS, either: ...@@ -153,8 +153,9 @@ On Linux and MacOS, either:
## GLSL ES to GLSL Translator ## GLSL ES to GLSL Translator
In addition to OpenGL ES 2.0 and EGL 1.4 libraries, ANGLE also provides a GLSL ES to GLSL translator. This is useful for implementing OpenGL ES emulators on top of desktop OpenGL. In addition to OpenGL ES 2.0 and EGL 1.4 libraries, ANGLE also provides a GLSL ES to GLSL translator. This is useful for implementing OpenGL ES emulators on top of desktop OpenGL.
### Getting the source ### Source and Building
The translator code is fully independent of the rest of ANGLE code and resides in `src/compiler`. It is cross-platform and build files for operating systems other than Windows can be generated by following the `Generating project files` steps above. The translator code is included with ANGLE but fully independent; it resides in `src/compiler`.
Follow the steps above for [getting and building ANGLE](#getting-the-source) to build the translator on the platform of your choice.
### Usage ### Usage
The basic usage is shown in `essl_to_glsl` sample under `samples/translator`. To translate a GLSL ES shader, following functions need to be called in the same order: The basic usage is shown in `essl_to_glsl` sample under `samples/translator`. To translate a GLSL ES shader, following functions need to be called in the same order:
......
...@@ -9,8 +9,7 @@ Specifications for EGL extensions can be found in the [Khronos EGL API Registry] ...@@ -9,8 +9,7 @@ Specifications for EGL extensions can be found in the [Khronos EGL API Registry]
(http://www.khronos.org/registry/egl/) (http://www.khronos.org/registry/egl/)
Specifications for ANGLE-specific extensions can be found in the [ANGLE Specifications for ANGLE-specific extensions can be found in the [ANGLE
extension registry] extension registry](../extensions)
(https://code.google.com/p/angleproject/source/browse/?name=master#git%2Fextensions)
# Details # Details
......
...@@ -10,8 +10,7 @@ contributors pulling from the svn repository will continue to be able to do so, ...@@ -10,8 +10,7 @@ contributors pulling from the svn repository will continue to be able to do so,
but please note that this repository is now read-only, and no further updates but please note that this repository is now read-only, and no further updates
will be made there. To continue tracking new development and issue fixes, you'll will be made there. To continue tracking new development and issue fixes, you'll
need to watch the git repository. Instructions on checking out code from the git need to watch the git repository. Instructions on checking out code from the git
repository can be found on the [Source Checkout] repository can be found on the [Source Checkout](https://code.google.com/p/angleproject/source/checkout) page.
(https://code.google.com/p/angleproject/source/checkout) page.
## DirectX 11 Support ## DirectX 11 Support
......
...@@ -3,9 +3,8 @@ ...@@ -3,9 +3,8 @@
ANGLE has undergone a few further migrations in the past week, which we thought ANGLE has undergone a few further migrations in the past week, which we thought
it important to mention in a front-page update. it important to mention in a front-page update.
The review process for contributed code has moved from [Rietveld] The review process for contributed code has moved from [Rietveld](https://codereview.appspot.com/)
(https://codereview.appspot.com/) to [Gerrit] to [Gerrit](https://chromium-review.googlesource.com). This migration allows us to more
(https://chromium-review.googlesource.com). This migration allows us to more
easily support a Git-centric workflow, and eases the process of accepting easily support a Git-centric workflow, and eases the process of accepting
changes submitted by contributors without commit access to our repositories. changes submitted by contributors without commit access to our repositories.
......
# Multiplatform ANGLE Refactor Complete # Multiplatform ANGLE Refactor Complete
ANGLE's multiplatform refactoring effort ([described here] ANGLE's [multiplatform refactoring effort](MANGLE.md) is now complete, paving
(https://code.google.com/p/angleproject/wiki/MANGLE)) is now complete, paving
the way for additional rendering backends, allowing ANGLE to enable OpenGL ES the way for additional rendering backends, allowing ANGLE to enable OpenGL ES
not just over Direct3D 9 and 11, but also desktop OpenGL. not just over Direct3D 9 and 11, but also desktop OpenGL.
......
...@@ -50,9 +50,8 @@ checks out a copy of Cherry to `angle/third_party/cherry` when you sync with ...@@ -50,9 +50,8 @@ checks out a copy of Cherry to `angle/third_party/cherry` when you sync with
gclient. Note, if you are using ninja or another build system, the qpa file gclient. Note, if you are using ninja or another build system, the qpa file
will be located in your working directory. will be located in your working directory.
See the [official Cherry README](https://android.googlesource.com/platform/ext See the [official Cherry README](https://android.googlesource.com/platform/external/cherry/+/master/README)
ernal/cherry/+/master/README) for instructions on how to run Cherry on Linux for instructions on how to run Cherry on Linux or Windows.
or Windows.
### GoogleTest, ANGLE and dEQP ### GoogleTest, ANGLE and dEQP
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment