GrapeCity.Documents.Imaging.OpacityEffect

Class OpacityEffect

Namespace

GrapeCity.Documents.Imaging

Assembly

GcDocs.Imaging.dll

In-place effect that adjusts the opacity of an image by multiplying the alpha channel of the input by the specified opacity value.

public class OpacityEffect : BaseInplaceEffect

Inheritance

object

BaseInplaceEffect

OpacityEffect

Inherited Members

BaseInplaceEffect.SupportsPremultiplied

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Apply(GcBitmap, int, int, int, int)

Applies the effect to a part of the specified GcBitmap.

protected override void Apply(GcBitmap bitmap, int x, int y, int width, int height)

Parameters

bitmap GcBitmap

The target GcBitmap.

x int

The x-coordinate of the target rectangle, in pixels.

y int

The y-coordinate of the target rectangle, in pixels.

width int

The width of the target rectangle, in pixels.

height int

The height of the target rectangle, in pixels.

Apply(GcBitmap)

Applies the effect to the specified GcBitmap.

protected override void Apply(GcBitmap bitmap)

Parameters

bitmap GcBitmap

The target GcBitmap.

Get(float)

Returns an instance of the OpacityEffect class.

public static OpacityEffect Get(float opacity)

Parameters

opacity float

The multiplier to the input image's alpha channel. The minimum value is 0.0f and the maximum value is 1.0f.

Returns

OpacityEffect