skia2/site/user/quick/windows.md
halcanary e0c64c5846 Documentation: clean up
-   /user/quick/desktop to bring together all common information for
    using Skia on desktop OSes.  Remove duplication.

-   Replace all instances of call ing gyp_skia directly with calling
    `python bin/sync-and-gyp`.  This is more correct on Windows

-   Remove outdated linux prerequisite packages

-   Formatting, formatting, formatting.

-   Note command-line syntax differences in Windows

-   SampleApp.app is no longer a bundle on MacOS

NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1439493003

Review URL: https://codereview.chromium.org/1439493003
2015-11-13 04:29:59 -08:00

4.8 KiB
Raw Blame History

Windows

Prerequisites

Make sure the following have been installed:

Check out the source code

Follow the instructions here for downloading the Skia source.

Gyp Generators on Windows

We use the open-source Gyp tool to generate Visual Studio projects (and analogous build scripts on other platforms) from our multi-platform "gyp" files.

Three Gyp generators are used on Windows:

  • ninja - Run ninja yourself, without VisualStudio project files,

  • msvs-ninja - Develop from a fully-integrated Visual Studio. Gyp generates Visual-Studio-compatible project files that still ultimately build using ninja

  • msvs - Use Visual Studio's own (slower) build system

To choose which ones to use, set the GYP_GENERATORS environment variable to a comma-delimited list of generators before running sync-and-gyp. The default value for GYP_GENERATORS is ninja,msvs-ninja. For example to enable the ninja and msvs generators:

Setting Enviroment Variables in Windows CMD.EXE

cd %SKIA_CHECKOUT_DIR%
SET "GYP_GENERATORS=ninja,msvs"
python bin/sync-and-gyp
SET "GYP_GENERATORS="

Build and run tests from the command line

ninja -C out/Debug dm
out\Debug\dm

See this page for running Skia tests on all desktop

Build and run tests in the Visual Studio IDE

  1. Generate the Visual Studio project files by running sync-and-gyp as described above

  2. Open a File Explorer window pointing at the %SKIA_CHECKOUT_DIR%\out\gyp directory

  3. Double-click on dm.sln to start Visual Studio and load the project

  4. When Visual Studio starts, you may see an error dialog stating that "One or more projects in the solution were not loaded correctly"... but there's probably nothing to worry about.

  5. In the "Solution Explorer" window, right-click on the "dm" project and select "Set as StartUp Project".

  6. In the "Debug" menu, click on "Start Debugging" (or just press F5). If you get a dialog saying that the project is out of date, click on "Yes" to rebuild it.

  7. Once the build is complete, you should see console output from the tests in the "Output" window at lower right.

Build and run SampleApp in Visual Studio

  1. Generate the Visual Studio project files by running sync-and-gyp as described above

  2. Open a File Explorer window pointing at the %SKIA_INSTALLDIR%\trunk\out\gyp directory

  3. Double-click on SampleApp.sln

  4. When Visual Studio starts, you may see an error dialog stating that "One or more project s in the solution were not loaded correctly"... but there's probably nothing to worry about.

  5. In the "Debug" menu, click on "Start Debugging" (or just press F5). If you get a dialog saying that the project is out of date, click on "Yes" to rebuild it.

  6. Once the build is complete, you should see a window with various example graphics. To move through the sample app, use the following keypresses:

    • right-arrow key: cycle through different test pages
    • left-arrow key: cycle through rendering methods for each test page
    • other keys are defined in SampleApp.cpps SampleWindow::onHandleKey() and SampleWindow::onHandleChar() methods