-
Notifications
You must be signed in to change notification settings - Fork 0
docs: position compile() as the ergonomic-and-fast iteration path #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -104,9 +104,14 @@ for (const e of world.query(read(Velocity), write(Position))) { | |||||||||||
| Other query terms — `has(C)`, `without(C)`, and `optional(C)` — refine which entities | ||||||||||||
| match without (or optionally) binding accessors. | ||||||||||||
|
|
||||||||||||
| For the rare loop that needs every nanosecond, queries also offer a bind-once fast path, | ||||||||||||
| [`bindColumns`](/guide/performance#bind-your-loop-once-bindcolumns) — the | ||||||||||||
| [performance page](/guide/performance) covers it. | ||||||||||||
| When a hot loop matters, keep this exact ergonomic body and hand it to | ||||||||||||
| [`query.compile`](/guide/performance#compile-the-ergonomic-path-compile): it rewrites your | ||||||||||||
| `e.position.x += …` callback into a specialized column loop — roughly **6× faster than the plain | ||||||||||||
| `.each`**, on par with raw column access, and it still feeds `.changed()`/observers. It is a pure | ||||||||||||
| speedup that falls back to the normal loop for anything it can't compile, so there's no syntax to | ||||||||||||
| learn and no result to second-guess. (For the last nanosecond on a loop you're willing to write | ||||||||||||
| against raw typed arrays, [`bindColumns`](/guide/performance#bind-your-loop-once-bindcolumns) drops | ||||||||||||
| the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.) | ||||||||||||
| ### Deriving narrower queries | ||||||||||||
|
Comment on lines
+114
to
115
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: website/guide/core-concepts.md
Line: 114-115
Comment:
The closing parenthesis of the new paragraph runs directly into the `### Deriving narrower queries` heading with no blank line. Most Markdown parsers require a blank line before ATX headings to render them correctly.
```suggestion
the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.)
### Deriving narrower queries
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||||||||
|
|
||||||||||||
| `query.derive(...terms)` builds the query for *this query's terms plus the new ones*. | ||||||||||||
|
|
||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
query.compilelink points to the raw GitHub source viewer (github.com/.../blob/main/...) rather than the deployed docs site used everywhere else in this file (e.g.,https://andymai.github.io/ecsia/guide/performance). Readers will land on the Markdown source instead of the rendered documentation page.Prompt To Fix With AI
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!