# 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.](/files/gmPXVEiQ6MGCUlLXTg90)

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

[**Scope**](/incari-studio/2024.1/toolbox/overview.md#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Color Node Attributes.](/files/nrpAYOrNqaV8v0r5mWJb)

| 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.](/files/S1Gh1I1J6KpqKjtPhiGv)

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

[**Scope**](/incari-studio/2024.1/toolbox/overview.md#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Texture\_Quad Node Attributes.](/files/t4BmrqxSVuWueAWg4eyi)

| 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.](/files/TlCVMoDMInBloR66EkAU)

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

[**Scope**](/incari-studio/2024.1/toolbox/overview.md#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Scene Environment Node Attributes.](/files/3RTKz9TFb4LG9XSDNk7X)

| 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.](/files/knpcPcPWEhb4rjBT8Fk2)

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

[**Scope**](/incari-studio/2024.1/toolbox/overview.md#scopes): **Project**, **Function**, **Prefab**.

## Attributes

![The Set Background Gradient Node Attributes.](/files/iX9Z2Vr0KwKIRS3cGhnd)

| 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 %}      |           |                                                                                                                                        |


---

# 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://docs.incari.com/incari-studio/2024.1/toolbox/incari/screen/setbackground.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.