Index of Test Helpers

This index is a quick-reference of helper functions in the test suite. Use it to determine whether you can reuse a helper, instead of writing new code, to improve readability and reviewability.

Whenever a new generally-useful helper is added, it should be indexed here.

See linked documentation for full helper listings.

• common/framework/params_builder!CaseParamsBuilder and common/framework/params_builder!SubcaseParamsBuilder: Combinatorial generation of test parameters. They are iterated by the test framework at runtime. See examples.spec.ts for basic examples of how this behaves.
  • common/framework/params_builder!CaseParamsBuilder: ParamsBuilder for adding "cases" to a test.
  • common/framework/params_builder!CaseParamsBuilder#beginSubcases: "Finalizes" the CaseParamsBuilder, returning a SubcaseParamsBuilder.
  • common/framework/params_builder!SubcaseParamsBuilder: ParamsBuilder for adding "subcases" to a test.

Fixtures

(Uncheck the "Inherited" box to hide inherited methods from documentation pages.)

• common/framework/fixture!Fixture: Base fixture for all tests.
• webgpu/gpu_test!GPUTest: Base fixture for WebGPU tests.
• webgpu/api/validation/validation_test!ValidationTest: Base fixture for WebGPU validation tests.
• webgpu/shader/validation/shader_validation_test!ShaderValidationTest: Base fixture for WGSL shader validation tests.
• webgpu/idl/idl_test!IDLTest: Base fixture for testing the exposed interface is correct (without actually using WebGPU).

WebGPU Helpers

• webgpu/capability_info: Structured information about texture formats, binding types, etc.
• webgpu/constants: Constant values (needed anytime a WebGPU constant is needed outside of a test function).
• webgpu/util/buffer: Helpers for GPUBuffers.
• webgpu/util/texture: Helpers for GPUTextures.
• webgpu/util/unions: Helpers for various union typedefs in the WebGPU spec.
• webgpu/util/math: Helpers for common math operations.
• webgpu/util/check_contents: Check the contents of TypedArrays, with nice messages. Also can be composed with webgpu/gpu_test!GPUTest#expectGPUBufferValuesPassCheck, used to implement GPUBuffer checking helpers in GPUTest.
• webgpu/util/conversion: Numeric encoding/decoding for float/unorm/snorm values, etc.
• webgpu/util/copy_to_texture: Helper class for copyToTexture test suites for execution copy and check results.
• webgpu/util/color_space_conversion: Helper functions to do color space conversion. The algorithm is the same as defined in CSS Color Module Level 4.
• webgpu/util/create_elements: Helpers for creating web elements like HTMLCanvasElement, OffscreenCanvas, etc.
• webgpu/util/shader: Helpers for creating fragment shader based on intended output values, plainType, and componentCount.
• webgpu/util/prng: Seed-able deterministic pseudo random number generator. Replacement for Math.random().
• webgpu/util/texture/base: General texture-related helpers.
• webgpu/util/texture/data_generation: Helper for generating dummy texture data.
• webgpu/util/texture/layout: Helpers for working with linear image data (like in copyBufferToTexture, copyTextureToBuffer, writeTexture).
• webgpu/util/texture/subresource: Helpers for working with texture subresource ranges.
• webgpu/util/texture/texel_data: Helpers encoding/decoding texel formats.
• webgpu/util/texture/texel_view: Helper class to create and view texture data through various representations.
• webgpu/util/texture/texture_ok: Helpers for checking texture contents.
• webgpu/shader/types: Helpers for WGSL data types.
• webgpu/shader/execution/expression/expression: Helpers for WGSL expression execution tests.
• webgpu/web_platform/util: Helpers for web platform features (e.g. video elements).

General Helpers

• common/framework/resources: Provides the path to the resources/ directory.
• common/util/navigator_gpu: Finds and returns the navigator.gpu object or equivalent.
• common/util/util: Miscellaneous utilities.
  • common/util/util!assert: Assert a condition, otherwise throw an exception.
  • common/util/util!unreachable: Assert unreachable code.
  • common/util/util!assertReject, common/util/util!resolveOnTimeout, common/util/util!rejectOnTimeout, common/util/util!raceWithRejectOnTimeout, and more.
• common/util/collect_garbage: Attempt to trigger garbage collection, for testing that garbage collection is not observable.
• common/util/preprocessor: A simple template-based, non-line-based preprocessor, implementing if/elif/else/endif. Possibly useful for WGSL shader generation.
• common/util/timeout: Use this instead of setTimeout.
• common/util/types: Type metaprogramming helpers.