Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document shared systems up to B #9794

Merged
merged 5 commits into from
Oct 27, 2023
Merged

Document shared systems up to B #9794

merged 5 commits into from
Oct 27, 2023

Conversation

GoodBoyDigital
Copy link
Member

@GoodBoyDigital GoodBoyDigital commented Oct 27, 2023

馃 Generated by Copilot at d627be3

Summary

馃摑馃敡馃帹

This pull request improves the documentation and code quality of the rendering core classes and functions in PixiJS, adding JSDoc comments, refactoring, and fixing some errors. It also updates the visual tests to remove the unsupported canvas renderer option. The main files affected are autoDetectRenderer.ts, BackgroundSystem.ts, BlendModePipe.ts, Buffer.ts, BufferResource.ts, and init.ts.

We are the rendering core, we document our code
We use JSDoc comments, we make our classes shine
We refactor and export, we fix the TypeScript errors
We are the rendering core, we rock the PixiJS world

Walkthrough

  • Document the rendering core classes and types, adding JSDoc comments to the rendering namespace, the autoDetectRenderer function, the AutoDetectOptions, BackgroundSystemOptions, TypedArray, and BufferOptions interfaces, the BackgroundSystem, BlendModePipe, Buffer, and BufferResource classes, the BufferUsage enum, and the fastCopy function (link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link)
  • Move the AutoDetectOptions, BackgroundSystemOptions, TypedArray, and BufferOptions interfaces and the BackgroundSystem class from their original files to src/rendering/init.ts, where they are exported and consistent with other rendering options interfaces and systems (link, link, link)
  • Fix a TypeScript error in the Buffer.destroy method by casting this.descriptor to any before assigning it to null (link)
  • Remove an empty line from the Buffer class constructor for code style (link)
  • Update the visual tests to remove the canvas option from the renderTest function and its calls, as the canvas renderer is no longer supported in PixiJS v6 (link, link)

- added rendering namespace
- remove canvas as render option for now
@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 27, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 53670d2:

Sandbox Source
pixi.js-sandbox Configuration

@Zyie Zyie added the v8 label Oct 27, 2023
Base automatically changed from chore/v8/filter-docs to next-v8 October 27, 2023 13:13
@Zyie Zyie merged commit bf0a7f7 into next-v8 Oct 27, 2023
3 checks passed
@Zyie Zyie deleted the chore/v8/system-docs branch October 27, 2023 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants