Skip to content

Updated documentation of RequestRenderNextUpdate #3368

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 17, 2021
Merged

Updated documentation of RequestRenderNextUpdate #3368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc132b4
Updated documentation of RequestRenderNextUpdate
fredericv-unity3d Feb 3, 2021
144f083
Fixed documentation
fredericv-unity3d Feb 17, 2021
8e39b6d
Update HDProbe.cs
JordanL8 Feb 17, 2021
40c84d0
Update HDAdditionalReflectionData.cs
JordanL8 Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions ...ender-pipelines.high-definition/Runtime/Lighting/Reflection/HDAdditionalReflectionData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@ void Awake()
public static class HDAdditionalReflectionDataExtensions
{
/// <summary>
/// Request to render this probe next update.
/// Requests that Unity renders the passed in Reflection Probe during the next update.
/// </summary>
/// <remarks>
/// If you call this method for a Reflection Probe using <see cref="ProbeSettings.RealtimeMode.OnDemand"/> mode, Unity renders the probe the next time the probe influences a Camera rendering.
///
/// Call this method with the mode <see cref="ProbeSettings.RealtimeMode.OnDemand"/> and the probe will
/// be rendered the next time it will influence a camera rendering.
/// If the Reflection Probe doesn't have an attached <see cref="HDAdditionalReflectionData"/> component, calling this function has no effect.
///
/// If the probe don't have a <see cref="HDAdditionalReflectionData"/> component, nothing is done.
/// </summary>
/// <param name="probe">The probe to request a render.</param>
/// Note: If any part of a Camera's frustum intersects a Reflection Probe's influence volume, the Reflection Probe influences the Camera.
/// </remarks>
/// <param name="probe">The Reflection Probe to request a render for.</param>
public static void RequestRenderNextUpdate(this ReflectionProbe probe)
{
var add = probe.GetComponent<HDAdditionalReflectionData>();
Expand Down
12 changes: 8 additions & 4 deletions com.unity.render-pipelines.high-definition/Runtime/Lighting/Reflection/HDProbe.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,11 +534,15 @@ internal void SetIsRendered()
public virtual void PrepareCulling() {}

/// <summary>
/// Request to render this probe next update.
///
/// Call this method with the mode <see cref="ProbeSettings.RealtimeMode.OnDemand"/> and the probe will
/// be rendered the next time it will influence a camera rendering.
/// Requests that Unity renders this Reflection Probe during the next update.
/// </summary>
/// <remarks>
/// If the Reflection Probe uses <see cref="ProbeSettings.RealtimeMode.OnDemand"/> mode, Unity renders the probe the next time the probe influences a Camera rendering.
///
/// If the Reflection Probe doesn't have an attached <see cref="HDAdditionalReflectionData"/> component, calling this function has no effect.
///
/// Note: If any part of a Camera's frustum intersects a Reflection Probe's influence volume, the Reflection Probe influences the Camera.
/// </remarks>
public void RequestRenderNextUpdate() => m_WasRenderedSinceLastOnDemandRequest = false;

// Forces the re-rendering for both OnDemand and OnEnable
Expand Down