LUA World Machine Plugin API

[Stephen]

Originally published at: LUA World Machine Plugin API – World Machine Help

This feature was introduced in the “Hurricane Ridge” release This article contains the currently supported API for interacting with World Machine from your Lua scripts within the Code device. As the bindings are continually developed, this reference material will be updated to stay current. Overview All World Machine functionality is exposed in the ‘wm’ library.…

[davidroberson]

I’m thrilled to see this. I got into Lua scripting as a Filter Forge creator and often wondered if I’d ever be able to make use of it for anything else.

@Stephen

LUA World Machine Plugin API

This feature was introduced in the “Hurricane Ridge” release

This article contains the currently supported API for interacting with World Machine from your Lua scripts within the Code device.

[Tomatiy]

I need to commission some custom devices or learn lua by myself
Will be good if you will learn custom devices creation for WM

[davidroberson]

I will have to do some research into setting up my computer to host the Lua Kernal(s) before I can even begin. I’ll probably spend a year learning before I will really understand how build actual devices.

@Stephen

Compute Kernels

To perform operations on the GPU, use the runKernel function in the wm library.

wm.runKernel(kernelname/kernelobject, arg1, arg2, ...)

The first parameter must be a string containing the name of the compute kernel, while the following arguments should be buffers, images, or values. The types must match the type defined in your kernel function.

Currently, there is no way to define the local workgroup size of a kernel.

[Fontenelle89]

As someone who learned Lua recently and enjoying my time using it, I can’t wait to see what can be done in Lua and WM!