Skip to content

Commit

Permalink
Wrap all MD files at 80 cols, minor cleanup of headers/indenting (flu…
Browse files Browse the repository at this point in the history
  • Loading branch information
dnfield committed Apr 27, 2022
1 parent 14ec50a commit 3d422b2
Show file tree
Hide file tree
Showing 7 changed files with 148 additions and 38 deletions.
151 changes: 121 additions & 30 deletions impeller/README.md

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion impeller/base/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# The Impeller Base Library

Contains a number of utilities that should probably go in the base library in the buildroot but whose use is not extensive enough to warrant a move yet.
Contains a number of utilities that should probably go in the base library in
the buildroot but whose use is not extensive enough to warrant a move yet.
6 changes: 5 additions & 1 deletion impeller/compiler/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# The Impeller Shader Compiler & Reflector

Host side tooling that consumes [GLSL 4.60 (Core Profile)](https://www.khronos.org/registry/OpenGL/specs/gl/GLSLangSpec.4.60.pdf) shaders and generates libraries suitable for consumption by an Impeller backend. Along with said libraries, the reflector generates code and meta-data to construct rendering and compute pipelines at runtime.
Host side tooling that consumes [GLSL 4.60 (Core
Profile)](https://www.khronos.org/registry/OpenGL/specs/gl/GLSLangSpec.4.60.pdf)
shaders and generates libraries suitable for consumption by an Impeller backend.
Along with said libraries, the reflector generates code and meta-data to
construct rendering and compute pipelines at runtime.
4 changes: 3 additions & 1 deletion impeller/fixtures/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# The Impeller Fixtures Set

Unlike other targets in the buildroot, all Impeller unit-tests use the same fixture set and are invoked using a single test harness (`impeller_unittest`). This is for convenience but also to make working with shader libraries easier.
Unlike other targets in the buildroot, all Impeller unit-tests use the same
fixture set and are invoked using a single test harness (`impeller_unittest`).
This is for convenience but also to make working with shader libraries easier.
7 changes: 6 additions & 1 deletion impeller/geometry/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# The Impeller Geometry Library

Set of utilities used by most graphics operations. While the utilities themselves are rendering backend agnostic, the layout and packing of the various POD structs is arranged such that these can be copied into device memory directly. The supported operations also mimic GLSL to some extent. For this reason, the Impeller shader compiler and reflector uses these utilities in generated code.
Set of utilities used by most graphics operations. While the utilities
themselves are rendering backend agnostic, the layout and packing of the various
POD structs is arranged such that these can be copied into device memory
directly. The supported operations also mimic GLSL to some extent. For this
reason, the Impeller shader compiler and reflector uses these utilities in
generated code.
5 changes: 3 additions & 2 deletions impeller/image/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
The Impeller Image Library
# The Impeller Image Library

Set of utilities for working with texture information. The library is indepenent of the rendering subsystem.
Set of utilities for working with texture information. The library is indepenent
of the rendering subsystem.
10 changes: 8 additions & 2 deletions impeller/playground/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
The Impeller Playground
# The Impeller Playground

An extension of the testing fixtures set, provides utilities for interactive experimentation with the Impeller rendering subsystem. One the test author is satisfied with the behavior of component as verified in the playground, pixel test assertions can be added to before committing the new test case. Meant to provide a gentle-er on-ramp to testing Impeller components. The WSI in the playground allows for points at which third-party profiling and instrumentation tools can be used to examine isolated test cases.
An extension of the testing fixtures set, provides utilities for interactive
experimentation with the Impeller rendering subsystem. One the test author is
satisfied with the behavior of component as verified in the playground, pixel
test assertions can be added to before committing the new test case. Meant to
provide a gentle-er on-ramp to testing Impeller components. The WSI in the
playground allows for points at which third-party profiling and instrumentation
tools can be used to examine isolated test cases.

0 comments on commit 3d422b2

Please sign in to comment.