diff options
| author |  herb <herb@google.com> | 2015-01-29 20:31:04 -0800 |
|---|---|---|
| committer |  Commit bot <commit-bot@chromium.org> | 2015-01-29 20:31:04 -0800 |
| commit | e4e01b8608cd7aeaf47c914ddfb2afa3239a0bc6 (patch) | |
| tree | 2d4df4bfe553766c426eb7f3785b2a3cc155a134 /site | |
| parent | 06fb35fe073f4bf213eb6a48498a1319bcff6cf2 (diff) | |
Start SampleApp documentation
BUG=skia:359
Review URL: https://codereview.chromium.org/883203003
Diffstat (limited to 'site')
| -rw-r--r-- | site/user/sample/sampleapp.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/site/user/sample/sampleapp.md b/site/user/sample/sampleapp.md new file mode 100644 index 0000000000..f5d31a4179 --- /dev/null +++ b/site/user/sample/sampleapp.md @@ -0,0 +1,30 @@ +About SampleApp +========================== +The SampleApp displays a series of slides that exhibit specific features of the Skia system. It is mainly controlled using the keyboard: left (←) and (→) right arrows to move from slide to slide. Some slides require use resources stored outside the program. These resources are stored in the `<skia-path>/resources` directory. + +`<skia-path>/out/Release/SampleApp --resourcePath <skia-path>/resources` + + +In addition to displaying various aspects of Skia, SampleApp is used to debug and understand different parts of the Skia system. + +* Observe rendering performance - pressing the 'f' key places the SampleApp in frame rate mode. It continuously draws the slide while desplaying the draw time in the title of the window. +* Try different rendering methods - pressing the 'd' key cycles among the three rendering methods raster, picture and opengl. You can use this with the 'f' key to see the effect that the different rendering methods have on drawing performance. +* Look at different angles - pressing the 'r' slowley rotates the slide. +* Display and manipulate your own pictures - use the `--picture <skp-file-path>.skp` to use the `.skp` file as the slide desplayed by SampleApp. A `.skp` file can be generated by... + +You can find how to build the SampleApp for the various operating systems at the following links: + +* [Linux](/user/quick/linux) +* [Macintosh](/user/quick/macos) +* [Windows](/user/quick/windows) +* [Android](/user/quick/android) + +Key | Action +-----------------------------|------------- +← → | Move between the slides +r | Rotate the current slide +↑ ↓ | Zoom in / out +d | Change render methods among raster, picture and opengl +f | Display the rendering time in the menu bar +G | Show bounding box + |