using System; using System.Linq; using System.Reflection; using System.Collections.Generic; using System.Collections.ObjectModel; using UnityEngine.Rendering; namespace UnityEngine.Experimental.Rendering.HDPipeline { [Serializable] public enum SkyResolution { SkyResolution128 = 128, SkyResolution256 = 256, SkyResolution512 = 512, SkyResolution1024 = 1024, SkyResolution2048 = 2048, SkyResolution4096 = 4096 } public enum EnvironementUpdateMode { OnChanged = 0, OnDemand, Realtime } public class BuiltinSkyParameters { public Matrix4x4 pixelCoordToViewDirMatrix; public Matrix4x4 invViewProjMatrix; public Vector3 cameraPosWS; public Vector4 screenSize; public CommandBuffer commandBuffer; public Light sunLight; public RTHandleSystem.RTHandle colorBuffer; public RTHandleSystem.RTHandle depthBuffer; public HDCamera hdCamera; public DebugDisplaySettings debugSettings; public static RenderTargetIdentifier nullRT = -1; } public class SkyManager { Material m_StandardSkyboxMaterial; // This is the Unity standard skybox material. Used to pass the correct cubemap to Enlighten. Material m_BlitCubemapMaterial; Material m_OpaqueAtmScatteringMaterial; bool m_UpdateRequired = false; bool m_NeedUpdateRealtimeEnv = false; bool m_NeedUpdateBakingSky = true; #if UNITY_EDITOR // For Preview windows we want to have a 'fixed' sky, so we can display chrome metal and have always the same look ProceduralSky m_DefaultPreviewSky; #endif // This is the sky used for rendering in the main view. It will also be used for lighting if no lighting override sky is setup. // Ambient Probe: Only for real time GI (otherwise we use the baked one) // Reflection Probe : Always used and updated depending on the OnChanged/Realtime flags. SkyUpdateContext m_VisualSky = new SkyUpdateContext(); // This is optional and is used only to compute ambient probe and sky reflection // Ambient Probe: Only for real time GI (otherwise we use the baked one) // Reflection Probe : Always used and updated depending on the OnChanged/Realtime flags. SkyUpdateContext m_LightingOverrideSky = new SkyUpdateContext(); // This is mandatory when using baked GI. This sky is used to setup the global Skybox material used by the GI system to bake sky GI. SkyUpdateContext m_BakingSky = new SkyUpdateContext(); // The sky rendering contexts holds the render textures used by the sky system. // We need to have a separate one for the baking sky because we have to keep it alive regardless of the visual/override sky (because it's set in the lighting panel skybox material). SkyRenderingContext m_BakingSkyRenderingContext; SkyRenderingContext m_SkyRenderingContext; // This interpolation volume stack is used to interpolate the lighting override separately from the visual sky. // If a sky setting is present in this volume then it will be used for lighting override. VolumeStack m_LightingOverrideVolumeStack; LayerMask m_LightingOverrideLayerMask = -1; static Dictionary m_SkyTypesDict = null; public static Dictionary skyTypesDict { get { if (m_SkyTypesDict == null) UpdateSkyTypes(); return m_SkyTypesDict; } } public Texture skyReflection { get { return m_SkyRenderingContext.reflectionTexture; } } // This list will hold the sky settings that should be used for baking. // In practice we will always use the last one registered but we use a list to be able to roll back to the previous one once the user deletes the superfluous instances. private static List m_BakingSkySettings = new List(); SkySettings GetSkySetting(VolumeStack stack) { var visualEnv = stack.GetComponent(); int skyID = visualEnv.skyType; Type skyType; if (skyTypesDict.TryGetValue(skyID, out skyType)) { return (SkySettings)stack.GetComponent(skyType); } else { return null; } } static void UpdateSkyTypes() { if (m_SkyTypesDict == null) { m_SkyTypesDict = new Dictionary(); var skyTypes = CoreUtils.GetAllAssemblyTypes().Where(t => t.IsSubclassOf(typeof(SkySettings)) && !t.IsAbstract); foreach (Type skyType in skyTypes) { var uniqueIDs = skyType.GetCustomAttributes(typeof(SkyUniqueID), false); if (uniqueIDs.Length == 0) { Debug.LogWarningFormat("Missing attribute SkyUniqueID on class {0}. Class won't be registered as an available sky.", skyType); } else { int uniqueID = ((SkyUniqueID)uniqueIDs[0]).uniqueID; if (uniqueID == 0) { Debug.LogWarningFormat("0 is a reserved SkyUniqueID and is used in class {0}. Class won't be registered as an available sky.", skyType); continue; } Type value; if (m_SkyTypesDict.TryGetValue(uniqueID, out value)) { Debug.LogWarningFormat("SkyUniqueID {0} used in class {1} is already used in class {2}. Class won't be registered as an available sky.", uniqueID, skyType, value); continue; } m_SkyTypesDict.Add(uniqueID, skyType); } } } } public void UpdateCurrentSkySettings(HDCamera hdCamera) { m_VisualSky.skySettings = GetSkySetting(VolumeManager.instance.stack); #if UNITY_EDITOR if (HDUtils.IsRegularPreviewCamera(hdCamera.camera)) { m_VisualSky.skySettings = GetDefaultPreviewSkyInstance(); } #endif m_BakingSky.skySettings = SkyManager.GetBakingSkySettings(); // Update needs to happen before testing if the component is active other internal data structure are not properly updated yet. VolumeManager.instance.Update(m_LightingOverrideVolumeStack, hdCamera.camera.transform, m_LightingOverrideLayerMask); if (VolumeManager.instance.IsComponentActiveInMask(m_LightingOverrideLayerMask)) { SkySettings newSkyOverride = GetSkySetting(m_LightingOverrideVolumeStack); if (m_LightingOverrideSky.skySettings != null && newSkyOverride == null) { // When we switch from override to no override, we need to make sure that the visual sky will actually be properly re-rendered. // Resetting the visual sky hash will ensure that. m_VisualSky.skyParametersHash = -1; } m_LightingOverrideSky.skySettings = newSkyOverride; } else { m_LightingOverrideSky.skySettings = null; } } // Sets the global MIP-mapped cubemap '_SkyTexture' in the shader. // The texture being set is the sky (environment) map pre-convolved with GGX. public void SetGlobalSkyTexture(CommandBuffer cmd) { cmd.SetGlobalTexture(HDShaderIDs._SkyTexture, skyReflection); float mipCount = Mathf.Clamp(Mathf.Log((float)skyReflection.width, 2.0f) + 1, 0.0f, 6.0f); cmd.SetGlobalFloat(HDShaderIDs._SkyTextureMipCount, mipCount); } #if UNITY_EDITOR ProceduralSky GetDefaultPreviewSkyInstance() { if (m_DefaultPreviewSky == null) { m_DefaultPreviewSky = ScriptableObject.CreateInstance(); } return m_DefaultPreviewSky; } #endif public void Build(HDRenderPipelineAsset hdAsset, IBLFilterGGX iblFilterGGX) { m_BakingSkyRenderingContext = new SkyRenderingContext(iblFilterGGX, (int)hdAsset.renderPipelineSettings.lightLoopSettings.skyReflectionSize, false); m_SkyRenderingContext = new SkyRenderingContext(iblFilterGGX, (int)hdAsset.renderPipelineSettings.lightLoopSettings.skyReflectionSize, true); m_StandardSkyboxMaterial = CoreUtils.CreateEngineMaterial(hdAsset.renderPipelineResources.skyboxCubemap); m_BlitCubemapMaterial = CoreUtils.CreateEngineMaterial(hdAsset.renderPipelineResources.blitCubemap); m_OpaqueAtmScatteringMaterial = CoreUtils.CreateEngineMaterial(hdAsset.renderPipelineResources.opaqueAtmosphericScattering); m_LightingOverrideVolumeStack = VolumeManager.instance.CreateStack(); m_LightingOverrideLayerMask = hdAsset.renderPipelineSettings.lightLoopSettings.skyLightingOverrideLayerMask; } public void Cleanup() { #if UNITY_EDITOR CoreUtils.Destroy(m_DefaultPreviewSky); #endif CoreUtils.Destroy(m_StandardSkyboxMaterial); CoreUtils.Destroy(m_BlitCubemapMaterial); CoreUtils.Destroy(m_OpaqueAtmScatteringMaterial); m_BakingSky.Cleanup(); m_VisualSky.Cleanup(); m_LightingOverrideSky.Cleanup(); m_BakingSkyRenderingContext.Cleanup(); m_SkyRenderingContext.Cleanup(); } public bool IsLightingSkyValid() { return m_VisualSky.IsValid() || m_LightingOverrideSky.IsValid(); } public bool IsVisualSkyValid() { return m_VisualSky.IsValid(); } void BlitCubemap(CommandBuffer cmd, Cubemap source, RenderTexture dest) { var propertyBlock = new MaterialPropertyBlock(); for (int i = 0; i < 6; ++i) { CoreUtils.SetRenderTarget(cmd, dest, ClearFlag.None, 0, (CubemapFace)i); propertyBlock.SetTexture("_MainTex", source); propertyBlock.SetFloat("_faceIndex", (float)i); cmd.DrawProcedural(Matrix4x4.identity, m_BlitCubemapMaterial, 0, MeshTopology.Triangles, 3, 1, propertyBlock); } // Generate mipmap for our cubemap Debug.Assert(dest.autoGenerateMips == false); cmd.GenerateMips(dest); } public void RequestEnvironmentUpdate() { m_UpdateRequired = true; } public void UpdateEnvironment(HDCamera camera, Light sunLight, CommandBuffer cmd) { // WORKAROUND for building the player. // When building the player, for some reason we end up in a state where frameCount is not updated but all currently setup shader texture are reset to null // resulting in a rendering error (compute shader property not bound) that makes the player building fails... // So we just check if the texture is bound here so that we can setup a pink one to avoid the error without breaking half the world. if (Shader.GetGlobalTexture(HDShaderIDs._SkyTexture) == null) cmd.SetGlobalTexture(HDShaderIDs._SkyTexture, CoreUtils.magentaCubeTexture); // This is done here because we need to wait for one frame that the command buffer is executed before using the resulting textures. // Testing the current skybox material is because we have to make sure that additive scene loading or even some user script haven't altered it. if (m_NeedUpdateBakingSky || (RenderSettings.skybox != m_StandardSkyboxMaterial)) { // Here we update the global SkyMaterial so that it uses our baking sky cubemap. This way, next time the GI is baked, the right sky will be present. float intensity = m_BakingSky.IsValid() ? 1.0f : 0.0f; // Eliminate all diffuse if we don't have a skybox (meaning for now the background is black in HDRP) m_StandardSkyboxMaterial.SetTexture("_Tex", m_BakingSkyRenderingContext.cubemapRT); RenderSettings.skybox = m_StandardSkyboxMaterial; // Setup this material as the default to be use in RenderSettings RenderSettings.ambientIntensity = intensity; RenderSettings.ambientMode = AmbientMode.Skybox; // Force skybox for our HDRI RenderSettings.reflectionIntensity = intensity; RenderSettings.customReflection = null; // Strictly speaking, this should not be necessary, but it helps avoiding inconsistent behavior in the editor // where the GI system sometimes update the ambient probe and sometime does not... DynamicGI.UpdateEnvironment(); m_NeedUpdateBakingSky = false; } if (m_NeedUpdateRealtimeEnv) { // TODO: Here we need to do that in case we are using real time GI. Unfortunately we don't have a way to check that atm. // Moreover we still need Async readback from texture in command buffers first. //DynamicGI.SetEnvironmentData(); m_NeedUpdateRealtimeEnv = false; } // For the baking sky, we don't want to take the sun into account because we usually won't include it (this would cause double highlight in the reflection for example). // So we pass null so that's it doesn't affect the hash and the rendering. m_NeedUpdateBakingSky = m_BakingSkyRenderingContext.UpdateEnvironment(m_BakingSky, camera, null, m_UpdateRequired, cmd); SkyUpdateContext currentSky = m_LightingOverrideSky.IsValid() ? m_LightingOverrideSky : m_VisualSky; m_NeedUpdateRealtimeEnv = m_SkyRenderingContext.UpdateEnvironment(currentSky, camera, sunLight, m_UpdateRequired, cmd); m_UpdateRequired = false; SetGlobalSkyTexture(cmd); if (IsLightingSkyValid()) { cmd.SetGlobalInt(HDShaderIDs._EnvLightSkyEnabled, 1); } else { cmd.SetGlobalInt(HDShaderIDs._EnvLightSkyEnabled, 0); } } public void RenderSky(HDCamera camera, Light sunLight, RTHandleSystem.RTHandle colorBuffer, RTHandleSystem.RTHandle depthBuffer, DebugDisplaySettings debugSettings, CommandBuffer cmd) { m_SkyRenderingContext.RenderSky(m_VisualSky, camera, sunLight, colorBuffer, depthBuffer, debugSettings, cmd); } public void RenderOpaqueAtmosphericScattering(CommandBuffer cmd) { using (new ProfilingSample(cmd, "Opaque Atmospheric Scattering")) { CoreUtils.DrawFullScreen(cmd, m_OpaqueAtmScatteringMaterial); } } static public SkySettings GetBakingSkySettings() { if (m_BakingSkySettings.Count == 0) return null; else return m_BakingSkySettings[m_BakingSkySettings.Count - 1]; } static public void RegisterBakingSky(SkySettings bakingSky) { if (!m_BakingSkySettings.Contains(bakingSky)) { if (m_BakingSkySettings.Count != 0) { Debug.LogWarning("One sky component was already set for baking, only the latest one will be used."); } m_BakingSkySettings.Add(bakingSky); } } static public void UnRegisterBakingSky(SkySettings bakingSky) { m_BakingSkySettings.Remove(bakingSky); } public Texture2D ExportSkyToTexture() { if (!m_VisualSky.IsValid()) { Debug.LogError("Cannot export sky to a texture, no Sky is setup."); return null; } RenderTexture skyCubemap = m_SkyRenderingContext.cubemapRT; int resolution = skyCubemap.width; var tempRT = new RenderTexture(resolution * 6, resolution, 0, RenderTextureFormat.ARGBHalf, RenderTextureReadWrite.Linear) { dimension = TextureDimension.Tex2D, useMipMap = false, autoGenerateMips = false, filterMode = FilterMode.Trilinear }; tempRT.Create(); var temp = new Texture2D(resolution * 6, resolution, TextureFormat.RGBAFloat, false); var result = new Texture2D(resolution * 6, resolution, TextureFormat.RGBAFloat, false); // Note: We need to invert in Y the cubemap faces because the current sky cubemap is inverted (because it's a RT) // So to invert it again so that it's a proper cubemap image we need to do it in several steps because ReadPixels does not have scale parameters: // - Convert the cubemap into a 2D texture // - Blit and invert it to a temporary target. // - Read this target again into the result texture. int offset = 0; for (int i = 0; i < 6; ++i) { UnityEngine.Graphics.SetRenderTarget(skyCubemap, 0, (CubemapFace)i); temp.ReadPixels(new Rect(0, 0, resolution, resolution), offset, 0); temp.Apply(); offset += resolution; } // Flip texture. UnityEngine.Graphics.Blit(temp, tempRT, new Vector2(1.0f, -1.0f), new Vector2(0.0f, 0.0f)); result.ReadPixels(new Rect(0, 0, resolution * 6, resolution), 0, 0); result.Apply(); UnityEngine.Graphics.SetRenderTarget(null); CoreUtils.Destroy(temp); CoreUtils.Destroy(tempRT); return result; } } }