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(Float): add autoInvalidate prop for on-demand rendering #2034

Conversation

AaronClaes
Copy link
Contributor

@AaronClaes AaronClaes commented Jul 16, 2024

Why

Fixes #2033

The Float component does not work when the Canvas frameloop is set to demand.

What

I added the autoInvalidate prop that can be set to true when using on-demand rendering.
This will ensure that invalidate is called while Float is enabled.

After a discussion in the community Discord, it was decided that calling invalidate should be opt-in to ensure the developer controls the frameloop.

The default is false to prevent this from being a breaking change.

Checklist

  • Documentation updated
  • Ready to be merged

Copy link

vercel bot commented Jul 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
drei ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2024 4:27pm

Copy link

codesandbox-ci bot commented Jul 16, 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.

@AaronClaes AaronClaes changed the title fix(Float): add invalidate to useFrame for on-demand rendering feat(Float): add autoInvalidate prop for on-demand rendering Jul 17, 2024
@AaronClaes AaronClaes marked this pull request as ready for review July 17, 2024 18:43
@CodyJasonBennett CodyJasonBennett merged commit 690f7a0 into pmndrs:master Jul 22, 2024
5 checks passed
Copy link

🎉 This PR is included in version 9.109.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-merge-queue bot pushed a commit to 3um-Group/3UM_Website that referenced this pull request Aug 31, 2024
![snyk-top-banner](https://github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)

<h3>Snyk has created this PR to upgrade @react-three/drei from 9.108.3
to 9.109.5.</h3>

:information_source: Keep your dependencies up-to-date. This makes it
easier to fix existing vulnerabilities and to more quickly identify and
fix newly disclosed vulnerabilities when they affect your project.

<hr/>

- The recommended version is **7 versions** ahead of your current
version.

- The recommended version was released on **23 days ago**.

<details>
<summary><b>Release notes</b></summary>
<br/>
  <details>
    <summary>Package name: <b>@react-three/drei</b></summary>
    <ul>
      <li>
<b>9.109.5</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.5">2024-08-08</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.109.4...v9.109.5">9.109.5</a>
(2024-08-08)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>Billboard:</strong> don't disable matrix update (<a
href="pmndrs/drei#2063"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2063/hovercard">#2063</a>) (<a
href="https://github.com/pmndrs/drei/commit/f4f910f76f48e16ef73c52f2d69bd5bbf96a138e">f4f910f</a>)</li>
</ul>
      </li>
      <li>
<b>9.109.4</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.4">2024-08-08</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.109.3...v9.109.4">9.109.4</a>
(2024-08-08)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>yarn4 prebuild (<a href="pmndrs/drei#2062"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2062/hovercard">#2062</a>) (<a
href="https://github.com/pmndrs/drei/commit/e99c07a76151c21d48d102bc7e549b8cf5753c90">e99c07a</a>)</li>
</ul>
      </li>
      <li>
<b>9.109.3</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.3">2024-08-07</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.109.2...v9.109.3">9.109.3</a>
(2024-08-07)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>Svg:</strong> patch for three r152 (<a
href="pmndrs/drei#2061"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2061/hovercard">#2061</a>) (<a
href="https://github.com/pmndrs/drei/commit/9f9b268df48aca792b6462e4c67ba713410f4b4c">9f9b268</a>)</li>
</ul>
      </li>
      <li>
<b>9.109.2</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.2">2024-07-23</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.109.1...v9.109.2">9.109.2</a>
(2024-07-23)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>Outlines:</strong> use correct uniform type (<a
href="pmndrs/drei#2048"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2048/hovercard">#2048</a>) (<a
href="https://github.com/pmndrs/drei/commit/bd8c036bf40b8ac5cd57403914d9945f8d32d16e">bd8c036</a>)</li>
</ul>
      </li>
      <li>
<b>9.109.1</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.1">2024-07-22</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.109.0...v9.109.1">9.109.1</a>
(2024-07-22)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>dispose line material (<a
href="pmndrs/drei#2039"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2039/hovercard">#2039</a>) (<a
href="https://github.com/pmndrs/drei/commit/816650a67a6f5f28108c0012024452f5bdb772f3">816650a</a>)</li>
</ul>
      </li>
      <li>
<b>9.109.0</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.109.0">2024-07-22</a></br><h1><a
href="https://github.com/pmndrs/drei/compare/v9.108.4...v9.109.0">9.109.0</a>
(2024-07-22)</h1>
<h3>Features</h3>
<ul>
<li><strong>Float:</strong> add autoInvalidate prop for on-demand
rendering (<a href="pmndrs/drei#2034"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2034/hovercard">#2034</a>) (<a
href="https://github.com/pmndrs/drei/commit/690f7a0a561d5cad47f1aae430ef93ba6f6f8af9">690f7a0</a>)</li>
</ul>
      </li>
      <li>
<b>9.108.4</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.108.4">2024-07-15</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.108.3...v9.108.4">9.108.4</a>
(2024-07-15)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>useEnvironment:</strong> remove gainmap from cache after
webgl context lost (<a href="pmndrs/drei#2029"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2029/hovercard">#2029</a>) (<a
href="https://github.com/pmndrs/drei/commit/b50a2d4b1a1278ae36058b9b53b85a00ef195762">b50a2d4</a>)</li>
</ul>
      </li>
      <li>
<b>9.108.3</b> - <a
href="https://github.com/pmndrs/drei/releases/tag/v9.108.3">2024-07-07</a></br><h2><a
href="https://github.com/pmndrs/drei/compare/v9.108.2...v9.108.3">9.108.3</a>
(2024-07-07)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>MeshRefractionMaterial:</strong> use color chunks, support
opacity prop (<a href="pmndrs/drei#2020"
data-hovercard-type="pull_request"
data-hovercard-url="/pmndrs/drei/pull/2020/hovercard">#2020</a>) (<a
href="https://github.com/pmndrs/drei/commit/7ceab1af8cebe9bf11d791edf60df8df7db04abf">7ceab1a</a>)</li>
</ul>
      </li>
    </ul>
from <a href="https://github.com/pmndrs/drei/releases">@react-three/drei
GitHub release notes</a>
  </details>
</details>

---

> [!IMPORTANT]
>
> - Check the changes in this PR to ensure they won't cause issues with
your project.
> - This PR was automatically created by Snyk using the credentials of a
real user.

---

**Note:** _You are seeing this because you or someone else with access
to this repository has authorized Snyk to open upgrade PRs._

**For more information:** <img
src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiIwMzI3OGYzMC1hOTUwLTQ2MzUtOGUzNi01ZDFmYmVhMzgwZDciLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6IjAzMjc4ZjMwLWE5NTAtNDYzNS04ZTM2LTVkMWZiZWEzODBkNyJ9fQ=="
width="0" height="0"/>

> - 🧐 [View latest project
report](https://app.snyk.io/org/3um-group/project/9553dc1c-e7c4-4a83-81ea-024571aa73a5?utm_source&#x3D;github-cloud-app&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 📜 [Customise PR
templates](https://docs.snyk.io/scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates)
> - 🛠 [Adjust upgrade PR
settings](https://app.snyk.io/org/3um-group/project/9553dc1c-e7c4-4a83-81ea-024571aa73a5/settings/integration?utm_source&#x3D;github-cloud-app&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 🔕 [Ignore this dependency or unsubscribe from future upgrade
PRs](https://app.snyk.io/org/3um-group/project/9553dc1c-e7c4-4a83-81ea-024571aa73a5/settings/integration?pkg&#x3D;&amp;utm_source&#x3D;github-cloud-app&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr#auto-dep-upgrades)

[//]: #
'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"","from":"react-three/drei","to":"react-three/drei"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"03278f30-a950-4635-8e36-5d1fbea380d7","prPublicId":"03278f30-a950-4635-8e36-5d1fbea380d7","packageManager":"npm","priorityScoreList":[],"projectPublicId":"9553dc1c-e7c4-4a83-81ea-024571aa73a5","projectUrl":"https://app.snyk.io/org/3um-group/project/9553dc1c-e7c4-4a83-81ea-024571aa73a5?utm_source=github-cloud-app&utm_medium=referral&page=upgrade-pr","prType":"upgrade","templateFieldSources":{"branchName":"default","commitMessage":"default","description":"default","title":"default"},"templateVariants":[],"type":"auto","upgrade":[],"upgradeInfo":{"versionsDiff":7,"publishedDate":"2024-08-08T12:07:55.133Z"},"vulns":[]}'
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.

Float does not work with on demand rendering
2 participants