# RV Masking

## Usage <a href="#h_01hpjfdjpjfgjjcq1cb0pke746" id="h_01hpjfdjpjfgjjcq1cb0pke746"></a>

Creates a sub-menu called SG Masking. The matte characteristics are specified in Shotgun on a CustomNonProjectEntity by aspect ratio, a visible fraction of the image, as well as the center point of the matte in normalized coordinates.

You may configure the definitions by using the SG Masking > Manage Mask Definitions menu item, which will forward you to the shotgun page. Once you've changed the definition you may use the SG Masking > Force Reloading Mask Definitions menu item to get the updated settings.

To change the matte opacity please use the SG Masking > Opacity sub menu and to change the matte use the SG Masking > Masks sub-menu.

<figure><img src="/files/c0AIWT3zXkt1tG8hDMmj" alt=""><figcaption></figcaption></figure>

## Example <a href="#h_01hpjfkk3xd0w1n74r44h1z9e0" id="h_01hpjfkk3xd0w1n74r44h1z9e0"></a>

Raw image:

<figure><img src="/files/ATCo52jY6A8bbKEyrwPS" alt=""><figcaption></figcaption></figure>

Selected 16:9 (1.178) ratio with semi-transparent:

<figure><img src="/files/iHnDoGEuEbGSk9Ws1hjJ" alt=""><figcaption></figcaption></figure>

Selected widescreen (1.85) ratio with semi-transparent:

<figure><img src="/files/bi4TYz7kBI5ui4Tdm7J4" alt=""><figcaption></figcaption></figure>

Selected Univisium with semi-transparent:

<figure><img src="/files/WzzUTWQzriO3Fv3Bqa2R" alt=""><figcaption></figcaption></figure>

Selected widescreen (1.85) ratio with opaque:

<figure><img src="/files/99qhAesXtJR6grDtDoxA" alt=""><figcaption></figcaption></figure>

## Shotgun Mask Definition <a href="#h_01hpjfxra9x97476yj5f6hz8wy" id="h_01hpjfxra9x97476yj5f6hz8wy"></a>

The following is a description of the field values in Shotgun.

<figure><img src="/files/72VpT0jzXiu3rzaEMLgJ" alt=""><figcaption></figcaption></figure>

* Name: used for user feedback and UI
* Ratio: of the unmatted visible area
* Visible Height: Fraction of image visible by height (if top and bottom are 5% matted then this would be 0.9)
* Center X: Center point of matte in normalized X (0 is centered see "Normalized Coordinates" below)
* Center Y: Center point of matte in normalized Y (0 is centered see "Normalized Coordinates" below)
* Description: Long-form descriptive text

## Configuration <a href="#h_01hpjg86sc5aaegg1d8225g07n" id="h_01hpjg86sc5aaegg1d8225g07n"></a>

This package makes use of a CustomNonProjectEntity with the following extra fields:

* Ratio (Float): sg\_ratio
* Height Visible (Float): sg\_height\_visible
* Center X (Float): sg\_center\_x
* Center Y (Float): sg\_center\_y

To configure the shotgun entries please edit the config.json, which looks like this:

```
{
    "sg-masking-mode": {
        "entity-type": "CustomNonProjectEntity08",
        "page-id": "1482",
        "entity-fields": {
            "name": "code",
            "ratio": "sg_ratio",
            "height-visible": "sg_height_visible",
            "center-x": "sg_center_x",
            "center-y": "sg_center_y",
            "description": "description"
        }
   }
}
```

After installation of the package you can edit the config file by using the SG Masking > Advances > Settings menu item:

<figure><img src="/files/LFvSB0MMmY0kEYAJnp52" alt=""><figcaption></figcaption></figure>

After saving you need to use the Force Reloading Mask Definitions to apply the changes to your current session. Otherwise it will be available on the next start of RV.

## Environment Configuration <a href="#h_01hpjgbpet2fej27z7rxcmd9rb" id="h_01hpjgbpet2fej27z7rxcmd9rb"></a>

It is possible to overwrite the configuration by using an environment variable. To do so, save your desired configuration into a json-file. Store the file-path into the environment-variable: RV\_PACKAGE\_SETTINGS and start RV from this environment.


---

# 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://artist-anywhere.gitbook.io/artist-anywhere/review-tools/rv-masking.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.