ScriptableRenderPipeline/com.unity.render-pipelines.high-definition/HDRP/Lighting/Volumetrics/VolumeTextureAtlas.cs

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
///                                                                                                                                                             ///
///     MIT License                                                                                                                                             ///
///                                                                                                                                                             ///
///     Copyright (c) 2016 Raphaël Ernaelsten (@RaphErnaelsten)                                                                                                 ///
///                                                                                                                                                             ///
///     Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),      ///
///     to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute,                  ///
///     and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:              ///
///                                                                                                                                                             ///
///     The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.                          ///
///                                                                                                                                                             ///
///     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,     ///
///     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      ///
///     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS    ///
///     IN THE SOFTWARE.                                                                                                                                        ///
///                                                                                                                                                             ///
///     PLEASE CONSIDER CREDITING AURA IN YOUR PROJECTS. IF RELEVANT, USE THE UNMODIFIED LOGO PROVIDED IN THE "LICENSE" FOLDER.                                 ///
///                                                                                                                                                             ///
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

using System;
using System.Collections.Generic;
using Unity.Collections.LowLevel.Unsafe;
using UnityEngine;
using UnityEngine.Rendering;

namespace UnityEngine.Experimental.Rendering.HDPipeline
{
    public class VolumeTextureAtlas
    {
        private List<Texture3D> textures = null;

        //Assuming every volume texture is square and number of depth slices equal to 2D dimensions
        private int requiredTextureSize;
        private TextureFormat requiredTextureFormat;

        public bool needTextureUpdate
        {
            get;
            private set;
        }


        public Texture3D volumeAtlas
        {
            get;
            private set;
        }

        public event Action OnAtlasUpdated;

        private void NotifyAtlasUpdated()
        {
            if (OnAtlasUpdated != null)
            {
                OnAtlasUpdated();
            }
        }

        public VolumeTextureAtlas(TextureFormat atlasFormat, int atlasSize)
        {
            requiredTextureSize = atlasSize;

            requiredTextureFormat = atlasFormat;

            textures = new List<Texture3D>();

            needTextureUpdate = false;
        }

        public void ClearTextures()
        {
            textures.Clear();
            needTextureUpdate = true;
        }

        public void AddTexture(Texture3D volumeTexture)
        {
            //TODO:  we should really just convert the texture to the right size and format...HOWEVER, we dont' support 3D textures at the moment in the ConvertTexture call
            if (volumeTexture.width != requiredTextureSize || volumeTexture.height != requiredTextureSize || volumeTexture.depth != requiredTextureSize)
            {
                Debug.LogError(string.Format("VolumeTextureAtlas: Dimensions of texture {0} does not match expected dimensions of {1}", volumeTexture, requiredTextureSize));
                return;
            }

            if (volumeTexture.format != requiredTextureFormat)
            {
                Debug.LogError(string.Format("VolumeTextureAtlas: Texture format of texture {0} : {1} does not match expected format of {2}", volumeTexture, volumeTexture.format, requiredTextureFormat));
                return;
            }

            if (!textures.Contains(volumeTexture))
            {
                textures.Add(volumeTexture);

                needTextureUpdate = true;
            }
        }

        public void RemoveTexture(Texture3D volumeTexture)
        {
            if (textures.Contains(volumeTexture))
            {
                textures.Remove(volumeTexture);

                needTextureUpdate = true;
            }
        }

        //Generates the volume atlas by converting (if needed) and then copying the textures into one big volume texture.
        public void GenerateVolumeAtlas(CommandBuffer cmd)
        {
            if (needTextureUpdate)
            {
                if (textures.Count > 0)
                {
                    Color[] colorArray = new Color[0];
                    volumeAtlas = new Texture3D(requiredTextureSize, requiredTextureSize, requiredTextureSize * textures.Count, requiredTextureFormat, true);

                    foreach (Texture3D tex in textures)
                    {
                        //TODO: Need to have copy texture and convert texture working for Tex3D in order for this to be
                        //more robust
                        Color[] texColor = tex.GetPixels();
                        Array.Resize(ref colorArray, texColor.Length + colorArray.Length);
                        Array.Copy(texColor, 0, colorArray, colorArray.Length - texColor.Length, texColor.Length);
                    }

                    volumeAtlas.SetPixels(colorArray);
                    volumeAtlas.Apply();
                }
                else
                {
                    volumeAtlas = null;
                }

                needTextureUpdate = false;

                NotifyAtlasUpdated();
            }
        }

        public int GetTextureIndex(Texture3D tex)
        {
            return textures.IndexOf(tex);
        }
    }
}