# MaskOptions
Options for creating a new mask.

{/* Do not edit this file. It is automatically generated by API Documenter. */}

## MaskOptions interface

Options for creating a new mask.

**Signature:**

```typescript
interface MaskOptions
```

## Properties

<table>
  <thead>
    <tr>
      <th>
        Property
      </th>

      <th>
        Modifiers
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [mode](/en/creator-api/types/mask-options/mode)
      </td>

      <td />

      <td>
        [MaskMode](/en/creator-api/types/mask-mode)
      </td>

      <td>
        The mode of the mask
      </td>
    </tr>

    <tr>
      <td>
        [opacity?](/en/creator-api/types/mask-options/opacity)
      </td>

      <td />

      <td>
        number | undefined
      </td>

      <td>
        _(Optional)_ The opacity of the mask effect (0 to 100)
      </td>
    </tr>

    <tr>
      <td>
        [pathData](/en/creator-api/types/mask-options/path-data)
      </td>

      <td />

      <td>
        [PathData](/en/creator-api/values/path-data)
      </td>

      <td>
        The path data defining the mask shape
      </td>
    </tr>
  </tbody>
</table>