Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Types

Global

Constants

ImageFormat

{
    PNG: integer = -1,
    JPEG: integer = -1,
    GIF: integer = -1,
    WEBP: integer = -1,
    PNM: integer = -1,
    TIFF: integer = -1,
    TGA: integer = -1,
    DDS: integer = -1,
    BMP: integer = -1,
    ICO: integer = -1,
    HDR: integer = -1,
    OPEN_EXR: integer = -1,
    FARBFELD: integer = -1,
    AVIF: integer = -1,
    QOI: integer = -1,
    PCX: integer = -1,
    UNSUPPORTED: integer = -1,
}

ImageFilterType

{
    NEAREST: integer = -1,
    TRIANGLE: integer = -1,
    CATMULL_ROM: integer = -1,
    GAUSSIAN: integer = -1,
    LANCZOS_3: integer = -1,
}

TextureFormat

{
    UNDEFINED: integer = -1,
    R8G8B8A8_SINT: integer = -1,
    R8G8B8A8_UINT: integer = -1,
    R8G8B8A8_UNORM: integer = -1,
    R8G8B8A8_SNORM: integer = -1,
    A8B8G8R8_UNORM_PACK32: integer = -1,
    A8B8G8R8_SNORM_PACK32: integer = -1,
    A8B8G8R8_SINT_PACK32: integer = -1,
    A8B8G8R8_UINT_PACK32: integer = -1,
    R16G16B16A16_SFLOAT: integer = -1,
    R16G16B16A16_SINT: integer = -1,
    R16G16B16A16_UINT: integer = -1,
    R32_SFLOAT: integer = -1,
    R32_SINT: integer = -1,
    R32_UINT: integer = -1,
    R32G32_SFLOAT: integer = -1,
    R32G32_SINT: integer = -1,
    R32G32_UINT: integer = -1,
    R32G32B32A32_SFLOAT: integer = -1,
    R32G32B32A32_SINT: integer = -1,
    R32G32B32A32_UINT: integer = -1,
    R8G8B8A8_SRGB: integer = -1,
}

TextureFilter

{
    POINT: integer = -1,
    NEAREST: integer = -1,
}

TextureWrap

{
    REPEAT: integer = -1,
    CLAMP: integer = -1,
    MIRROR_REPEAT: integer = -1,
    MIRROR_CLAMP: integer = -1,
}

KeyboardKey

{
    NULL: integer = -1,
    APOSTROPHE: integer = -1,
    COMMA: integer = -1,
    MINUS: integer = -1,
    PERIOD: integer = -1,
    SLASH: integer = -1,
    ZERO: integer = -1,
    ONE: integer = -1,
    TWO: integer = -1,
    THREE: integer = -1,
    FOUR: integer = -1,
    FIVE: integer = -1,
    SIX: integer = -1,
    SEVEN: integer = -1,
    EIGHT: integer = -1,
    NINE: integer = -1,
    SEMICOLON: integer = -1,
    EQUAL: integer = -1,
    A: integer = -1,
    B: integer = -1,
    C: integer = -1,
    D: integer = -1,
    E: integer = -1,
    F: integer = -1,
    G: integer = -1,
    H: integer = -1,
    I: integer = -1,
    J: integer = -1,
    K: integer = -1,
    L: integer = -1,
    M: integer = -1,
    N: integer = -1,
    O: integer = -1,
    P: integer = -1,
    Q: integer = -1,
    R: integer = -1,
    S: integer = -1,
    T: integer = -1,
    U: integer = -1,
    V: integer = -1,
    W: integer = -1,
    X: integer = -1,
    Y: integer = -1,
    Z: integer = -1,
    LEFT_BRACKET: integer = -1,
    BACKSLASH: integer = -1,
    RIGHT_BRACKET: integer = -1,
    GRAVE: integer = -1,
    SPACE: integer = -1,
    ESCAPE: integer = -1,
    ENTER: integer = -1,
    TAB: integer = -1,
    BACKSPACE: integer = -1,
    INSERT: integer = -1,
    DELETE: integer = -1,
    RIGHT: integer = -1,
    LEFT: integer = -1,
    DOWN: integer = -1,
    UP: integer = -1,
    PAGE_UP: integer = -1,
    PAGE_DOWN: integer = -1,
    HOME: integer = -1,
    END: integer = -1,
    CAPS_LOCK: integer = -1,
    SCROLL_LOCK: integer = -1,
    NUM_LOCK: integer = -1,
    PRINT_SCREEN: integer = -1,
    PAUSE: integer = -1,
    F1: integer = -1,
    F2: integer = -1,
    F3: integer = -1,
    F4: integer = -1,
    F5: integer = -1,
    F6: integer = -1,
    F7: integer = -1,
    F8: integer = -1,
    F9: integer = -1,
    F10: integer = -1,
    F11: integer = -1,
    F12: integer = -1,
    LEFT_SHIFT: integer = -1,
    LEFT_CONTROL: integer = -1,
    LEFT_ALT: integer = -1,
    LEFT_SUPER: integer = -1,
    RIGHT_SHIFT: integer = -1,
    RIGHT_CONTROL: integer = -1,
    RIGHT_ALT: integer = -1,
    RIGHT_SUPER: integer = -1,
    KB_MENU: integer = -1,
    KP_0: integer = -1,
    KP_1: integer = -1,
    KP_2: integer = -1,
    KP_3: integer = -1,
    KP_4: integer = -1,
    KP_5: integer = -1,
    KP_6: integer = -1,
    KP_7: integer = -1,
    KP_8: integer = -1,
    KP_9: integer = -1,
    KP_DECIMAL: integer = -1,
    KP_DIVIDE: integer = -1,
    KP_MULTIPLY: integer = -1,
    KP_SUBTRACT: integer = -1,
    KP_ADD: integer = -1,
    KP_ENTER: integer = -1,
    KP_EQUAL: integer = -1,
}

MouseButton

{
    LEFT: integer = -1,
    RIGHT: integer = -1,
    MIDDLE: integer = -1,
    SIDE: integer = -1,
    EXTRA: integer = -1,
    FORWARD: integer = -1,
    BACK: integer = -1,
}

MouseCursor

{
    DEFAULT: integer = -1,
    ARROW: integer = -1,
    IBEAM: integer = -1,
    CROSSHAIR: integer = -1,
    POINTING_HAND: integer = -1,
    RESIZE_EW: integer = -1,
    RESIZE_NS: integer = -1,
    RESIZE_NWSE: integer = -1,
    RESIZE_NESW: integer = -1,
    RESIZE_ALL: integer = -1,
    NOT_ALLOWED: integer = -1,
}

Color

R8G8B8A8 (32-bit RGBA) Color


Properties

r : number

g : number

b : number

a : number


Functions

from_rgb(r : number, g : number, b : number, a : number)

->Color

lightgray()

->Color

gray()

->Color

darkgray()

->Color

yellow()

->Color

gold()

->Color

orange()

->Color

pink()

->Color

red()

->Color

maroon()

->Color

green()

->Color

lime()

->Color

darkgreen()

->Color

skyblue()

->Color

blue()

->Color

darkblue()

->Color

purple()

->Color

beige()

->Color

brown()

->Color

darkbrown()

->Color

white()

->Color

black()

->Color

transparent()

->Color

magenta()

->Color

Font

Image

Rectangle


Properties

x : number

y : number

width : number

height : number


Functions

new(x : number, y : number, width : number, height : number)

->Rectangle

Texture


Functions

width(self)

->number

height(self)

->number

set_filter(self, filter : TextureFilter)

set_wrap(self, wrap : TextureWrap)

bounding_box(self)

->Rectangle

set_shader(self, renderer : Renderer, shader : string)

Set a texture’s shader to one of any preset shaders.

TextureOptions

Options used for drawing a texture


Properties

texture : Texture

source : Rectangle

dest : Rectangle

flippedX : boolean

flippedY : boolean

origin : Vec2

Two component Vector

rotation : number

tint : Color

R8G8B8A8 (32-bit RGBA) Color

Vec2

Two component Vector


Properties

x : number

y : number


Functions

new(x : number, y : number)

->Vec2

Vec3

Three component Vector


Properties

x : number

y : number

z : number


Functions

new(x : number, y : number, z : number)

->Vec3

Vec4

Four component Vector


Properties

x : number

y : number

z : number

w : number


Functions

new(x : number, y : number, z : number, w : number)

->Vec4