ScriptableRenderPipeline/ScriptableRenderPipeline/Core/ProfilingSample.cs

using System;
using UnityEngine.Rendering;

namespace UnityEngine.Experimental.Rendering
{
    public struct ProfilingSample : IDisposable
    {
        public readonly CommandBuffer cmd;
        public readonly string name;

        bool m_Disposed;

        public ProfilingSample(CommandBuffer cmd, string name)
        {
            this.cmd = cmd;
            this.name = name;
            m_Disposed = false;
            cmd.BeginSample(name);
        }

        // Shortcut to string.Format() using only one argument (reduces Gen0 GC pressure)
        public ProfilingSample(CommandBuffer cmd, string format, object arg)
        {
            this.cmd = cmd;
            name = string.Format(format, arg);
            m_Disposed = false;
            cmd.BeginSample(name);
        }

        // Shortcut to string.Format() with variable amount of arguments - for performance critical
        // code you should pre-build & cache the marker name instead of using this
        public ProfilingSample(CommandBuffer cmd, string format, params object[] args)
        {
            this.cmd = cmd;
            name = string.Format(format, args);
            m_Disposed = false;
            cmd.BeginSample(name);
        }

        public void Dispose()
        {
            Dispose(true);
        }

        // Protected implementation of Dispose pattern.
        void Dispose(bool disposing)
        {
            if (m_Disposed)
                return;

            // As this is a struct, it could have been initialized using an empty constructor so we
            // need to make sure `cmd` isn't null to avoid a crash. Switching to a class would fix
            // this but will generate garbage on every frame (and this struct is used quite a lot).
            if (disposing && cmd != null)
                cmd.EndSample(name);

            m_Disposed = true;
        }
    }
}