search

galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://galacean.antgroup.com/engine
MIT License
4.2k stars 299 forks source link

Refactoring the ShaderLab Compiler Module using the LALR Algorithm for Enhanced GLSL Compatibility and Reduced Build Size #2113

Closed Sway007 closed 2 months ago

Sway007 commented 3 months ago

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

In this update, we made a significant overhaul of the ShaderLab module, employing the LALR (Look-Ahead Left-to-Right) parsing algorithm to achieve several substantial improvements over the previous version. This refactoring effort aligns more closely with the GLES syntax standard, providing improved compatibility with the GLSL language. Below are the key highlights of this update:

  1. Completely Rewrite using the LALR Algorithm The compiler has been rebuilt from the ground up utilizing the LALR algorithm. This strategic choice not only enhances the parsing efficiency but also ensures that our compiler adheres closely to the GLES syntax standard. Through this approach, we have achieved a more robust compatibility with GLSL, catering to a wider range of shader programming needs.

  2. Elimination of Third-party Dependency A significant advancement in this version is the removal of third-party package chevrotain dependency. This decision drastically reduces the overall package size, leading to leaner build outputs. This reduction in dependencies not only simplifies the build process but also minimizes potential conflicts and enhances the portability of the compiler.

  3. User-friendly Programming with Less Syntax Restriction Compared to version 1.2, the current iteration of the compiler introduces fewer syntax restrictions, offering a more user-friendly programming experience. We've also simplified syntax extension, making it easier for developers to introduce new features and customizations. This flexibility encourages experimentation and innovation within shader programming.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

  1. Struct declaration mandates a semicolon at the end of a struct declaration

    struct Light {
    vec4 position;
    vec4 color;
}

    After update

    struct Light {
    vec4 position;
    vec4 color;
};

  2. Declare shader main entry function (vertex and fragment shader main) assignment after main function definition

    Pass "default" {
    ...
    VertexShader = vert;
    FragmentShader = frag;

    v2f vert(a2v o) {
        ...
    }

    void frag(v2f i) {
       ...
    }
    ...
}

    After update

    Pass "default" {
    ...
    v2f vert(a2v o) {
        ...
    }

    void frag(v2f i) {
       ...
    }

    VertexShader = vert;
    FragmentShader = frag;
    ...
}
zhuxudong commented 3 months ago

VertexShader = *** can before function definition in Unity

zhuxudong commented 3 months ago
zhuxudong commented 3 months ago
zhuxudong commented 3 months ago
zhuxudong commented 3 months ago
zhuxudong commented 3 months ago
zhuxudong commented 3 months ago
coderabbitai[bot] commented 3 months ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

75 files out of 147 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@coderabbitai modularize this function.` - 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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
GuoLei1990 commented 2 months ago

Merge logger to engine logger