# Set Background

This **Node** has different versions based on what `Mode` is set in the **Attributes**.

{% tabs %}
{% tab title="Color" %}

## Overview

![The Set Background Color Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-519e3e75e0acdf5ef0d9ce84b1e60d07392adc6c%2Fsetbackgroundcolornode.png?alt=media)

The **Set Background Color Node** sets the `Color` for the inputted **Screen's** background.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Color Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-738e1624476862950bed6c0582519036eca73e12%2Fsetbackgroundcolornodeatts.png?alt=media)

| Attribute | Type               | Description                                                                                          |
| --------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
| `Mode`    | **Dropdown**       | The type of background that will be set. In this case, `Color` has been chosen.                      |
| `Color`   | **Color Selector** | The color to be set for the **Screen's** background, if one is not provided in the **Input Socket**. |

## Inputs

| Input             | Type         | Description                                                           |
| ----------------- | ------------ | --------------------------------------------------------------------- |
| *Pulse Input* (►) | **Pulse**    | A standard **Input Pulse**, to trigger the execution of the **Node**. |
| `ScreenID`        | **ScreenID** | The ID of the **Screen** that will have its background color set.     |
| `Color`           | **Color**    | The color to be set for the **Screen's** background.                  |

## Outputs

| Output             | Type      | Description                                                                                                                            |
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Pulse Output* (►) | **Pulse** | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution. |
| {% endtab %}       |           |                                                                                                                                        |

{% tab title="Texture" %}

## Overview

![The Set Background Texture\_Quad Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-eac6d02993e4daab4ab6e9a8939b650dcf92c32a%2Fsetbackgroundtexturenode.png?alt=media)

The **Set Background Texture\_Quad Node** sets the `Texture` for the inputted **Screen's** background.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Texture\_Quad Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-39a90c4f0aa4f0263b435cc454e59f85fac2317a%2Fsetbackgroundtexturenodeatts.png?alt=media)

| Attribute | Type              | Description                                                                                                |
| --------- | ----------------- | ---------------------------------------------------------------------------------------------------------- |
| `Mode`    | **Dropdown**      | The type of background that will be set. In this case, `Texture` has been chosen.                          |
| `Texture` | **File Selector** | The **Texture** to be set for the **Screen's** background, if one is not provided in the **Input Socket**. |

## Inputs

| Input             | Type          | Description                                                             |
| ----------------- | ------------- | ----------------------------------------------------------------------- |
| *Pulse Input* (►) | **Pulse**     | A standard **Input Pulse**, to trigger the execution of the **Node**.   |
| `ScreenID`        | **ScreenID**  | The ID of the **Screen** that will have its background **Texture** set. |
| `TextureID`       | **TextureID** | The **Texture** to be set for the **Screen's** background.              |

## Outputs

| Output             | Type      | Description                                                                                                                            |
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Pulse Output* (►) | **Pulse** | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution. |
| {% endtab %}       |           |                                                                                                                                        |

{% tab title="Scene Environment" %}

## Overview

![The Set Background Scene Environment Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-2ffb858005a5186269ea20fc15c4b1caf0e71403%2Fsetbackgroundsceneenvironmentnode.png?alt=media)

The **Set Background Scene Environment Node** sets the `Scene Environment` for the inputted **Screen's** background. This is decided in the [Scene Environment](https://docs.incari.com/incari-studio/2023.2/objects-and-types/project-objects/screen#background) option in the **Screen's** `Background` **Attributes**.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Scene Environment Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-c391e115f12bd8e38655987befe82c12d0bd2f92%2Fsetbackgroundsceneenvironmentnodeatts.png?alt=media)

| Attribute | Type         | Description                                                                                 |
| --------- | ------------ | ------------------------------------------------------------------------------------------- |
| `Mode`    | **Dropdown** | The type of background that will be set. In this case, `Scene Environment` has been chosen. |

## Inputs

| Input             | Type         | Description                                                                         |
| ----------------- | ------------ | ----------------------------------------------------------------------------------- |
| *Pulse Input* (►) | **Pulse**    | A standard **Input Pulse**, to trigger the execution of the **Node**.               |
| `ScreenID`        | **ScreenID** | The ID of the **Screen** that will have its **Screen's** **Scene Environment** set. |
| {% endtab %}      |              |                                                                                     |

{% tab title="Gradient" %}

## Overview

![The Set Background Gradient Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-0d40fd62805da911529133c43a7ffc45f63fbffc%2Fsetbackgroundgradientnode.png?alt=media)

The **Set Background Gradient Node** sets the `Gradient` for the inputted **Screen's** background.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Gradient Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-eaa7fe2245de7da90bbfd45f9f612fbea9e554cc%2Fsetbackgroundgradientnodeatts.png?alt=media)

| Attribute      | Type               | Description                                                                                                          |
| -------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------- |
| `Mode`         | **Dropdown**       | The type of background that will be set. In this case, `Gradient` has been chosen.                                   |
| `Top Color`    | **Color Selector** | The top color to be set for the **Screen's** gradient background, if one is not provided in the **Input Socket**.    |
| `Bottom Color` | **Color Selector** | The bottom color to be set for the **Screen's** gradient background, if one is not provided in the **Input Socket**. |

## Inputs

| Input             | Type               | Description                                                           |
| ----------------- | ------------------ | --------------------------------------------------------------------- |
| *Pulse Input* (►) | **Pulse**          | A standard **Input Pulse**, to trigger the execution of the **Node**. |
| `ScreenID`        | **ScreenID**       | The ID of the **Screen** that will have its background gradient set.  |
| `Top Color`       | **Color Selector** | The top color to be set for the **Screen's** gradient background.     |
| `Bottom Color`    | **Color Selector** | The bottom color to be set for the **Screen's** gradient background.  |

## Outputs

| Output             | Type      | Description                                                                                                                            |
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Pulse Output* (►) | **Pulse** | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution. |
| {% endtab %}       |           |                                                                                                                                        |
| {% endtabs %}      |           |                                                                                                                                        |
