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

Add first draft documenting OpenPBR support in Babylon.js #1272

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

virtualzavie
Copy link

This PR adds to the documentation a page about OpenPBR, serving 3 purposes:

  • Document the use of OpenPBR in Babylon.js
  • Document the state of the implementation of OpenPBR support
  • Document the remaining task for full support of OpenPBR

@bjsplat
Copy link

bjsplat commented Feb 5, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1272/merge

@sebavan sebavan requested a review from PatrickRyanMS February 5, 2025 13:57
@bjsplat
Copy link

bjsplat commented Feb 5, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1272/merge

Copy link
Member

@sebavan sebavan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Table formatting should be revisited but the rest looks good

@sebavan
Copy link
Member

sebavan commented Feb 5, 2025

@virtualzavie
Copy link
Author

Table formatting should be revisited but the rest looks good

Done at 4c5a96e. The layout looks correct to me now.

@bjsplat
Copy link

bjsplat commented Feb 5, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1272/merge

@RaananW
Copy link
Member

RaananW commented Feb 5, 2025

Table formatting should be revisited but the rest looks good

Done at 4c5a96e. The layout looks correct to me now.

Just making sure - it seems resolved. @sebavan - is it correct now?

@sebavan
Copy link
Member

sebavan commented Feb 5, 2025

Looks all good for me as well now 🤷

Copy link
Member

@PatrickRyanMS PatrickRyanMS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some general questions about FIXME in the doc. If we aren't done with the doc, maybe we should hold off on the initial PR so the page doesn't feel like it was pushed up incomplete. If these are not implemented, we should change the term so it is clear that the implementation is not done yet and the FIXME doesn't apply to the documentation.


| Parameter | Support in Babylon.js |
| ------------------------ | --------------------- |
| `base_weight` | Newly implemented |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we expand this description to give an indication of what it is? Something like "newly implemented scalar value that multiplies against albedo color"? Seems like it would be good to not send people out of our docs to track down what Open PBR parameters mean.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll definitely want the documentation to stand on its own, but I'm not quite there yet. We'll also have to find a balance so as not to repeat (and risk getting out of sync with) what's already described in the OpenPBR official documentation.

@bjsplat
Copy link

bjsplat commented Feb 6, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1272/merge

@sebavan
Copy link
Member

sebavan commented Feb 6, 2025

looks like it is ready to go ? can I move out of draft ?

@PatrickRyanMS
Copy link
Member

I looked it over again with the latest changes and it looks good to me.

@virtualzavie virtualzavie marked this pull request as ready for review February 6, 2025 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants