From 883ef693223335388c30155e0cd9ac559e5dd60d Mon Sep 17 00:00:00 2001 From: Robert Jessop Date: Wed, 15 Nov 2023 16:15:38 +0000 Subject: [PATCH] 2023.2/documentation staging Regular docs sync to main --- .../Documentation~/Building-For-Consoles.md | 16 ---------------- .../Upgrading-from-2023.1-to-2023.2.md | 6 ++++++ .../CHANGELOG.md | 4 ++-- .../Documentation~/upgrade-guide-2023-2.md | 8 ++++++++ 4 files changed, 16 insertions(+), 18 deletions(-) delete mode 100644 Packages/com.unity.render-pipelines.high-definition/Documentation~/Building-For-Consoles.md diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Building-For-Consoles.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Building-For-Consoles.md deleted file mode 100644 index ca2f97ae6de..00000000000 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Building-For-Consoles.md +++ /dev/null @@ -1,16 +0,0 @@ -# Building your Project for consoles [[TODO: DELETE]] - -To build a Project for the **PlayStation 4**, **PlayStation 5**, **Game Core Xbox Series**, **Game Core Xbox One** or **Xbox One**, you need to install an additional package for each platform you want to support. The packages for each platform are: - -- **PlayStation 4**: com.unity.render-pipelines.ps4 -- **PlayStation 5**: com.unity.render-pipelines.ps5 -- **Xbox One**: com.unity.render-pipelines.xboxone -- **Game Core Xbox Series**: com.unity.render-pipelines.gamecore -- **Game Core Xbox One**: com.unity.render-pipelines.gamecore - -## Platform package installation - -To install a platform package, download it from the relevant platform developer forum (you cannot get these packages from the package registry or Package Manager). To do this: - -1. Download the package for the platform that your Project targets. You can find each package on its respective platform developer forum. The download link is in the same location as the Unity installer for that platform. -2. Use the Package Manager to install the package locally. For information on how to install local packages, see[ Installing a local package](https://docs.unity3d.com/Manual/upm-ui-local.html). diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2023.1-to-2023.2.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2023.1-to-2023.2.md index f4355121896..df88e53bba4 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2023.1-to-2023.2.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2023.1-to-2023.2.md @@ -22,3 +22,9 @@ The HDRP Default Volume defines the default values for the Default layer and all ## Light Baking From version 16, baked probe volumes and lightmaps that contain lights that use the **Mixed** mode take the **Intensity multiplier** property into account. + +## Volume Framework + +When you create a custom Volume component class that overrides the `VolumeComponent.Override(VolumeComponent state, float interpFactor)` method, your implementation must set the `VolumeParameter.overrideState` property to `true` whenever the `VolumeParameter` value is changed. This ensures that the Volume framework resets the parameters to their correct default values. This lets the framework to use fewer resources every frame which improves performance. + +For an example, refer to the [Override(VolumeComponent, float)](xref:UnityEngine.Rendering.VolumeParameter.overrideState) description. diff --git a/Packages/com.unity.render-pipelines.universal/CHANGELOG.md b/Packages/com.unity.render-pipelines.universal/CHANGELOG.md index 06dcbaa5c30..b0771d35d4b 100644 --- a/Packages/com.unity.render-pipelines.universal/CHANGELOG.md +++ b/Packages/com.unity.render-pipelines.universal/CHANGELOG.md @@ -965,7 +965,7 @@ This version is compatible with Unity 2022.2.0a8. - Fixed an issue where Terrain hole Shader changes were missing. [Case 1179808](https://issuetracker.unity3d.com/issues/terrain-brush-tool-is-not-drawing-when-paint-holes-is-selected). - Fixed an issue where the Shader Graph `SceneDepth` node didn't work with XR single-pass (double-wide) rendering. See [case 1123069](https://issuetracker.unity3d.com/issues/lwrp-vr-shadergraph-scenedepth-doesnt-work-in-single-pass-rendering). - Fixed Unlit and BakedLit shader compilations in the meta pass. -- Fixed an issue where the Bokeh Depth of Field shader would fail to compile on PS4. +- Fixed an issue where the Bokeh Depth of Field shader would fail to compile on a console platform. - Fixed an issue where the Scene lighting button didn't work when you used the 2D Renderer. - Fixed a performance regression when you used the 2D Renderer. - Fixed an issue where the Freeform 2D Light gizmo didn't correctly show the Falloff offset. @@ -1556,7 +1556,7 @@ Read/write XRGraphicsConfig -> Read-only XRGraphics interface to XRSettings. ### Fixed - Post-processing now works with VR on PC. -- PS4 compiler error +- Console platform compiler error - Fixed VR multiview rendering by forcing MSAA to be off. There's a current issue in engine that breaks MSAA and Texture2DArray. - Fixed UnityPerDraw CB layout - GLCore compute buffer compiler error diff --git a/Packages/com.unity.render-pipelines.universal/Documentation~/upgrade-guide-2023-2.md b/Packages/com.unity.render-pipelines.universal/Documentation~/upgrade-guide-2023-2.md index 516c740b4a1..6c66fb45422 100644 --- a/Packages/com.unity.render-pipelines.universal/Documentation~/upgrade-guide-2023-2.md +++ b/Packages/com.unity.render-pipelines.universal/Documentation~/upgrade-guide-2023-2.md @@ -4,6 +4,14 @@ This page describes how to upgrade from an older version of the Universal Render For information on converting assets made for a Built-in Render Pipeline project to assets compatible with URP, see the page [Render Pipeline Converter](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@14.0/manual/features/rp-converter.html). +## Upgrading from URP 15 (Unity 2023.1) + +### Volume Framework + +When you create a custom Volume component class that overrides the `VolumeComponent.Override(VolumeComponent state, float interpFactor)` method, your implementation must set the `VolumeParameter.overrideState` property to `true` whenever the `VolumeParameter` value is changed. This ensures that the Volume framework resets the parameters to their correct default values. This lets the framework to use fewer resources every frame which improves performance. + +For an example, refer to the [Override(VolumeComponent, float)](xref:UnityEngine.Rendering.VolumeParameter.overrideState) description. + ## Upgrading from URP 13 (Unity 2022.1) ### Two shader defines were removed