# Grayscale Filter

## Description

Apply a Grayscale filter to an Image

{% tabs %}
{% tab title="Preview" %}
![](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2F4nLX9x7phesGoEKX8Xvo%2FComponent-FilterGrayscale.png?alt=media\&token=e9a4f89a-d54a-41e6-9002-ec2962494a13)
{% endtab %}

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

**Nickname** | Grayscale

**Tab** | Bitmap

**Panel** | Filter

**Division** | 2
{% 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>*

<mark style="color:orange;">**V2**</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" %}
![](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FeV1ulrSGqAXPXGlo6uDD%2Fimage.png?alt=media\&token=fb42f272-523b-4276-8531-df4f25a0a55c)

**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>

* Y = 0
* RMY = 1
* BT709 = 2
* Simple = 3
  * *V0 =* **R** | **Red** | The Red coefficient
  * *V1 =* **G** | **Green** | The Green coefficient
  * *V2 =* **B** | **Blue** | The Blue coefficient

</details>

## Usage

### Grayscale Mode Samples

![BT709](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FjH4fo2Asx0KkHnL0SZIZ%2FBT709.jpg?alt=media\&token=4f8d6c74-a9e9-4276-a428-20d3146d99dc) ![RMY](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FvZZNSoDHkpzVKmAgjYuw%2FRMY.jpg?alt=media\&token=34324b6c-0497-49e9-b5cd-4160f321ae6b)

![Simple](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FNLsPl3wrQW8xxsyM6APi%2FSimple.jpg?alt=media\&token=a4a8b8d4-d455-4d4d-8993-c871a1c4a0a9) ![Luma](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FssGXRnpo81KrwNnDQ0F0%2FY.jpg?alt=media\&token=2d80dcb8-e86a-4230-9d23-8b9fadb0aeff)