diff options
| -rw-r--r-- | doc/lua/openstarbound/renderer.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/lua/openstarbound/renderer.md b/doc/lua/openstarbound/renderer.md new file mode 100644 index 0000000..5678085 --- /dev/null +++ b/doc/lua/openstarbound/renderer.md @@ -0,0 +1,37 @@ + +# Renderer + +The new renderer table is accessible from almost every clientside script and allows configuring shaders. + +--- + +#### `void` renderer.setPostProcessGroupEnabled(String group, bool enabled, [bool save]) + +Enables or disables a post process shader group. If save is true, this change is saved to configuration as well. + +--- + +#### `bool` renderer.postProcessGroupEnabled(String group) + +Returns true if the specified post process group is enabled. + +--- + +#### `Json` renderer.postProcessGroups() + +Returns every post process group. Identical to grabbing them from client.config with root.assetJson. + +--- + +#### `Json` renderer.setEffectParameter(String effectName, String parameterName, RenderEffectParameter value) + +Sets the specified scriptable parameter of the specified shader effect to the provided value. +This is accessed from the shader as a uniform and must be defined in the effect's configuration. + +--- + +#### `RenderEffectParameter` renderer.getEffectParameter(String effectName, String parameterName) + +Returns the specified scriptable parameter of the specified shader effect. + +--- |