Docs
Examples
Sandbox
Blog
Roadmap
Community

API Guides

Offline documentation HTML 178 KB MD 499 KB

animation

get_duration get_name

animator

Lifecycle

create destroy get_model

Playback

get_animation get_loop get_playing get_speed get_time pause play seek set_loop set_speed stop

Blending

get_order get_weight set_mask set_order set_weight

audio

System

init set_hrtf set_master_volume shutdown

Listener

listener_create listener_destroy listener_set_active

Source

source_create source_destroy source_get_clip source_get_playing source_pause source_play source_seek source_set_attenuation source_set_clip source_set_loop source_set_pitch source_set_spatial source_set_volume source_stop

backend

get_available get_current get_name init loop shutdown stop

camera

bind create destroy set_clip set_fov unbind

clip

destroy get_channels get_duration load reload

color

from_hex from_rgba

entity

get_parent get_position get_rotation get_scale look_at move rotate set_parent set_position set_rotation set_scale

font

Metrics

get_ascent get_descent get_line_height get_size

Measuring

measure_text measure_wrapped offset_at

Spacing

get_letter_spacing get_line_spacing set_letter_spacing set_line_spacing

Glyphs

get_fallback get_glyph has_glyph preload preload_range set_fallback

Atlas

get_atlas set_filter

Lifecycle

create destroy

input

Keyboard

get_char_at get_char_count get_key_down get_key_pressed get_key_released

Mouse

get_cursor get_mouse_button_down get_mouse_button_pressed get_mouse_button_released get_mouse_captured get_mouse_x get_mouse_x_speed get_mouse_y get_mouse_y_speed get_wheel_x get_wheel_y set_cursor set_mouse_capture

Touch

get_touch_at get_touch_count get_touch_down get_touch_pressed get_touch_released get_touch_x get_touch_x_speed get_touch_y get_touch_y_speed

material

Lifecycle

create destroy

Binding

bind unbind

Shader Inputs

set_constant set_matrix set_texture set_vertex_constant

State

get_instanced set_instanced set_state

Tags

add_tag get_tag get_tag_count remove_tag

mesh

Primitives

capsule cube plane sphere

Resources

destroy find_animation get_animation get_animation_count get_bone_count get_bone_name get_part_count get_part_texture get_skinned load reload set_dynamic

model

Lifecycle

create destroy

Resources

get_mesh set_material set_mesh set_part_material set_part_texture

Appearance

get_visible set_color set_visible

Bones

get_bone get_bone_at get_bone_count get_bone_weight set_bone_weight

particles

Lifecycle

clear create destroy emit get_alive get_count pause play simulate stop

Emission

set_rate set_seed set_shape set_space set_spread

Birth

set_color set_lifetime set_rotation set_size set_speed set_spin

Forces

set_damping set_gravity set_radial

Over Life

set_colors set_sizes

Appearance

set_align set_blend set_frames set_material set_mesh set_sort set_stretch set_texture

physics

World

init raycast set_gravity shutdown

Bodies

capsule cube cylinder destroy mesh plane set_fixed_rotation set_interpolation set_material set_rotation_locks set_type sphere

Motion

apply_impulse get_velocity set_velocity

pivot

create destroy

render

Draw

circle circle_outline cover line particles poly poly_outline rectangle rectangle_outline rounded_rectangle rounded_rectangle_outline surface tag text text_box text_ex texture triangle triangle_outline view view_children

State

clear scissor_begin scissor_end set_color viewport_begin viewport_end

resource

Sources

mount pack unmount

Lifecycle

destroy from_data load load_async shutdown

Contents

get_data get_size save

script

Script values

Lifecycle

create destroy get_error run

Modules

open_all open_animation open_animator open_audio open_backend open_camera open_clip open_color open_entity open_font open_input open_material open_mesh open_model open_physics open_pivot open_render open_resource open_script open_shader open_std open_std_safe open_surface open_texture open_window

Binding

call call_value fail get hold release set

Tables

table_get table_get_item table_get_length table_set table_set_item

Values

make_bool make_bytes make_function make_handle make_nil make_number make_string make_table to_bool to_handle to_number to_string

shader

destroy load reload

surface

bind create destroy get_depth get_height get_texture get_width resize unbind

texture

create destroy get_height get_width update

view

Lifecycle

create destroy get_parent set_parent

Arrangement

get_layout set_columns set_gap set_layout set_padding set_rows

Placement

get_clip get_visible set_clip set_expand set_margin set_max_size set_min_size set_offset set_visible

Pointer

get_hovered get_pickable get_pointer get_pressed set_pickable

Hooks

set_hook

Result

get_changed get_rect

Focus

get_focus get_focus_within get_focusable get_focused set_focus set_focusable

window

Lifecycle

create destroy get_alive

Rendering

bind get_render_calls unbind

Size

get_height get_scale get_width set_scale_mode

State

get_orientation get_state set_orientation set_state

Native Lua

natiny.clip.destroy

Lua

natiny.clip.destroy(clip)

Frees a clip's decoded audio.

Parameters

Name	Type	Description
`clip`	`number`	Clip handle

Example

Lua

natiny.clip.destroy(clip)

Built by the Natiny team · Docs · Examples · Sandbox · Blog · Roadmap · Community · Download · Discord

© 2026 Natiny Engine. Compact core, modern GPU pipeline.

Natiny stores cookies and local browser data to run the site - your theme, your session and the state of the sandbox - and to count visits. These are technically required: the site does not work without them.

Without this storage the site cannot run, so there is nothing to show you - please close the tab and leave the site.