feat: Adds gl2D file format support #11628
Draft
+1,890
−69
Conversation
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
Implements initial support for the gl2D file format, enabling the serialization of PixiJS scenes into a JSON-based structure. - Introduces core gl2D file structure, including assets, scenes, nodes, and resources. - Adds extension capabilities for custom metadata. - Enables serialization of containers, sprites, textures, and sources. - Adds documentation for the gl2D file format.
|
pixi.js-base • pixi.js-bunny-mark commit: |
|
I'm SUPER excited about the opportunities and tooling this will enable for working with Pixi. Remind me a lot of the best of working with Flash where it was so much easier to decouple the view and logic. |
Moves gl2D serialization to a class for better organization and future extensibility. It also renames a utility function to more accurately reflect its purpose and updates relevant references.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR introduces initial support for the gl2D file format, which enables serialization of PixiJS scenes into a JSON-based structure. The goal is to provide a standardized way to save, load, and share any 2D scenes, while ensuring resources can be efficiently reused across nodes and scenes.
Design
A scene is represented as two main components:
For textures specifically:
Additionally, all nodes and resources can be extended via extensions, allowing custom metadata and features to be attached.
Example API
gl2D Spec
gl2D Spec & Example
Example JSON
{ "asset": { "generator": "PixiJS", "version": "1.0" }, "extensionsUsed": [ "pixi_container_node", "pixi_texture_source_resource", "pixi_texture_resource", "pixi_sprite_node" ], "extensionsRequired": ["pixi_container_node"], "resources": [ { "uid": "texture_source_3", "type": "image_source", "uri": "/assets/bunny.1.webp", "width": 26, "height": 37, "resolution": 1, "format": "bgra8unorm", "antialias": false, "alphaMode": "premultiply-alpha-on-upload", "addressModeU": "clamp-to-edge", "addressModeV": "clamp-to-edge", "addressModeW": "clamp-to-edge", "magFilter": "linear", "minFilter": "linear", "mipmapFilter": "linear", "extensions": { "pixi_texture_source_resource": { "autoGarbageCollect": true, "mipLevelCount": 1, "maxAnisotropy": 1, "dimensions": "2d", "autoGenerateMipmaps": false } } }, { "type": "texture", "uid": "texture_3", "name": "http://localhost:8081/assets/bunny.1.webp", "frame": [0, 0, 26, 37], "source": 0, "extensions": { "pixi_texture_resource": { "orig": [0, 0, 26, 37], "rotate": 0, "dynamic": false } } } ], "nodes": [ { "type": "container", "uid": "container_2", "children": [1], "alpha": 1, "visible": true, "tint": 16777215, "blendMode": "inherit", "extensions": { "pixi_container_node": { "skew": [0, 0], "pivot": [0, 0], "origin": [0, 0], "isRenderGroup": false, "zIndex": 0, "sortableChildren": false, "renderable": true } } }, { "name": "Sprite", "type": "sprite", "uid": "container_4", "children": [], "matrix": [1, 0, 24, 0, 1, 24, 0, 0, 1], "alpha": 1, "visible": true, "tint": 16777215, "blendMode": "inherit", "extensions": { "pixi_container_node": { "skew": [0, 0], "pivot": [0, 0], "origin": [0, 0], "isRenderGroup": false, "zIndex": 0, "sortableChildren": false, "renderable": true, "anchor": [0, 0] }, "pixi_sprite_node": { "roundPixels": false } }, "texture": 1 } ] }NOTE
This is the first of several PR that will add all the different resources and node types, along with the deserialisation methods. Just splitting everything up to be more manageable.