summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Content/AssetDataForImage.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-08-30 22:53:19 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-08-30 22:53:19 -0400
commit828be405e11dd8bc7f8a3692d2c74517734f67a5 (patch)
tree0a85e065e7b5604b4c1d0a1b24a53a9f85f550e5 /src/SMAPI/Framework/Content/AssetDataForImage.cs
parent3a4606164c6ce8d900077b567dc1142f6aad0f4c (diff)
downloadSMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.tar.gz
SMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.tar.bz2
SMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.zip
use inheritdoc
Diffstat (limited to 'src/SMAPI/Framework/Content/AssetDataForImage.cs')
-rw-r--r--src/SMAPI/Framework/Content/AssetDataForImage.cs13
1 files changed, 2 insertions, 11 deletions
diff --git a/src/SMAPI/Framework/Content/AssetDataForImage.cs b/src/SMAPI/Framework/Content/AssetDataForImage.cs
index 44a97136..5f91610e 100644
--- a/src/SMAPI/Framework/Content/AssetDataForImage.cs
+++ b/src/SMAPI/Framework/Content/AssetDataForImage.cs
@@ -28,13 +28,7 @@ namespace StardewModdingAPI.Framework.Content
public AssetDataForImage(string locale, string assetName, Texture2D data, Func<string, string> getNormalizedPath, Action<Texture2D> onDataReplaced)
: base(locale, assetName, data, getNormalizedPath, onDataReplaced) { }
- /// <summary>Overwrite part of the image.</summary>
- /// <param name="source">The image to patch into the content.</param>
- /// <param name="sourceArea">The part of the <paramref name="source"/> to copy (or <c>null</c> to take the whole texture). This must be within the bounds of the <paramref name="source"/> texture.</param>
- /// <param name="targetArea">The part of the content to patch (or <c>null</c> to patch the whole texture). The original content within this area will be erased. This must be within the bounds of the existing spritesheet.</param>
- /// <param name="patchMode">Indicates how an image should be patched.</param>
- /// <exception cref="ArgumentNullException">One of the arguments is null.</exception>
- /// <exception cref="ArgumentOutOfRangeException">The <paramref name="targetArea"/> is outside the bounds of the spritesheet.</exception>
+ /// <inheritdoc />
public void PatchImage(Texture2D source, Rectangle? sourceArea = null, Rectangle? targetArea = null, PatchMode patchMode = PatchMode.Replace)
{
// get texture
@@ -104,10 +98,7 @@ namespace StardewModdingAPI.Framework.Content
target.SetData(0, targetArea, sourceData, 0, pixelCount);
}
- /// <summary>Extend the image if needed to fit the given size. Note that this is an expensive operation, creates a new texture instance, and that extending a spritesheet horizontally may cause game errors or bugs.</summary>
- /// <param name="minWidth">The minimum texture width.</param>
- /// <param name="minHeight">The minimum texture height.</param>
- /// <returns>Whether the texture was resized.</returns>
+ /// <inheritdoc />
public bool ExtendImage(int minWidth, int minHeight)
{
if (this.Data.Width >= minWidth && this.Data.Height >= minHeight)