> For the complete documentation index, see [llms.txt](https://golua.fatality.win/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://golua.fatality.win/documentation/namespaces/render.md).

# Render

## Enums

<details>

<summary>Font flags</summary>

font\_flag\_shadow

font\_flag\_outline

</details>

<details>

<summary>Rect rounding</summary>

top\_left

top\_right

bottom\_left

bottom\_right

top

left

bottom

right

all

</details>

<details>

<summary>Rect outline</summary>

outline\_inset

outline\_outset

outline\_center

</details>

<details>

<summary>Text alignment</summary>

align\_top

align\_left

align\_center

align\_right

align\_bottom

</details>

<details>

<summary>Easings</summary>

* linear
* ease\_in
* ease\_out
* ease\_in\_out
* elastic\_in
* elastic\_out
* elastic\_in\_out
* bounce\_in
* bounce\_out
* bounce\_in\_out

</details>

## Datatypes

### color

```lua
render.color(255, 255, 255)
render.color(255, 255, 255, 100)
render.color("#FFFFFF")
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">r</td><td align="center">number</td><td align="center">red channel (0-255)</td><td align="center">❌</td></tr><tr><td align="center">g</td><td align="center">number</td><td align="center">green channel (0-255)</td><td align="center">❌</td></tr><tr><td align="center">b</td><td align="center">number</td><td align="center">blue channel (0-255)</td><td align="center">❌</td></tr><tr><td align="center">a</td><td align="center">number</td><td align="center">alpha channel (0-255)</td><td align="center">255</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">hex_code</td><td align="center">string</td><td align="center">hex color code</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|            table with rgba values            |                      table                      |

#### Table structure:

```lua
{ r, g, b, a }
```

### esp\_flag

```lua
render.esp_flag("some flag", render.color("#FFFFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">text</td><td align="center">string</td><td align="center">flag to draw</td></tr><tr><td align="center">color</td><td align="center"><a href="#color">render.color</a></td><td align="center">color to draw</td></tr></tbody></table>

## Fonts

### create\_font

```lua
render.create_font("smallest_pixel-7.ttf", 11, render.font_flag_outline)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">font_path</td><td align="center">string</td><td align="center">path to font or name of font</td><td align="center">❌</td></tr><tr><td align="center">size</td><td align="center">number</td><td align="center">font size</td><td align="center">❌</td></tr><tr><td align="center">flags</td><td align="center"><a href="#font-flags">render.font_flag</a></td><td align="center">font flag</td><td align="center">0</td></tr><tr><td align="center">from</td><td align="center">number</td><td align="center">minimum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">0</td></tr><tr><td align="center">to</td><td align="center">number</td><td align="center">maximum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">255</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                    font id                   |                      number                     |

### create\_font\_gdi

```lua
render.create_font_gdi("Smallest pixel-7", 11, render.font_flag_outline)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">font_path</td><td align="center">string</td><td align="center">path to font or name of font</td><td align="center">❌</td></tr><tr><td align="center">size</td><td align="center">number</td><td align="center">font size</td><td align="center">❌</td></tr><tr><td align="center">flags</td><td align="center"><a href="#font-flags">render.font_flag</a></td><td align="center">font flag</td><td align="center">0</td></tr><tr><td align="center">from</td><td align="center">number</td><td align="center">minimum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">0</td></tr><tr><td align="center">to</td><td align="center">number</td><td align="center">maximum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">255</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                    font id                   |                      number                     |

### create\_font\_stream

```lua
render.create_font_stream({0x1, ...}, 12)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">bytes</td><td align="center">table</td><td align="center">table of bytes</td><td align="center">❌</td></tr><tr><td align="center">size</td><td align="center">number</td><td align="center">font size</td><td align="center">❌</td></tr><tr><td align="center">flags</td><td align="center"><a href="#font-flags">render.font_flag</a></td><td align="center">font flag</td><td align="center">0</td></tr><tr><td align="center">from</td><td align="center">number</td><td align="center">minimum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">0</td></tr><tr><td align="center">to</td><td align="center">number</td><td align="center">maximum <a href="https://en.wikipedia.org/wiki/Code_point">codepoint</a></td><td align="center">255</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                    font id                   |                      number                     |

### get\_text\_size

```lua
render.get_text_size(font, "String to measure")
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th data-hidden align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">font</td><td align="center">number</td><td align="center">font id from <a href="#create_font">render.create_font</a></td><td align="center">❌</td></tr><tr><td align="center">text</td><td align="center">string</td><td align="center">string to measure</td><td align="center">❌</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                     width                    |                      number                     |
|                    height                    |                      number                     |

### wrap\_text <a href="#wrap_text" id="wrap_text"></a>

```lua
render.wrap_text(font, 'This is a really long string!', 250)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th data-hidden align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">font</td><td align="center">number</td><td align="center">font id from <a href="#create_font">render.create_font</a></td><td align="center">❌</td></tr><tr><td align="center">text</td><td align="center">string</td><td align="center">string to measure</td><td align="center">❌</td></tr><tr><td align="center">width</td><td align="center">number</td><td align="center">target text width</td><td align="center"></td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                     text                     |                      string                     |

### text

```lua
render.text(font, 10, 10, "this is some centered text", render.color("#FFFFFF"), render.align_center, render.align_center, render.align_left)
```

<table data-header-hidden><thead><tr><th width="184.00482791265205" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">font</td><td align="center">number</td><td align="center"><p>font id </p><p>(see <a href="#create_font">render.create_font</a>)</p></td><td align="center">❌</td></tr><tr><td align="center">x</td><td align="center">number</td><td align="center">first x coord</td><td align="center">❌</td></tr><tr><td align="center">y</td><td align="center">number</td><td align="center">first y coord</td><td align="center">❌</td></tr><tr><td align="center">text</td><td align="center">string</td><td align="center">text to draw</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">align_horizontal</td><td align="center">number</td><td align="center">horizontal alignment type</td><td align="center"><a href="#text-alignment">render.align_left</a></td></tr><tr><td align="center">align_vertical</td><td align="center">number</td><td align="center">vertical alignment type</td><td align="center"><a href="#text-alignment">render.align_top</a></td></tr><tr><td align="center">align_line</td><td align="center">number</td><td align="center">multiline alignment type</td><td align="center"><a href="#text-alignment">render.align_left</a></td></tr></tbody></table>

#### Pre-defined fonts:

* font\_gui\_main
* font\_gui\_title
* font\_gui\_bold
* font\_esp
* font\_esp\_name
* font\_indicator

<pre class="language-lua"><code class="lang-lua"><strong>-- Ex: render.font_gui_main, render.font_esp
</strong></code></pre>

## Shaders

### create\_shader

```lua
local shader = render.create_shader([[
    sampler s0;

    float4 main(float2 uv: TEXCOORD0): COLOR0
    {
        return tex2D(s0, uv);
    }
]]);
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">src</td><td align="center">string</td><td align="center">shader source code</td></tr></tbody></table>

#### Supported pre-defined shader parameters:

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"></th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center">Register</td><td align="center">Type</td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">s0</td><td align="center">sampler</td><td align="center">current texture</td></tr><tr><td align="center">c0</td><td align="center">float2</td><td align="center">current texture's dimensions</td></tr><tr><td align="center">c1</td><td align="center">float</td><td align="center">current time in seconds</td></tr><tr><td align="center">c2</td><td align="center">float</td><td align="center">current global alpha override</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                   shader id                  |                      number                     |

### set\_shader

```lua
render.set_shader(shader);
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">shader_id</td><td align="center">number / nil</td><td align="center">shader id returned from<br>render.create_shader</td></tr></tbody></table>

#### Usage:

Sets or resets a shader.

## Textures

### create\_texture

```lua
render.create_texture("fatality/image.jpg")
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">texture_path</td><td align="center">string</td><td align="center">path to texture</td></tr></tbody></table>

#### Supported image formats:

* JPEG
* PNG
* BMP
* GIF (non-animated)
* TGA
* PSD
* HDR
* PIC
* PNM (binary only)

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  texture id                  |                      number                     |

### create\_texture\_bytes

```lua
render.create_texture_bytes(bytes, 20)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">bytes</td><td align="center">unsigned char*</td><td align="center">array of bytes</td></tr><tr><td align="center">size</td><td align="center">number</td><td align="center">texture size</td></tr></tbody></table>

#### Supported Image Formats:

* JPEG
* PNG
* BMP
* GIF (non-animated)
* TGA
* PSD
* HDR
* PIC
* PNM (binary only)

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  texture id                  |                      number                     |

#### Note:

This function can only be used by utilizing the ffi library as it requires a byte array.\
One way to do such would be using [ISteamUtils::GetImageRGBA](https://partner.steamgames.com/doc/api/ISteamUtils#GetImageRGBA).

### create\_texture\_rgba

```lua
render.create_texture_rgba(bytes, 100, 100, row_stride)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">bytes</td><td align="center">unsigned char*</td><td align="center">array of bytes</td></tr><tr><td align="center">w</td><td align="center">number</td><td align="center">texture width</td></tr><tr><td align="center">h</td><td align="center">number</td><td align="center">texture height</td></tr><tr><td align="center">row_stride</td><td align="center">number</td><td align="center">number of bytes in each row<br>(image width * 4)</td></tr></tbody></table>

#### Supported Image Formats:

* JPEG
* PNG
* BMP
* GIF (non-animated)
* TGA
* PSD
* HDR
* PIC
* PNM (binary only)

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  texture id                  |                      number                     |

#### Note:

This function can only be used by utilizing the ffi library as it requires a byte array.\
One way to do such would be using [ISteamUtils::GetImageRGBA](https://partner.steamgames.com/doc/api/ISteamUtils#GetImageRGBA).

### create\_texture\_stream

```lua
render.create_texture_stream({0x1, 0x5, 0xff})
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">byte_stream</td><td align="center">table of bytes</td><td align="center">texture bytes</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  texture id                  |                      number                     |

### create\_texture\_svg

```lua
local svg_data = 
[[
    <svg style="width:24px;height:24px" viewBox="0 0 24 24">
    <path fill="#ffffff" d="M12.89,3L14.85,3.4L11.11,21L9.15,20.6L12.89,3M19.59,12L16,8.41V5.58L22.42,12L16,18.41V15.58L19.59,12M1.58,12L8,5.58V8.41L4.41,12L8,15.58V18.41L1.58,12Z" />
    </svg>
]]
render.create_texture_svg(svg_data, 20)
-- or
render.create_texture_svg("fatality/image.svg", 20)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">image</td><td align="center">string</td><td align="center">svg data or svg file path</td></tr><tr><td align="center">target_height</td><td align="center">number</td><td align="center">desired image height</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  texture id                  |                      number                     |

### push\_texture / set\_texture

```lua
local texture_id = render.create_texture("image.png"
render.set_texture(texture_id)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">texture_id</td><td align="center">number</td><td align="center">texture id returned from<br>render.create_texture</td></tr></tbody></table>

#### Pre-defined textures:

* texture\_logo\_head
* texture\_logo\_stripes
* texture\_cursor
* texture\_loading
* texture\_icon\_up
* texture\_icon\_down
* texture\_icon\_clear
* texture\_icon\_copy
* texture\_icon\_pase
* texture\_icon\_add
* texture\_icon\_search
* texture\_icon\_settings
* texture\_icon\_bug
* texture\_icon\_rage
* texture\_icon\_legit
* texture\_icon\_visuals
* texture\_icon\_misc
* texture\_icon\_scripts
* texture\_icon\_skins
* texture\_avatar

<pre class="language-lua"><code class="lang-lua"><strong>-- Ex: render.texture_logo_head, render.texture_avatar
</strong></code></pre>

#### Usage:

Sets a texture used by render functions.

### pop\_texture

```lua
render.pop_texture()
```

#### Usage:

Pops a previously used texture

### push\_uv / set\_uv

```lua
render.set_uv(0.25, 0.25, 0.75, 0.75)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x coord (0 - 1)</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y  coord (0 - 1)</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x coord (0 - 1)</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y coord (0 - 1)</td></tr></tbody></table>

#### Usage:

Adjusts texture coordinates. Use after calling [render.push\_texture](#push_texture).

### pop\_uv

```lua
render.pop_uv()
```

#### Usage:

Pops a previously used set of texture coordinates.

### get\_texture\_size

<pre class="language-lua"><code class="lang-lua"><strong>render.get_texture_size(texture_id)
</strong></code></pre>

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">texture_id</td><td align="center">number</td><td align="center">texture id from <a href="#create_texture">create_texture</a></td></tr></tbody></table>

#### Returns: <a href="#returns-5" id="returns-5"></a>

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                     width                    |                      number                     |
|                    height                    |                      number                     |

### get\_frame\_count <a href="#get_frame_count" id="get_frame_count"></a>

```lua
local framecount = render.get_frame_count(my_gif)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">texture_id</td><td align="center">number</td><td align="center">texture id from <a href="#create_texture">create_texture</a></td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                  framecount                  |                      number                     |

{% hint style="warning" %}
This function will return 0 if a texture is NOT an animated GIF.
{% endhint %}

## Drawing

### get\_screen\_size

<pre class="language-lua"><code class="lang-lua"><strong>local w, h = render.get_screen_size()
</strong></code></pre>

#### Returns:

| [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :---------------------------------------------: |
|                     width                    |                      number                     |
|                    height                    |                      number                     |

### push\_clip\_rect

```lua
render.push_clip_rect(10, 10, 110, 110)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td><td align="center">❌</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td><td align="center">❌</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td><td align="center">❌</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max y point</td><td align="center">❌</td></tr><tr><td align="center">intersect</td><td align="center">boolean</td><td align="center">should it intersect with existing clip rects</td><td align="center">false</td></tr></tbody></table>

#### Usage:

Pushes a clip rect so elements can only be drawn within the rect.

{% hint style="warning" %}
Make sure to follow the call with [render.pop\_clip\_rect](#pop_clip_rect)!

Failure to do so will result in undefined behavior!
{% endhint %}

### pop\_clip\_rect

```lua
render.pop_clip_rect()
```

#### Usage:

Pops a previously used clip rect

### rect\_filled

```lua
render.rect_filled(10, 10, 110, 110, render.color("#00FFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y point</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

#### Usage: <a href="#rec" id="rec"></a>

Draws a filled rectangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape.

### rect <a href="#rec" id="rec"></a>

```lua
render.rect(10, 10, 110, 110, render.color("#00FFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td><td align="center">❌</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td><td align="center">❌</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td><td align="center">❌</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y point</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">thickness</td><td align="center">float</td><td align="center">thickness of line</td><td align="center">1.f</td></tr><tr><td align="center">outline</td><td align="center">number</td><td align="center">outline type</td><td align="center"><a href="#enums">render.outline_inset</a></td></tr></tbody></table>

### rect\_rounded <a href="#rect_filled" id="rect_filled"></a>

```lua
render.rect_rounded(10, 10, 110, 110, render.color("#00FFFF"), 1.5, render.top)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td><td align="center">❌</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td><td align="center">❌</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td><td align="center">❌</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y point</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">rounding</td><td align="center">number</td><td align="center">amount of rounding</td><td align="center">❌</td></tr><tr><td align="center">rounding_flags</td><td align="center">number</td><td align="center">corners to round</td><td align="center"><a href="#enums">render.all</a></td></tr><tr><td align="center">thickness</td><td align="center">float</td><td align="center">thickness of line</td><td align="center">1.f</td></tr><tr><td align="center">outline</td><td align="center">number</td><td align="center">outline type</td><td align="center"><a href="#enums">render.outline_inset</a></td></tr></tbody></table>

#### Usage: <a href="#rec" id="rec"></a>

Draws a filled rounded rectangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape.

### rect\_filled\_rounded <a href="#rect_filled" id="rect_filled"></a>

```lua
render.rect_filled_rounded(10, 10, 110, 110, render.color("#00FFFF"), 1.5, render.top)
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td><td align="center">❌</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td><td align="center">❌</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td><td align="center">❌</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y point</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">rounding</td><td align="center">number</td><td align="center">amount of rounding</td><td align="center">❌</td></tr><tr><td align="center">rounding_flags</td><td align="center">number</td><td align="center">corners to round</td><td align="center"><a href="#undefined">render.all</a></td></tr></tbody></table>

#### Usage: <a href="#rec" id="rec"></a>

Draws a filled rounded rectangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape.

### rect\_filled\_multicolor

```lua
render.rect_filled_multicolor(10, 10, 110, 110,
    render.color("#FFFFFF"), render.color("#000000"),
    render.color("#FFFFFF"), render.color("#000000"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">min x point</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">min y point</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">max x point</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">max y point</td></tr><tr><td align="center">top_left</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">top_right</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">bottom_right</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">bottom_left</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

#### Usage:

Draws a multi-color rectangle.

### circle\_filled

```lua
render.circle_filled(110, 110, 50, render.color("#FFFFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x</td><td align="center">number</td><td align="center">center x point</td><td align="center">❌</td></tr><tr><td align="center">y</td><td align="center">number</td><td align="center">center y point</td><td align="center">❌</td></tr><tr><td align="center">radius</td><td align="center">number</td><td align="center">the circles radius</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">segments</td><td align="center">number</td><td align="center">number of points<br>(circle resolution)</td><td align="center">12</td></tr><tr><td align="center">percentage</td><td align="center">number</td><td align="center">how much of the circle is drawn (0 - 1)</td><td align="center">1</td></tr><tr><td align="center">angle</td><td align="center">number</td><td align="center">circle rotation (0 - 360Draws a filled multi-color rectangle.)</td><td align="center">0</td></tr></tbody></table>

#### Usage: <a href="#rec" id="rec"></a>

Draws a filled circle. Use [render.push\_texture](#push_texture) to apply a texture to the shape.

### circle

```lua
render.circle(110, 110, 50, render.color("#FFFFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th><th align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default Value</a></td></tr><tr><td align="center">x</td><td align="center">number</td><td align="center">center x point</td><td align="center">❌</td></tr><tr><td align="center">y</td><td align="center">number</td><td align="center">center y point</td><td align="center">❌</td></tr><tr><td align="center">radius</td><td align="center">number</td><td align="center">the circles radius</td><td align="center">❌</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td><td align="center">❌</td></tr><tr><td align="center">thickness</td><td align="center">number</td><td align="center">thickness of the circle in pixels</td><td align="center">1</td></tr><tr><td align="center">segments</td><td align="center">number</td><td align="center">number of points<br>(circle resolution)</td><td align="center">12</td></tr><tr><td align="center">percentage</td><td align="center">number</td><td align="center">how much of the circle is drawn (0 - 1)</td><td align="center">1</td></tr><tr><td align="center">angle</td><td align="center">number</td><td align="center">circle rotation (0 - 360)</td><td align="center">0</td></tr></tbody></table>

### line

```lua
render.line(10, 10, 100, 100, render.color("#FFFFFF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">first x coord</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">first y coord</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">second x coord</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">second y coord</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

### line\_multicolor

```lua
render.line_multicolor(10, 10, 100, 100, 
render.color("#FFFFFF"), render.color("#000000"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">first x coord</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">first y coord</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">second x coord</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">second y coord</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">color2</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

### triangle\_filled

```lua
render.triangle_filled(20, 10, 5, 20, 30, 20, render.color("#FFFFFF")) 
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">first x coord</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">first y coord</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">second x coord</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">second y coord</td></tr><tr><td align="center">x3</td><td align="center">number</td><td align="center">third x coord</td></tr><tr><td align="center">y3</td><td align="center">number</td><td align="center">third y coord</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

#### Usage: <a href="#rec" id="rec"></a>

Draws a filled triangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape.

### triangle

```lua
render.triangle(20, 10, 5, 20, 30, 20, render.color("#FFFFFF")) 
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">first x coord</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">first y coord</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">second x coord</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">second y coord</td></tr><tr><td align="center">x3</td><td align="center">number</td><td align="center">third x coord</td></tr><tr><td align="center">y3</td><td align="center">number</td><td align="center">third y coord</td></tr><tr><td align="center">color</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

### triangle\_filled\_multicolor

```lua
render.triangle_filled_multicolor(20, 10, 5, 20, 30, 20, 
render.color("#FF0000"), render.color("#00FF00"), render.color("#0000FF"))
```

<table data-header-hidden><thead><tr><th width="173.4239185397946" align="center"> </th><th width="151.73360835425558" align="center"> </th><th width="211.87390915351415" align="center"> </th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td></tr><tr><td align="center">x1</td><td align="center">number</td><td align="center">first x coord</td></tr><tr><td align="center">y1</td><td align="center">number</td><td align="center">first y coord</td></tr><tr><td align="center">x2</td><td align="center">number</td><td align="center">second x coord</td></tr><tr><td align="center">y2</td><td align="center">number</td><td align="center">second y coord</td></tr><tr><td align="center">x3</td><td align="center">number</td><td align="center">third x coord</td></tr><tr><td align="center">y3</td><td align="center">number</td><td align="center">third y coord</td></tr><tr><td align="center">color1</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">color2</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr><tr><td align="center">color3</td><td align="center">table</td><td align="center">table of rgba values<br>see <a href="#color">render.color</a></td></tr></tbody></table>

## Animations

### create\_animator\_float

```lua
render.create_animator_float(0, 5, render.ease_in_out)
```

<table data-header-hidden><thead><tr><th width="198.25084643076468" align="center"> </th><th width="150" align="center"> </th><th width="200.68723808002605" align="center"> </th><th align="center"></th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default value</a></td></tr><tr><td align="center">initial_value</td><td align="center"><a href="#color">color</a></td><td align="center">starting value</td><td align="center">❌</td></tr><tr><td align="center">duration</td><td align="center">number</td><td align="center">how long to take in seconds</td><td align="center">❌</td></tr><tr><td align="center">easing_type</td><td align="center"><a href="#easings">render.easing</a></td><td align="center">the animation type</td><td align="center"><a href="#easings">render.linear</a></td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) |  [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :----------------------------------------------: |
|                animator object               | [animator](/documentation/datatypes/animator.md) |

### create\_animator\_color

```lua
render.create_animator_color(render.color("FFFFFF"), 5, render.ease_in_out, true)
```

<table data-header-hidden><thead><tr><th width="198.25084643076468" align="center"> </th><th width="150" align="center"> </th><th width="200.68723808002605" align="center"> </th><th align="center"></th></tr></thead><tbody><tr><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Parameter</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Datatype</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Description</a></td><td align="center"><a href="/pages/McV9CTPvTSQx89z8iuxi">Default value</a></td></tr><tr><td align="center">initial_value</td><td align="center"><a href="#color">color</a></td><td align="center">starting value</td><td align="center">❌</td></tr><tr><td align="center">duration</td><td align="center">number</td><td align="center">how long to take in seconds</td><td align="center">❌</td></tr><tr><td align="center">easing_type</td><td align="center"><a href="#easings">render.easing</a></td><td align="center">the animation type</td><td align="center"><a href="#easings">render.linear</a></td></tr><tr><td align="center">interpolate_hue</td><td align="center">boolean</td><td align="center">should the hue be animated</td><td align="center">false</td></tr></tbody></table>

#### Returns:

| [Value](/documentation/namespaces/render.md) |  [Datatype](/documentation/namespaces/render.md) |
| :------------------------------------------: | :----------------------------------------------: |
|                animator object               | [animator](/documentation/datatypes/animator.md) |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://golua.fatality.win/documentation/namespaces/render.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
