summaryrefslogtreecommitdiff
path: root/src/SMAPI.Mods.ErrorHandler/Patches/SpriteBatchPatcher.cs
blob: 6860a4ec7373697b6e666cbfe163b1709e5afbc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
using System;
using System.Diagnostics.CodeAnalysis;
using HarmonyLib;
using Microsoft.Xna.Framework.Graphics;
using StardewModdingAPI.Internal.Patching;

namespace StardewModdingAPI.Mods.ErrorHandler.Patches
{
    /// <summary>Harmony patches for <see cref="SpriteBatch"/> which validate textures earlier.</summary>
    /// <remarks>Patch methods must be static for Harmony to work correctly. See the Harmony documentation before renaming patch arguments.</remarks>
    [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
    [SuppressMessage("ReSharper", "IdentifierTypo", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
    internal class SpriteBatchPatcher : BasePatcher
    {
        /*********
        ** Public methods
        *********/
        /// <inheritdoc />
        public override void Apply(Harmony harmony, IMonitor monitor)
        {
            harmony.Patch(
                original: Constants.GameFramework == GameFramework.Xna
                    ? this.RequireMethod<SpriteBatch>("InternalDraw")
                    : this.RequireMethod<SpriteBatch>("CheckValid", new[] { typeof(Texture2D) }),
                postfix: this.GetHarmonyMethod(nameof(SpriteBatchPatcher.After_CheckValid))
            );
        }


        /*********
        ** Private methods
        *********/
#if SMAPI_FOR_XNA
        /// <summary>The method to call after <see cref="SpriteBatch.InternalDraw"/>.</summary>
        /// <param name="texture">The texture to validate.</param>
#else
        /// <summary>The method to call after <see cref="SpriteBatch.CheckValid"/>.</summary>
        /// <param name="texture">The texture to validate.</param>
#endif
        private static void After_CheckValid(Texture2D texture)
        {
            if (texture?.IsDisposed == true)
                throw new ObjectDisposedException("Cannot draw this texture because it's disposed.");
        }
    }
}