using System; using System.Diagnostics; namespace UnityEngine.Experimental.Rendering.RenderGraphModule { /// /// Graphics Buffer resource handle. /// [DebuggerDisplay("Buffer ({handle.index})")] public struct BufferHandle { // Minor Warning: This calls the zeroing constructor this means that the embedded ResourceHandle struct will also be zero-ed // which then means ResourceHandle.type will be set to zero == Texture. As this is an "invalid" bufferhandle I guess setting it // to type texture just makes it even more properly invalid and not a big issue. But something to keep in mind for tooling/logging. private static BufferHandle s_NullHandle = new BufferHandle(); /// /// Returns a null graphics buffer handle /// /// A null graphics buffer handle. public static BufferHandle nullHandle { get { return s_NullHandle; } } internal ResourceHandle handle; internal BufferHandle(int handle, bool shared = false) { this.handle = new ResourceHandle(handle, RenderGraphResourceType.Buffer, shared); } /// /// Cast to GraphicsBuffer /// /// Input BufferHandle /// Resource as a Graphics Buffer. public static implicit operator GraphicsBuffer(BufferHandle buffer) => buffer.IsValid() ? RenderGraphResourceRegistry.current.GetBuffer(buffer) : null; /// /// Return true if the handle is valid. /// /// True if the handle is valid. public bool IsValid() => handle.IsValid(); } /// /// Descriptor used to create graphics buffer resources /// public struct BufferDesc { ///Number of elements in the buffer.. public int count; ///Size of one element in the buffer. Has to match size of buffer type in the shader. public int stride; /// Graphics Buffer name. public string name; /// The intended usage of a GraphicsBuffer. public GraphicsBuffer.Target target; /// The intended update mode of a GraphicsBuffer. public GraphicsBuffer.UsageFlags usageFlags; /// /// BufferDesc constructor. /// /// Number of elements in the buffer. /// Size of one element in the buffer. public BufferDesc(int count, int stride) : this() { this.count = count; this.stride = stride; this.target = GraphicsBuffer.Target.Structured; this.usageFlags = GraphicsBuffer.UsageFlags.None; } /// /// BufferDesc constructor. /// /// Number of elements in the buffer. /// Size of one element in the buffer. /// Type of the buffer. public BufferDesc(int count, int stride, GraphicsBuffer.Target target) : this() { this.count = count; this.stride = stride; this.target = target; this.usageFlags = GraphicsBuffer.UsageFlags.None; } /// /// Hash function /// /// The texture descriptor hash. public override int GetHashCode() { int hashCode = 17; hashCode = hashCode * 23 + count; hashCode = hashCode * 23 + stride; hashCode = hashCode * 23 + (int)target; hashCode = hashCode * 23 + (int)usageFlags; return hashCode; } } [DebuggerDisplay("BufferResource ({desc.name})")] class BufferResource : RenderGraphResource { public override string GetName() { if (imported) return "ImportedGraphicsBuffer"; // No getter for graphics buffer name. else return desc.name; } // NOTE: // Next two functions should have been implemented in RenderGraphResource but for some reason, // when doing so, it's impossible to break in the Texture version of the virtual function (with VS2017 at least), making this completely un-debuggable. // To work around this, we just copy/pasted the implementation in each final class... public override void CreatePooledGraphicsResource() { Debug.Assert(m_Pool != null, "GraphicsBufferResource: CreatePooledGraphicsResource should only be called for regular pooled resources"); int hashCode = desc.GetHashCode(); if (graphicsResource != null) throw new InvalidOperationException(string.Format("GraphicsBufferResource: Trying to create an already created resource ({0}). Resource was probably declared for writing more than once in the same pass.", GetName())); var pool = m_Pool as BufferPool; if (!pool.TryGetResource(hashCode, out graphicsResource)) { CreateGraphicsResource(desc.name); } cachedHash = hashCode; pool.RegisterFrameAllocation(cachedHash, graphicsResource); graphicsResource.name = desc.name; } public override void ReleasePooledGraphicsResource(int frameIndex) { if (graphicsResource == null) throw new InvalidOperationException($"BufferResource: Tried to release a resource ({GetName()}) that was never created. Check that there is at least one pass writing to it first."); // Shared resources don't use the pool var pool = m_Pool as BufferPool; if (pool != null) { pool.ReleaseResource(cachedHash, graphicsResource, frameIndex); pool.UnregisterFrameAllocation(cachedHash, graphicsResource); } Reset(null); } public override void CreateGraphicsResource(string name = "") { graphicsResource = new GraphicsBuffer(desc.target, desc.usageFlags, desc.count, desc.stride); graphicsResource.name = name == "" ? $"RenderGraphBuffer_{desc.count}_{desc.stride}_{desc.target}" : name; } public override void ReleaseGraphicsResource() { if (graphicsResource != null) graphicsResource.Release(); base.ReleaseGraphicsResource(); } public override void LogCreation(RenderGraphLogger logger) { logger.LogLine($"Created GraphicsBuffer: {desc.name}"); } public override void LogRelease(RenderGraphLogger logger) { logger.LogLine($"Released GraphicsBuffer: {desc.name}"); } } class BufferPool : RenderGraphResourcePool { protected override void ReleaseInternalResource(GraphicsBuffer res) { res.Release(); } protected override string GetResourceName(GraphicsBuffer res) { return "GraphicsBufferNameNotAvailable"; // GraphicsBuffer.name is a setter only :( } protected override long GetResourceSize(GraphicsBuffer res) { return res.count * res.stride; } override protected string GetResourceTypeName() { return "GraphicsBuffer"; } override protected int GetSortIndex(GraphicsBuffer res) { return res.GetHashCode(); } // Another C# nicety. // We need to re-implement the whole thing every time because: // - obj.resource.Release is Type specific so it cannot be called on a generic (and there's no shared interface for resources like RTHandle, GraphicsBuffers etc) // - We can't use a virtual release function because it will capture this in the lambda for RemoveAll generating GCAlloc in the process. override public void PurgeUnusedResources(int currentFrameIndex) { // Update the frame index for the lambda. Static because we don't want to capture. s_CurrentFrameIndex = currentFrameIndex; m_RemoveList.Clear(); foreach (var kvp in m_ResourcePool) { // WARNING: No foreach here. Sorted list GetEnumerator generates garbage... var list = kvp.Value; var keys = list.Keys; var values = list.Values; for (int i = 0; i < list.Count; ++i) { var value = values[i]; if (ShouldReleaseResource(value.frameIndex, s_CurrentFrameIndex)) { value.resource.Release(); m_RemoveList.Add(keys[i]); } } foreach (var key in m_RemoveList) list.Remove(key); } } } }