Skip to content

Conversation

@protam12
Copy link
Contributor

@protam12 protam12 commented Jul 4, 2025

Right now, the class description states:

Note: Reflection probes are only supported in the Forward+ and Mobile rendering methods, not Compatibility.

This has been fixed in Godot 4.3 ( #88056 ) and the documentation page has been updated, but the class page remains unfixed. This PR aims to fix this by changing the third paragraph in the class page:

Note: Reflection probes are only supported in the Forward+ and Mobile rendering methods, not Compatibility. When using the Mobile rendering method, only 8 reflection probes can be displayed on each mesh resource. Attempting to display more than 8 reflection probes on a single mesh resource will result in reflection probes flickering in and out as the camera moves.

to this:

Note: When using the Mobile rendering method, only 8 reflection probes can be displayed on each mesh resource, while the Compatibility rendering method only supports up to 2 reflection probes on each mesh. Attempting to display more than 8 reflection probes on a single mesh resource using the Mobile renderer will result in reflection probes flickering in and out as the camera moves, while the Compatibility renderer will not render any additional probes if more than 2 reflection probes are being used.

@protam12 protam12 requested a review from a team as a code owner July 4, 2025 11:02
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release labels Jul 4, 2025
@AThousandShips AThousandShips added this to the 4.x milestone Jul 4, 2025
@clayjohn clayjohn modified the milestones: 4.x, 4.5 Jul 4, 2025
Copy link
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@protam12
Copy link
Contributor Author

protam12 commented Jul 5, 2025

I'm sorry for being a bit late. Thank you all for the reviews and suggestions!

@Repiteo
Copy link
Contributor

Repiteo commented Jul 18, 2025

Could you squash the commits? See our PR workflow documentation for details: https://docs.godotengine.org/en/latest/contributing/workflow/pr_workflow.html#the-interactive-rebase

@protam12
Copy link
Contributor Author

I'm sorry for being late (again), but the fixup is finally done! Let me know if anything else is missing.

Copy link
Contributor

@Repiteo Repiteo left a comment

Choose a reason for hiding this comment

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

No worries, and everything looks good!

@Repiteo Repiteo merged commit 465c988 into godotengine:master Jul 28, 2025
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Jul 28, 2025

Thanks! Congratulations on your first merged contribution! 🎉

Handagotes pushed a commit to Handagotes/godot that referenced this pull request Jul 30, 2025
Class docs: Fix ReflectionProbe note regarding Compatibility renderer support
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants