> For the complete documentation index, see [llms.txt](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/layer.md).

# Layer

## Summary

A layer in the current sketch

## Instance Properties

<table data-full-width="false"><thead><tr><th>Name</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td>strokes</td><td><a href="/open-brush-plugin-scripting-docs/readme/strokelist.md">StrokeList</a><br>Read-only</td><td>All the strokes on this layer</td></tr><tr><td>images</td><td><a href="/open-brush-plugin-scripting-docs/readme/imagelist.md">ImageList</a><br>Read-only</td><td>All the images on this layer</td></tr><tr><td>allowStrokeAnimation</td><td>boolean<br>Read/Write</td><td>Sets whether or not individual strokes on this layer can be animated via</td></tr><tr><td>videos</td><td><a href="/open-brush-plugin-scripting-docs/readme/videolist.md">VideoList</a><br>Read-only</td><td>All the videos on this layer</td></tr><tr><td>models</td><td><a href="/open-brush-plugin-scripting-docs/readme/modellist.md">ModelList</a><br>Read-only</td><td>All the models on this layer</td></tr><tr><td>guides</td><td><a href="/open-brush-plugin-scripting-docs/readme/guidelist.md">GuideList</a><br>Read-only</td><td>All the guides on this layer</td></tr><tr><td>cameraPaths</td><td><a href="/open-brush-plugin-scripting-docs/readme/camerapathlist.md">CameraPathList</a><br>Read-only</td><td>All the camera paths on this layer</td></tr><tr><td>groups</td><td><a href="/open-brush-plugin-scripting-docs/readme/grouplist.md">GroupList</a><br>Read-only</td><td>All the groups on this layer</td></tr><tr><td>index</td><td>number<br>Read-only</td><td>Gets the index of the layer in the layer canvases</td></tr><tr><td>active</td><td>boolean<br>Read/Write</td><td>Is the layer the active layer. Making another layer inactive will make the main layer the active layer again.</td></tr><tr><td>transform</td><td><a href="/open-brush-plugin-scripting-docs/readme/transform.md">Transform</a><br>Read/Write</td><td>The transform of the layer</td></tr><tr><td>position</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a><br>Read/Write</td><td>The 3D position of the Layer (specifically the position of it's anchor point</td></tr><tr><td>rotation</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read/Write</td><td>The rotation of the layer in 3D space</td></tr><tr><td>scale</td><td>number<br>Read/Write</td><td>The scale of the layer</td></tr></tbody></table>

## Class Methods

### Layer:New()

Creates a new layer

**Returns:** [Layer](/open-brush-plugin-scripting-docs/readme/layer.md) (The new layer)

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer = Layer:New()
</strong></code></pre>

### Layer:SelectAll()

Selects all strokes and widgets on this layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SelectAll()
</strong></code></pre>

## Instance Methods

### layer:CenterPivot()

Move the pivot point of the layer to the average center of it's contents

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:CenterPivot()
</strong></code></pre>

### layer:ShowPivot()

Shows a visible widget indicating the pivot point of the layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:ShowPivot()
</strong></code></pre>

### layer:HidePivot()

Hides the visible widget indicating the pivot point of the layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:HidePivot()
</strong></code></pre>

### layer:Clear()

Deletes all content from the layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:Clear()
</strong></code></pre>

### layer:Delete()

Deletes the layer and all it's content

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:Delete()
</strong></code></pre>

### layer:Squash()

Combines this layer and the one above it. If this layer is the first layer do nothing

**Returns:** [Layer](/open-brush-plugin-scripting-docs/readme/layer.md) (The layer that contains the combined content)

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>combinedLayer = myLayer:Squash()
</strong></code></pre>

### layer:SquashTo(destinationLayer)

Combines this layer with the specified layer

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>destinationLayer</td><td><a href="/open-brush-plugin-scripting-docs/readme/layer.md">Layer</a></td><td></td><td>The destination layer</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SquashTo(otherLayer)
</strong></code></pre>

### layer:Show()

Shows the layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:Show()
</strong></code></pre>

### layer:Hide()

Hides the layer

**Returns:** nil

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:Hide()
</strong></code></pre>

### layer:SetShaderClipping(clipStart, clipEnd)

Hides the section of the each batch of strokes that is outside the specified range. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>clipStart</td><td>number</td><td></td><td>The amount of the stroke to hide from the start (0-1)</td></tr><tr><td>clipEnd</td><td>number</td><td></td><td>The amount of the stroke to hide from the end (0-1)</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderClipping(0.1, 0.9)
</strong></code></pre>

### layer:SetShaderClipping(brushType, clipStart, clipEnd)

Hides the section of the each batch of strokes that is outside the specified range. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>brushType</td><td>string</td><td></td><td>Only strokes of this brush type will be affected</td></tr><tr><td>clipStart</td><td>number</td><td></td><td>The amount of the stroke to hide from the start (0-1)</td></tr><tr><td>clipEnd</td><td>number</td><td></td><td>The amount of the stroke to hide from the end (0-1)</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderClipping("Ink", 0.1, 0.9)
</strong></code></pre>

### layer:SetShaderFloat(parameter, value)

Changes a shader float parameter. Affects all strokes on this layer

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>value</td><td>number</td><td></td><td>The new value</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderFloat("_EmissionGain", 0.5)
</strong></code></pre>

### layer:SetShaderFloat(brushType, parameter, value)

Changes a shader float parameter. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>brushType</td><td>string</td><td></td><td>Only strokes of this brush type will be affected</td></tr><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>value</td><td>number</td><td></td><td>The new value</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderFloat("Light", "_EmissionGain", 0.5)
</strong></code></pre>

### layer:SetShaderColor(parameter, color)

Changes a shader color parameter. Affects all strokes on this layer

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>color</td><td><a href="/open-brush-plugin-scripting-docs/readme/color.md">Color</a></td><td></td><td>The new color</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderColor("_TintColor", Color.red)
</strong></code></pre>

### layer:SetShaderColor(brushType, parameter, color)

Changes a shader color parameter. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>brushType</td><td>string</td><td></td><td>Only strokes of this brush type will be affected</td></tr><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>color</td><td><a href="/open-brush-plugin-scripting-docs/readme/color.md">Color</a></td><td></td><td>The new color</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderColor("Embers", "_TintColor", Color.red)
</strong></code></pre>

### layer:SetShaderTexture(parameter, image)

Changes a shader texture parameter. Affects all strokes on this layer

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>image</td><td><a href="/open-brush-plugin-scripting-docs/readme/image.md">Image</a></td><td></td><td>The new image to use as a texture</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderTexture("_MainTex", myImage)
</strong></code></pre>

### layer:SetShaderTexture(brushType, parameter, image)

Changes a shader texture parameter. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>brushType</td><td>string</td><td></td><td>Only strokes of this brush type will be affected</td></tr><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>image</td><td><a href="/open-brush-plugin-scripting-docs/readme/image.md">Image</a></td><td></td><td>The new image to use as a texture</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderTexture("Ink", "_MainTex", myImage)
</strong></code></pre>

### layer:SetShaderVector(parameter, x, y, z, w)

Changes a shader vector parameter. Affects all strokes on this layer

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>x</td><td>number</td><td></td><td>The new x value</td></tr><tr><td>y</td><td>number</td><td>0</td><td>The new y value</td></tr><tr><td>z</td><td>number</td><td>0</td><td>The new z value</td></tr><tr><td>w</td><td>number</td><td>0</td><td>The new w value</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderVector("_TimeOverrideValue", 0.5, 0, 0, 0)
</strong></code></pre>

### layer:SetShaderVector(brushType, parameter, x, y, z, w)

Changes a shader vector parameter. Affects all strokes on this layer with this brush type

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>brushType</td><td>string</td><td></td><td>Only strokes of this brush type will be affected</td></tr><tr><td>parameter</td><td>string</td><td></td><td>The shader parameter name</td></tr><tr><td>x</td><td>number</td><td></td><td>The new x value</td></tr><tr><td>y</td><td>number</td><td>0</td><td>The new y value</td></tr><tr><td>z</td><td>number</td><td>0</td><td>The new z value</td></tr><tr><td>w</td><td>number</td><td>0</td><td>The new w value</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myLayer:SetShaderVector("NeonPulse", "_TimeOverrideValue", 0.5, 0, 0, 0)
</strong></code></pre>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/layer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.