# Effects Filter

## Description

Apply an Effects filter to an Image

{% tabs %}
{% tab title="Preview" %}
![](/files/43E1Bmzm2RwpSRSLGMUI)
{% endtab %}

{% tab title="Location" %}
**Name** | Effects Filter

**Nickname** | Effects

**Tab** | Bitmap

**Panel** | Filter

**Division** | 1
{% endtab %}

{% tab title="Inputs" %}
**I** | **Image** (*B+ Image, Bitmap*) | A Bitmap Plus Image or Bitmap

<mark style="color:blue;">**M**</mark> <mark style="color:blue;"></mark><mark style="color:blue;">|</mark> <mark style="color:blue;"></mark><mark style="color:blue;">**Mode**</mark> <mark style="color:blue;"></mark><mark style="color:blue;">(</mark>*<mark style="color:blue;">Integer</mark>*<mark style="color:blue;">) | Select filter mode</mark>

<mark style="color:orange;">**V0**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">|</mark> <mark style="color:orange;"></mark><mark style="color:orange;">**Parameter**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">(</mark>*<mark style="color:orange;">Number</mark>*<mark style="color:orange;">) |</mark> <mark style="color:orange;"></mark>*<mark style="color:orange;">This variable's use changes depending on the mode</mark>*

<mark style="color:orange;">**V1**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">|</mark> <mark style="color:orange;"></mark><mark style="color:orange;">**Parameter**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">(</mark>*<mark style="color:orange;">Number</mark>*<mark style="color:orange;">) |</mark> <mark style="color:orange;"></mark>*<mark style="color:orange;">This variable's use changes depending on the mode</mark>*
{% endtab %}

{% tab title="Ouputs" %}
**I** | **Image** (*B+ Image*) | A Bitmap Plus Image
{% endtab %}

{% tab title="Mode" %}
![](/files/S9AJm2ah8I4pcmsLkijU)

**Save Image** | Opens a file save dialog to save a raster file of the current image.

**Copy Image to Clipboard** | Copies the image to the clipboard (no alpha)
{% endtab %}
{% endtabs %}

### **Filter** Mode

<details>

<summary><strong>Filter</strong> Mode Enumerable</summary>

* Additive = 0
* Salt Pepper = 1
  * *V0 =* **N** | **Noise** | Noise Value. Unitized adjustment value (0-1)
* Daube = 2
  * *V0 =* **S** | **Size** | Size Value. Unitized adjustment value (0-1)
* Jitter = 3
  * *V0 =* **R** | **Radius** | Radius Value. Unitized adjustment value (0-1)
* Kuwahara = 4
  * *V0 =* **S** | **Size** | Size Value. Unitized adjustment value (0-1)
* Posterize = 5
  * *V0 =* **I** | **Interval** | Interval Value. Unitized adjustment value (0-1)
* Blur = 6
  * *V0 =* **D** | **Divisor** | Divisor Value. Unitized adjustment value (0-1)
  * *V1 =* **T** | **Threshold** | Threshold Value. Unitized adjustment value (0-1)
* Gaussian Blur = 7
  * *V0 =* **X** | **Sigma** | Sigma Value. Unitized adjustment value (0-1)
  * *V1 =* **S** | **Size** | Size Value. Unitized adjustment value (0-1)
* Pixellate = 8
  * *V0 =* **W** | **Width** | Width Value. Unitized adjustment value (0-1)
  * *V1 =* **H** | **Height** | Height Value. Unitized adjustment value (0-1)

</details>

## Usage

### Effect Mode Samples

![Additive](/files/DrhucrNnwkNnFRCaQf2a) ![Blur](/files/kvu8EYez0R14V3TsEvXL) ![Daube](/files/cBbQNWT09U0VUpF4wDNk)

![Gaussian Blur](/files/G5WyttdBgAItJDXeLElv) ![Jitter](/files/ACMPuWSuG6sokw1au0aT) ![Kuwahara](/files/fNISzmHAwczu3P16I7Q7)

![Pixelate](/files/pn3eN7abPmlKpQOmu9Ik) ![Posterize](/files/QLIYPOhutsdRCWXWkHQ7) ![Salt & Pepper](/files/3ATgfS7nxaH7dzgNtxyz)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://interopxyz.gitbook.io/bitmap-plus/components/filter/effects-filter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.