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

Updated documentation of RequestRenderNextUpdate #3368

Merged
merged 4 commits into from Feb 17, 2021

Conversation

fredericv-unity3d
Copy link
Contributor

Purpose of this PR

Added information to a method documentation for better understanding. (See https://fogbugz.unity3d.com/f/cases/1290521).


Testing status

No code was changed, only the documentation.


Comments to reviewers

Doc: please review the modified documentation.

Copy link
Contributor

@JordanL8 JordanL8 left a comment

Choose a reason for hiding this comment

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

Reworded to use active voice. Can you replace the other one with this too? Thanks

@@ -27,6 +27,8 @@ public static class HDAdditionalReflectionDataExtensions
/// be rendered the next time it will influence a camera rendering.
///
/// If the probe don't have a <see cref="HDAdditionalReflectionData"/> component, nothing is done.
///
/// Note: A camera is influenced by a probe if the camera's frustum intersects the probe's influence volume.
Copy link
Contributor

Choose a reason for hiding this comment

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

Note: If any part of a Camera's frustum intersects a Reflection Probe's influence volume, the Reflection Probe influences the Camera.

@sebastienlagarde
Copy link
Collaborator

@fredericv-unity3d any update?

@sebastienlagarde
Copy link
Collaborator

@fredericv-unity3d can you update this PR? thanks

@fredericv-unity3d
Copy link
Contributor Author

Sorry for the delay, the github notification was lost somehow

Copy link
Contributor

@JordanL8 JordanL8 left a comment

Choose a reason for hiding this comment

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

Moved the extra information into remarks and reworded some bits. Looks good to me :)

@fredericv-unity3d fredericv-unity3d marked this pull request as ready for review February 17, 2021 15:18
@sebastienlagarde sebastienlagarde merged commit 0818713 into hd/bugfix Feb 17, 2021
@sebastienlagarde sebastienlagarde deleted the hd/bugfix_request_render_next_update_doc branch February 17, 2021 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants