software-mansion / software-mansion/TypeGPU

docs: Std docs

Open
#1,485 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
3.2k
Forks
122
Avg merge
3d 5h
Merged PRs (30d)
34

Description

What I think would be useful to include:

  • info about JS and STD operators (add, sub, mul, div):
    • JS doesn't have operator overloading (yet), so we need extra functions for vectors and matrices,
    • our casts mimic WGSL casts, but still return numbers, so d.u32(1)/d.u32(2) is still 0.5,
    • (if #1022 is closed) the possibility of using infix notation,
  • we implement some of WGSL standard library, including arithmetic, atomic, synchronisation, packing and texture sampling operations (it probably is unnecessary to list all of the functions, a link to this file should be enough until we have auto-generated docs),
  • we provide TGSL implementations of some wgpu-matrix functions,
  • we provide some extra utilities like isCloseTo, allEq.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing packages/typegpu/src/std/index.ts, which the issue identifies as the current standard-library reference. Use the issue’s list of operators, WGSL-related functions, wgpu-matrix functions, and utilities to determine the documentation sections needed; done means these capabilities are described with an appropriate link until auto-generated docs exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.