Codeunit 3971 Image

// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------

namespace System.Utilities;

/// <summary>
/// Provides functionality for working with images.
/// </summary>
codeunit 3971 Image
{
    Access = Public;
    InherentEntitlements = X;
    InherentPermissions = X;

    var
        ImageImpl: Codeunit "Image Impl.";

    /// <summary>
    /// Clears the entire drawing surface and fills it with the specified background color.
    /// </summary>
    /// <param name="Alpha">The alpha component. Valid values are 0 through 255.</param>
    /// <param name="Red">The red component. Valid values are 0 through 255.</param>
    /// <param name="Green">The green component. Valid values are 0 through 255.</param>
    /// <param name="Blue">The blue component. Valid values are 0 through 255.</param>
    procedure Clear(Alpha: Integer; Red: Integer; Green: Integer; Blue: Integer)
    begin
        ImageImpl.Clear(Alpha, Red, Green, Blue);
    end;

    /// <summary>
    /// Clears the entire drawing surface and fills it with the specified background color.
    /// </summary>
    /// <param name="Red">The red component. Valid values are 0 through 255.</param>
    /// <param name="Green">The green component. Valid values are 0 through 255.</param>
    /// <param name="Blue">The blue component. Valid values are 0 through 255.</param>
    procedure Clear(Red: Integer; Green: Integer; Blue: Integer)
    begin
        ImageImpl.Clear(255, Red, Green, Blue);
    end;

    /// <summary>
    /// Crops the image based on a rectangle specified by the user.
    /// The resulting crop will be a hole-cut in the image made by the rectangle.
    /// </summary>
    /// <param name="X">X coordinate of the rectangle.</param>
    /// <param name="Y">Y coordinate of the rectangle.</param>
    /// <param name="Width">Width of rectangle.</param>
    /// <param name="Height">Height of the rectangle./</param>
    /// <remarks>The Rectangles top left corner has to be within the image dimensions,
    /// but specifying a width or height that makes the rectangle go outside the image dimensions is allowed.
    /// Anything outside the image dimensions will be filled with the image background color.</remarks>
    /// <error>X and Y is not within the image dimensions.</error>
    /// <error>Width and Height is less than one.</error>
    procedure Crop(X: Integer; Y: Integer; Width: Integer; Height: Integer)
    begin
        ImageImpl.Crop(X, Y, Width, Height);
    end;

    /// <summary>
    /// Gets the image format as a text.
    /// </summary>
    /// <returns>A text containing the format value.</returns>
    procedure GetFormatAsText(): Text
    begin
        exit(ImageImpl.GetFormatAsString());
    end;

    /// <summary>
    /// Gets the image format as an Enum "Image Format".
    /// </summary>
    /// <returns>The enum value.</returns>
    procedure GetFormat(): Enum "Image Format"
    begin
        exit(ImageImpl.GetFormat());
    end;

    /// <summary>
    /// Sets the image format from an Enum "Image Format".
    /// </summary>
    /// <remarks>Depending on the format selected, calling this method may result in loss of image quality.</remarks>
    procedure SetFormat(ImageFormat: Enum "Image Format")
    begin
        ImageImpl.SetFormat(ImageFormat);
    end;

    /// <summary>
    /// Creates an Image from base64 encoding.
    /// </summary>
    /// <param name="Base64Text">A base64 encoded string the contains the image.</param>
    procedure FromBase64(Base64Text: Text)
    begin
        ImageImpl.FromBase64(Base64Text);
    end;

    /// <summary>
    /// Creates an image from the specified data stream.
    /// </summary>
    /// <param name="InStream">A Stream that contains the image data.</param>
    /// <error>Stream do not contain valid image data</error>
    procedure FromStream(InStream: InStream)
    begin
        ImageImpl.FromStream(InStream);
    end;

    /// <summary>
    /// Gets the width in pixels.
    /// </summary>
    /// <returns>The width in pixels.</returns>
    procedure GetWidth(): Integer
    begin
        exit(ImageImpl.GetWidth());
    end;

    /// <summary>
    /// Gets the height in pixels.
    /// </summary>
    /// <returns>The height in pixels.</returns>
    procedure GetHeight(): Integer
    begin
        exit(ImageImpl.GetHeight());
    end;

    /// <summary>
    /// Resizes the Image to the specified size.
    /// </summary>
    /// <param name="Width">The resize width.</param>
    /// <param name="Height">The resize height.</param>
    /// <error>Width and Height is less than one.</error>
    procedure Resize(Width: Integer; Height: Integer)
    begin
        ImageImpl.Resize(Width, Height);
    end;

    /// <summary>
    /// Rotates, flips, or rotates and flips the image.
    /// </summary>
    /// <param name="RotateFlipType">The type of rotation and flip.</param>
    procedure RotateFlip(RotateFlipType: Enum "Rotate Flip Type")
    begin
        ImageImpl.RotateFlip(RotateFlipType);
    end;

    /// <summary>
    /// Saves the image to the specified stream in the specified format.
    /// </summary>
    /// <param name="OutStream">A Stream that will store the image data.</param>
    procedure Save(OutStream: OutStream)
    begin
        ImageImpl.Save(OutStream);
    end;

    /// <summary>
    /// Convert the image to a base64 encoded string.
    /// </summary>
    /// <returns>A string containing the image data encoded with base64.</returns>
    procedure ToBase64(): Text
    begin
        exit(ImageImpl.ToBase64());
    end;

    /// <summary>
    /// Gets the image rotation flip type.
    /// </summary>
    /// <returns>The type of rotation and flip of the image.</returns>
    procedure GetRotateFlipType(): Enum "Rotate Flip Type"
    begin
        exit(ImageImpl.GetRotateFlipType());
    end;
}