Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AlphaOption.cs xml docs #1465

Merged
merged 2 commits into from
Oct 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 26 additions & 12 deletions src/Magick.NET.Core/Enums/AlphaOption.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,34 @@ public enum AlphaOption
Undefined,

/// <summary>
/// Activate.
/// Enable the image's transparency channel. Note that normally Set should be used instead of
/// this, unless you specifically need to preserve the existing (but specifically turned Off)
/// transparency channel.
/// </summary>
Activate,

/// <summary>
/// Associate.
/// Associate the alpha channel with the image.
/// </summary>
Associate,

/// <summary>
/// Background.
/// Set any fully-transparent pixel to the background color, while leaving it fully-transparent.
/// This can make some image file formats, such as PNG, smaller as the RGB values of transparent
/// pixels are more uniform, and thus can compress better.
/// </summary>
Background,

/// <summary>
/// Copy.
/// Turns 'On' the alpha/matte channel, then copies the grayscale intensity of the image, into
/// the alpha channel, converting a grayscale mask into a transparent shaped mask ready to be
/// colored appropriately. The color channels are not modified.
/// </summary>
Copy,

/// <summary>
/// Deactivate.
/// Disables the image's transparency channel. This does not delete or change the existing data,
/// it just turns off the use of that data.
/// </summary>
Deactivate,

Expand All @@ -44,12 +51,14 @@ public enum AlphaOption
Discrete,

/// <summary>
/// Disassociate.
/// Disassociate the alpha channel from the image.
/// </summary>
Disassociate,

/// <summary>
/// Extract.
/// Copies the alpha channel values into all the color channels and turns 'Off' the image's
/// transparency, so as to generate a grayscale mask of the image's shape. The alpha channel
/// data is left intact just deactivated. This is the inverse of 'Copy'.
/// </summary>
Extract,

Expand All @@ -64,27 +73,32 @@ public enum AlphaOption
On,

/// <summary>
/// Opaque.
/// Enables the alpha/matte channel and forces it to be fully opaque.
/// </summary>
Opaque,

/// <summary>
/// Remove.
/// Composite the image over the background color.
/// </summary>
Remove,

/// <summary>
/// Set.
/// Activates the alpha/matte channel. If it was previously turned off then it also
/// resets the channel to opaque. If the image already had the alpha channel turned on,
/// it will have no effect.
/// </summary>
Set,

/// <summary>
/// Shape.
/// As per 'Copy' but also colors the resulting shape mask with the current background color.
/// That is the RGB color channels is replaced, with appropriate alpha shape.
/// </summary>
Shape,

/// <summary>
/// Transparent.
/// Activates the alpha/matte channel and forces it to be fully transparent. This effectively
/// creates a fully transparent image the same size as the original and with all its original
/// RGB data still intact, but fully transparent.
/// </summary>
Transparent,
}