dom/canvas/test/webgl-conf/checkout/README.md

   1 Welcome to the WebGL Conformance Test Suite
   2 ===========================================
   3
   4 Note: Before adding a new test or editing an existing test
   5 [please read these guidelines](test-guidelines.md).
   6
   7 This is the WebGL conformance test suite. You can find a the current "live"
   8 version at [https://www.khronos.org/registry/webgl/sdk/tests/webgl-conformance-tests.html](https://www.khronos.org/registry/webgl/sdk/tests/webgl-conformance-tests.html)
   9
  10 NOTE TO USERS: Unless you are a WebGL implementor, there is no need to submit
  11 a conformance result using this process.  Should you discover bugs in your
  12 browser's WebGL implementation, either via this test suite or otherwise,
  13 please report them through your browser vendor's bug tracking system.
  14
  15 FOR WEBGL IMPLEMENTORS: Please follow the instructions below to create
  16 a formal conformance submission:
  17
  18 1. Open webgl-conformance-tests.html in your target browser
  19
  20 2. Press the "run tests" button
  21
  22 3. At the end of the run, press "display text summary"
  23
  24 4. Verify that the User Agent and WebGL renderer strings identify your browser and target correctly.
  25
  26 5. Submit a PR with the results to [https://github.com/KhronosGroup/WebGLConformanceSubmissions].
  27
  28 Please see CONFORMANCE_RULES.txt in this directory for guidelines
  29 about what constitutes a conformant WebGL implementation.
  30
  31 Usage Notes:
  32 ------------
  33
  34 There are various URL options you can pass in:
  35
  36     run:         Set to 1 to start the tests automatically
  37
  38                  Example: webgl-conformance-tests.html?run=1
  39
  40     version:     Set to the version of the harness you wish to run. Tests
  41                  at this version or below will be run
  42
  43                  Example: webgl-conformance-tests.html?version=1.3.2
  44
  45     minVersion:  Set to the minimum version of each test to include. Only tests
  46                  at this version or above will be included.
  47
  48                  Example: webgl-conformance-tests.html?minVersion=1.3.2
  49
  50     fast:        Only run tests not marked with --slow
  51
  52                  Example: webgl-conformance-tests.html?fast=true
  53
  54     skip:        Comma separated list of regular expressions of which tests to skip.
  55
  56                  Example: webgl-conformance-tests.html?skip=glsl,.*destruction\.html
  57
  58     include:     Comma separated list of regular expressions of which tests to include.
  59
  60                  Example: webgl-conformance-tests.html?include=glsl,.*destruction\.html
  61
  62     frames:      The number of iframes to use to run tests in parallel.
  63
  64                  Example: webgl-conformance-tests.html?frames=8
  65
  66                  Note the tests are not required to run with anything other than frames = 1.
  67
  68 To individual tests you can pass:
  69
  70     showRenderer: 1 to show the renderer or unmasked renderer if `WEBGL_debug_renderer_info`
  71                   is available
  72
  73     runUntilFail: 1 to re-run the test until it fails
  74
  75     Also, all of [the context creation attributes](https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2
  76
  77                   Example: some-test.html?powerPreference=high-performance&antialias=false&depth=false
  78
  79 The tests at https://www.khronos.org/registry/webgl/sdk/tests/ are kept up-to-date with a GitHub webhook. If you suspect these tests are not in sync with GitHub, please verify the webhook log file here:
  80
  81    https://www.khronos.org/webgl/pull-github/logs/github.log
  82
  83 History
  84 -------
  85
  86 The dates below are when work on the conformance suite version was started.
  87
  88 - 2011/02/24: Version 1.0.0
  89 - 2012/02/23: Version 1.0.1
  90 - 2012/03/20: Version 1.0.2
  91 - 2013/02/14: Version 1.0.3
  92 - 2013/10/11: Version 2.0.0
  93 - 2014/11/14: Version 1.0.4
  94 - 2016/11/21: Version 2.0.1