ryujinx/Ryujinx.Audio/Renderer/Common/BehaviourParameter.cs

//
// Copyright (c) 2019-2021 Ryujinx
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//

using System.Runtime.InteropServices;

namespace Ryujinx.Audio.Renderer.Common
{
    /// <summary>
    /// Represents the input parameter for <see cref="Server.BehaviourContext"/>.
    /// </summary>
    [StructLayout(LayoutKind.Sequential, Pack = 1)]
    public struct BehaviourParameter
    {
        /// <summary>
        /// The current audio renderer revision in use.
        /// </summary>
        public int UserRevision;

        /// <summary>
        /// Reserved/padding.
        /// </summary>
        private uint _padding;

        /// <summary>
        /// The flags given controlling behaviour of the audio renderer
        /// </summary>
        /// <remarks>See <see cref="Server.BehaviourContext.UpdateFlags(ulong)"/> and <see cref="Server.BehaviourContext.IsMemoryPoolForceMappingEnabled"/>.</remarks>
        public ulong Flags;

        /// <summary>
        /// Represents an error during <see cref="Server.AudioRenderSystem.Update(System.Memory{byte}, System.Memory{byte}, System.ReadOnlyMemory{byte})"/>.
        /// </summary>
        [StructLayout(LayoutKind.Sequential, Pack = 1)]
        public struct ErrorInfo
        {
            /// <summary>
            /// The error code to report.
            /// </summary>
            public ResultCode ErrorCode;

            /// <summary>
            /// Reserved/padding.
            /// </summary>
            private uint _padding;

            /// <summary>
            /// Extra information given with the <see cref="ResultCode"/>
            /// </summary>
            /// <remarks>This is usually used to report a faulting cpu address when a <see cref="Server.MemoryPool.MemoryPoolState"/> mapping fail.</remarks>
            public ulong ExtraErrorInfo;
        }
    }
}