From 442c616baed15a62e4a4b1f014e6ece124c36b82 Mon Sep 17 00:00:00 2001 From: Elias Batek Date: Tue, 28 Jan 2025 02:42:37 +0100 Subject: [PATCH] Document function `scaleTo` --- pixmappaint.d | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/pixmappaint.d b/pixmappaint.d index ea74515..6005bf1 100644 --- a/pixmappaint.d +++ b/pixmappaint.d @@ -3361,7 +3361,21 @@ private void scaleToImpl(ScalingFilter filter)(const Pixmap source, Pixmap targe } } -// TODO: Document this function +/++ + Scales a pixmap and stores the result in the provided target Pixmap. + + The size to scale the image to + is derived from the size of the target. + + --- + // This function can be used to omit a redundant size parameter + // in cases like this: + target = scale(source, target, target.size, ScalingFilter.bilinear); + + // → Instead do: + scaleTo(source, target, ScalingFilter.bilinear); + --- + +/ void scaleTo(const Pixmap source, Pixmap target, ScalingFilter filter) @nogc { import std.meta : NoDuplicates; import std.traits : EnumMembers;