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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: expose Caustics materials and types as public API #64

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

nartc
Copy link
Contributor

@nartc nartc commented Jul 15, 2024

This PR exposes Caustics materials and types as public API. I didn't document the public API for the change because the current state of the README doesn't state what's exposed as public API. Please let me know if you want this documented in the README.

Why

Caustics export only the Caustics function to create the entire Caustics construct and the update function. This makes it trickier for declarative framework integrations that allow for:

  • Updating parameters without recreating Caustics by using their templating language (jsx, html etc...)
  • Content Projection / Rendering Children where content/children is supposed to go (as children of the exposed scene)

What

  • Expose the materials and their types as public API
  • Add createCausticsUpdate function to create an update function that the consumers can call in their animation loop implementations.

Checklist

  • Documentation updated
  • Ready to be merged

Copy link

codesandbox-ci bot commented Jul 15, 2024

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.

@nartc nartc force-pushed the expose-caustics branch 5 times, most recently from ec72144 to 686ac6d Compare July 15, 2024 21:14
This PR exposes Caustics materials and types as public API
@vis-prime vis-prime merged commit 92ddad6 into pmndrs:main Jul 16, 2024
1 check passed
Copy link

🎉 This PR is included in version 1.19.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

2 participants