> 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 render namespace ## Enums
Font flags font\_flag\_shadow font\_flag\_outline
Rect rounding top\_left top\_right bottom\_left bottom\_right top left bottom right all
Rect outline outline\_inset outline\_outset outline\_center
Text alignment align\_top align\_left align\_center align\_right align\_bottom
Easings * linear * ease\_in * ease\_out * ease\_in\_out * elastic\_in * elastic\_out * elastic\_in\_out * bounce\_in * bounce\_out * bounce\_in\_out
## Datatypes ### color ```lua render.color(255, 255, 255) render.color(255, 255, 255, 100) render.color("#FFFFFF") ```
ParameterDatatypeDescriptionDefault Value
rnumberred channel (0-255)❌
gnumbergreen channel (0-255)❌
bnumberblue channel (0-255)❌
anumberalpha channel (0-255)255
ParameterDatatypeDescription
hex_codestringhex color code
#### 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")) ```
ParameterDatatypeDescription
textstringflag to draw
colorrender.colorcolor to draw
## Fonts ### create\_font ```lua render.create_font("smallest_pixel-7.ttf", 11, render.font_flag_outline) ```
ParameterDatatypeDescriptionDefault Value
font_pathstringpath to font or name of font❌
sizenumberfont size❌
flagsrender.font_flagfont flag0
fromnumberminimum codepoint0
tonumbermaximum codepoint255
#### 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) ```
ParameterDatatypeDescriptionDefault Value
font_pathstringpath to font or name of font❌
sizenumberfont size❌
flagsrender.font_flagfont flag0
fromnumberminimum codepoint0
tonumbermaximum codepoint255
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :---------------------------------------------: | | font id | number | ### create\_font\_stream ```lua render.create_font_stream({0x1, ...}, 12) ```
ParameterDatatypeDescriptionDefault Value
bytestabletable of bytes❌
sizenumberfont size❌
flagsrender.font_flagfont flag0
fromnumberminimum codepoint0
tonumbermaximum codepoint255
#### 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") ```
ParameterDatatypeDescriptionDefault Value
fontnumberfont id from render.create_font❌
textstringstring to measure❌
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :---------------------------------------------: | | width | number | | height | number | ### wrap\_text ```lua render.wrap_text(font, 'This is a really long string!', 250) ```
ParameterDatatypeDescriptionDefault Value
fontnumberfont id from render.create_font❌
textstringstring to measure❌
widthnumbertarget text width
#### 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) ```
ParameterDatatypeDescriptionDefault Value
fontnumber

font id

(see render.create_font)

❌
xnumberfirst x coord❌
ynumberfirst y coord❌
textstringtext to draw❌
colortabletable of rgba values
see render.color		❌
align_horizontalnumberhorizontal alignment typerender.align_left
align_verticalnumbervertical alignment typerender.align_top
align_linenumbermultiline alignment typerender.align_left
#### Pre-defined fonts: * font\_gui\_main * font\_gui\_title * font\_gui\_bold * font\_esp * font\_esp\_name * font\_indicator 
-- Ex: render.font_gui_main, render.font_esp
## Shaders ### create\_shader ```lua local shader = render.create_shader([[ sampler s0; float4 main(float2 uv: TEXCOORD0): COLOR0 { return tex2D(s0, uv); } ]]); ```
ParameterDatatypeDescription
srcstringshader source code
#### Supported pre-defined shader parameters:
RegisterTypeDescription
s0samplercurrent texture
c0float2current texture's dimensions
c1floatcurrent time in seconds
c2floatcurrent global alpha override
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :---------------------------------------------: | | shader id | number | ### set\_shader ```lua render.set_shader(shader); ```
ParameterDatatypeDescription
shader_idnumber / nilshader id returned from
render.create_shader
#### Usage: Sets or resets a shader. ## Textures ### create\_texture ```lua render.create_texture("fatality/image.jpg") ```
ParameterDatatypeDescription
texture_pathstringpath to texture
#### 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) ```
ParameterDatatypeDescription
bytesunsigned char*array of bytes
sizenumbertexture size
#### 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) ```
ParameterDatatypeDescription
bytesunsigned char*array of bytes
wnumbertexture width
hnumbertexture height
row_stridenumbernumber of bytes in each row
(image width * 4)
#### 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}) ```
ParameterDatatypeDescription
byte_streamtable of bytestexture bytes
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :---------------------------------------------: | | texture id | number | ### create\_texture\_svg ```lua local svg_data = [[ ]] render.create_texture_svg(svg_data, 20) -- or render.create_texture_svg("fatality/image.svg", 20) ```
ParameterDatatypeDescription
imagestringsvg data or svg file path
target_heightnumberdesired image height
#### 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) ```
ParameterDatatypeDescription
texture_idnumbertexture id returned from
render.create_texture
#### 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 
-- Ex: render.texture_logo_head, render.texture_avatar
#### 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) ```
ParameterDatatypeDescription
x1numbermin x coord (0 - 1)
y1numbermin y coord (0 - 1)
x2numbermax x coord (0 - 1)
y2numbermax y coord (0 - 1)
#### 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 
render.get_texture_size(texture_id)
ParameterDatatypeDescription
texture_idnumbertexture id from create_texture
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :---------------------------------------------: | | width | number | | height | number | ### get\_frame\_count ```lua local framecount = render.get_frame_count(my_gif) ```
ParameterDatatypeDescription
texture_idnumbertexture id from create_texture
#### 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 
local w, h = render.get_screen_size()
#### 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) ```
ParameterDatatypeDescriptionDefault Value
x1numbermin x point❌
y1numbermin y point❌
x2numbermax x point❌
x2numbermax y point❌
intersectbooleanshould it intersect with existing clip rectsfalse
#### 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")) ```
ParameterDatatypeDescription
x1numbermin x point
y1numbermin y point
x2numbermax x point
y2numbermax y point
colortabletable of rgba values
see render.color
#### Usage: Draws a filled rectangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape. ### rect ```lua render.rect(10, 10, 110, 110, render.color("#00FFFF")) ```
ParameterDatatypeDescriptionDefault Value
x1numbermin x point❌
y1numbermin y point❌
x2numbermax x point❌
y2numbermax y point❌
colortabletable of rgba values
see render.color		❌
thicknessfloatthickness of line1.f
outlinenumberoutline typerender.outline_inset
### rect\_rounded ```lua render.rect_rounded(10, 10, 110, 110, render.color("#00FFFF"), 1.5, render.top) ```
ParameterDatatypeDescriptionDefault Value
x1numbermin x point❌
y1numbermin y point❌
x2numbermax x point❌
y2numbermax y point❌
colortabletable of rgba values
see render.color		❌
roundingnumberamount of rounding❌
rounding_flagsnumbercorners to roundrender.all
thicknessfloatthickness of line1.f
outlinenumberoutline typerender.outline_inset
#### Usage: Draws a filled rounded rectangle. Use [render.push\_texture](#push_texture) to apply a texture to the shape. ### rect\_filled\_rounded ```lua render.rect_filled_rounded(10, 10, 110, 110, render.color("#00FFFF"), 1.5, render.top) ```
ParameterDatatypeDescriptionDefault Value
x1numbermin x point❌
y1numbermin y point❌
x2numbermax x point❌
y2numbermax y point❌
colortabletable of rgba values
see render.color		❌
roundingnumberamount of rounding❌
rounding_flagsnumbercorners to roundrender.all
#### Usage: 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")) ```
ParameterDatatypeDescription
x1numbermin x point
y1numbermin y point
x2numbermax x point
y2numbermax y point
top_lefttabletable of rgba values
see render.color
top_righttabletable of rgba values
see render.color
bottom_righttabletable of rgba values
see render.color
bottom_lefttabletable of rgba values
see render.color
#### Usage: Draws a multi-color rectangle. ### circle\_filled ```lua render.circle_filled(110, 110, 50, render.color("#FFFFFF")) ```
ParameterDatatypeDescriptionDefault Value
xnumbercenter x point❌
ynumbercenter y point❌
radiusnumberthe circles radius❌
colortabletable of rgba values
see render.color		❌
segmentsnumbernumber of points
(circle resolution)		12
percentagenumberhow much of the circle is drawn (0 - 1)1
anglenumbercircle rotation (0 - 360Draws a filled multi-color rectangle.)0
#### Usage: 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")) ```
ParameterDatatypeDescriptionDefault Value
xnumbercenter x point❌
ynumbercenter y point❌
radiusnumberthe circles radius❌
colortabletable of rgba values
see render.color		❌
thicknessnumberthickness of the circle in pixels1
segmentsnumbernumber of points
(circle resolution)		12
percentagenumberhow much of the circle is drawn (0 - 1)1
anglenumbercircle rotation (0 - 360)0
### line ```lua render.line(10, 10, 100, 100, render.color("#FFFFFF")) ```
ParameterDatatypeDescription
x1numberfirst x coord
y1numberfirst y coord
x2numbersecond x coord
y2numbersecond y coord
colortabletable of rgba values
see render.color
### line\_multicolor ```lua render.line_multicolor(10, 10, 100, 100, render.color("#FFFFFF"), render.color("#000000")) ```
ParameterDatatypeDescription
x1numberfirst x coord
y1numberfirst y coord
x2numbersecond x coord
y2numbersecond y coord
colortabletable of rgba values
see render.color
color2tabletable of rgba values
see render.color
### triangle\_filled ```lua render.triangle_filled(20, 10, 5, 20, 30, 20, render.color("#FFFFFF")) ```
ParameterDatatypeDescription
x1numberfirst x coord
y1numberfirst y coord
x2numbersecond x coord
y2numbersecond y coord
x3numberthird x coord
y3numberthird y coord
colortabletable of rgba values
see render.color
#### Usage: 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")) ```
ParameterDatatypeDescription
x1numberfirst x coord
y1numberfirst y coord
x2numbersecond x coord
y2numbersecond y coord
x3numberthird x coord
y3numberthird y coord
colortabletable of rgba values
see render.color
### triangle\_filled\_multicolor ```lua render.triangle_filled_multicolor(20, 10, 5, 20, 30, 20, render.color("#FF0000"), render.color("#00FF00"), render.color("#0000FF")) ```
ParameterDatatypeDescription
x1numberfirst x coord
y1numberfirst y coord
x2numbersecond x coord
y2numbersecond y coord
x3numberthird x coord
y3numberthird y coord
color1tabletable of rgba values
see render.color
color2tabletable of rgba values
see render.color
color3tabletable of rgba values
see render.color
## Animations ### create\_animator\_float ```lua render.create_animator_float(0, 5, render.ease_in_out) ```
ParameterDatatypeDescriptionDefault value
initial_valuecolorstarting value❌
durationnumberhow long to take in seconds❌
easing_typerender.easingthe animation typerender.linear
#### 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) ```
ParameterDatatypeDescriptionDefault value
initial_valuecolorstarting value❌
durationnumberhow long to take in seconds❌
easing_typerender.easingthe animation typerender.linear
interpolate_huebooleanshould the hue be animatedfalse
#### Returns: | [Value](/documentation/namespaces/render.md) | [Datatype](/documentation/namespaces/render.md) | | :------------------------------------------: | :----------------------------------------------: | | animator object | [animator](/documentation/datatypes/animator.md) |