# OfficeDrawingSoftMask

Reusable vector soft mask applied while an isolated drawing group is composited.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeDrawingSoftMask.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L33)

**Modifiers**

sealed

Reusable vector soft mask applied while an isolated drawing group is composited.

## Inheritance

- object
- OfficeDrawingSoftMask

## Usage

Explore 4 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Property [OfficeDrawingEffectGroup.SoftMask](/api/core/officeimo-drawing-officedrawingeffectgroup/#property-softmask)
- Method [OfficeDrawingSoftMask.CreateWithLuminosityStandard](/api/core/officeimo-drawing-officedrawingsoftmask/#method-createwithluminositystandard-officeimo-drawing-officedrawing-officeimo-drawing-officesoftmaskluminositystandard-officeimo-drawing-officesoftmaskmode-nullable-officeimo-drawing-officetransform-nullable-officeimo-officecolor)

### Accepted by parameters 2

- Method [OfficeDrawing.AddEffectDrawing](/api/core/officeimo-drawing-officedrawing/#method-addeffectdrawing-officeimo-drawing-officedrawing-officeimo-drawing-officetransform-officeimo-drawing-officeblendmode-officeimo-drawing-officedrawingsoftmask-double) parameter `softMask`
- Constructor [OfficeDrawingEffectGroup.OfficeDrawingEffectGroup](/api/core/officeimo-drawing-officedrawingeffectgroup/#constructor-ctor-officeimo-drawing-officedrawing-officeimo-drawing-officetransform-officeimo-drawing-officeblendmode-officeimo-drawing-officedrawingsoftmask-double) parameter `softMask`

Filter members 

Show inherited

## Constructors

OfficeDrawingSoftMask 2 overloads

`public OfficeDrawingSoftMask(OfficeDrawing drawing, OfficeSoftMaskMode mode = Alpha, OfficeTransform? transform = null, OfficeColor? backdropColor = null)` [#](#constructor-ctor-officeimo-drawing-officedrawing-officeimo-drawing-officesoftmaskmode-nullable-officeimo-drawing-officetransform-nullable-officeimo-officecolor)

[OfficeDrawingSoftMask.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L33)

Creates a mask from drawing content in the source group's local coordinate system.

Parameters

**drawing OfficeIMO.Drawing.OfficeDrawing required**

**mode OfficeIMO.Drawing.OfficeSoftMaskMode = Alpha optional**

**transform OfficeIMO.Drawing.OfficeTransform? = null optional**

**backdropColor OfficeIMO.OfficeColor? = null optional**

`public OfficeDrawingSoftMask(OfficeDrawing drawing, OfficeSoftMaskMode mode, OfficeTransform? transform, OfficeColor? backdropColor, OfficeSoftMaskLuminosityStandard luminosityStandard)` [#](#member-3dd3301f30c14512d5e8b071)

[OfficeDrawingSoftMask.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L46)

Creates a mask with all interpretation settings supplied positionally.

Parameters

**drawing OfficeIMO.Drawing.OfficeDrawing required**

**mode OfficeIMO.Drawing.OfficeSoftMaskMode required**

**transform OfficeIMO.Drawing.OfficeTransform? required**

**backdropColor OfficeIMO.OfficeColor? required**

**luminosityStandard OfficeIMO.Drawing.OfficeSoftMaskLuminosityStandard required**

## Methods

`public static OfficeDrawingSoftMask CreateWithLuminosityStandard(OfficeDrawing drawing, OfficeSoftMaskLuminosityStandard luminosityStandard, OfficeSoftMaskMode mode = Alpha, OfficeTransform? transform = null, OfficeColor? backdropColor = null)` [#](#member-188ec780e099b0130054a303)

[OfficeDrawingSoftMask.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L43)

Creates a mask with an explicit luminosity standard.

Parameters

**drawing OfficeIMO.Drawing.OfficeDrawing required**

**luminosityStandard OfficeIMO.Drawing.OfficeSoftMaskLuminosityStandard required**

**mode OfficeIMO.Drawing.OfficeSoftMaskMode = Alpha optional**

**transform OfficeIMO.Drawing.OfficeTransform? = null optional**

**backdropColor OfficeIMO.OfficeColor? = null optional**

Returns

`OfficeDrawingSoftMask`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public OfficeDrawing Drawing { get; }` [#](#property-drawing)

[OfficeDrawingSoftMask.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L66)

Detached mask drawing.

`public OfficeSoftMaskMode Mode { get; }` [#](#property-mode)

[OfficeDrawingSoftMask.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L69)

Mask interpretation.

`public OfficeTransform Transform { get; }` [#](#property-transform)

[OfficeDrawingSoftMask.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L72)

Local transform applied to the mask before it is sampled.

`public OfficeColor BackdropColor { get; }` [#](#property-backdropcolor)

[OfficeDrawingSoftMask.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L75)

Color used where the mask drawing has no coverage.

`public OfficeSoftMaskLuminosityStandard LuminosityStandard { get; }` [#](#property-luminositystandard)

[OfficeDrawingSoftMask.cs:78](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeDrawingSoftMask.cs#L78)

Luminance coefficients used when [OfficeDrawingSoftMask.Mode](/api/core/officeimo-drawing-officedrawingsoftmask/) is [OfficeSoftMaskMode.Luminosity](/api/core/officeimo-drawing-officesoftmaskmode/).

<!-- PowerForge markdown artifact sha256:38FC6096291375636DFDFDFF3C97E2BB0B667AC6B9A4D2E9BFC0D6BA6699882E -->
