feat: generate preview

[mateuszJS]

Summary by CodeRabbit

• New Features

  • Introduced a live preview image that updates automatically to reflect the latest canvas content.
  • Added a preview image display to the interface for immediate visual feedback during asset updates.

• Improvements

  • Enhanced performance and responsiveness by generating preview images asynchronously and efficiently after texture changes.
  • Implemented a debounced mechanism to prevent unnecessary preview updates during rapid changes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A preview image feature was added to the application. The changes introduce a new generatePreview function for WebGPU rendering, update the creator initialization and run logic to support preview generation and display, add a debounced utility for efficient updates, and modify the integration test template to include a preview image element.

Changes

Cohort / File(s)	Change Summary
Integration Test Preview Image integration-tests/template.html, integration-tests/index.ts	Added an image element with ID "preview" in the HTML template and updated the test script to set its src with the rendered preview from the canvas.
WebGPU Preview Generation src/WebGPU/generatePreview.ts	Introduced an async generatePreview function to render a preview on a square canvas using WebGPU, adjusting camera and rendering settings as needed.
Creator Initialization and Lifecycle src/index.ts, src/run.ts	Extended initCreator and runCreator signatures to support preview updates and asynchronous preview capture. Adjusted lifecycle management to integrate preview generation and display.
Debounce Utility src/utils/debounce.ts	Added a generic debounce function to delay execution of callbacks, used for efficient preview generation after texture uploads.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (index.ts)
    participant Debounce
    participant WebGPU (generatePreview.ts)
    participant Renderer (run.ts)
    participant PreviewImg

    User->>UI (index.ts): Uploads/changes texture
    UI (index.ts)->>Debounce: Schedule preview generation
    Debounce-->>UI (index.ts): After delay, triggers
    UI (index.ts)->>WebGPU (generatePreview.ts): generatePreview(...)
    WebGPU (generatePreview.ts)->>Renderer (run.ts): capturePreview(...)
    Renderer (run.ts)-->>WebGPU (generatePreview.ts): Preview canvas rendered
    WebGPU (generatePreview.ts)->>UI (index.ts): onPreviewUpdate(previewCanvas)
    UI (index.ts)->>PreviewImg: Set src to previewCanvas.toDataURL()

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Possibly related PRs

• fix: naming of assets and textures #34: Refactors texture management by centralizing texture loading and access; related context of texture and rendering lifecycle changes overlapping with preview generation integration.

Poem

🐇✨
A canvas square, a preview bright,
Now updates live, a charming sight!
With debounce swift and WebGPU’s might,
The bunny hops to check it’s right.
A snapshot quick, a rendering true—
Preview magic, just for you!
🖼️🌈

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e4b541 and f0585a9.

📒 Files selected for processing (6)

• integration-tests/index.ts (2 hunks)
• integration-tests/template.html (1 hunks)
• src/WebGPU/generatePreview.ts (1 hunks)
• src/index.ts (6 hunks)
• src/run.ts (4 hunks)
• src/utils/debounce.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch generate-preview

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

🎉 This PR is included in version 0.1.0-next.21 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀