gfx
Post-process, weather, screen flash and custom GLSL passes; unload or gfx.reset restores changes.
Functions
gfx.set
gfx.set(name, value)| Name | Type | Description |
|---|---|---|
| name | string | Name from the list below. |
| value | boolean | number | Booleans become 1/0; integers truncate. |
Sets a post-process or weather parameter.
- Unknown names raise an error; values are not clamped.
- Grade params need "grade" on; bloom_*, dof, motionblur, godrays need their toggle.
gfx.get
gfx.get(name) -> boolean | number| Name | Type | Description |
|---|---|---|
| name | string | Name from the list below. |
Current value, set by menu or script.
Returns Boolean for on/off, else number
Unknown names raise an error.
gfx.reset
gfx.reset()Restores this script's parameters and removes its shaders.
gfx.flash
gfx.flash([r=255, g=255, b=255 [, strength=0.6]])| Name | Type | Description |
|---|---|---|
| roptional | number | 0 to 255. Default 255. |
| goptional | number | 0 to 255. Default 255. |
| boptional | number | 0 to 255. Default 255. |
| strengthoptional | number | Roughly 0 to 1. Default 0.6. |
Fires the edgebug flash: vignette, shockwave ring, chromatic pulse.
OpenGL post-process pipeline only.
gfx.shader
gfx.shader(source | nil)| Name | Type | Description |
|---|---|---|
| source | string | nil | GLSL 1.20 fragment shader; nil removes. |
Sets the final post-process pass shader; last caller across scripts wins.
- Declare u_tex, u_resolution, u_time yourself; sample u_tex at gl_TexCoord[0].xy.
- Compile errors raise nothing and keep the last working shader.
gfx.uniform
gfx.uniform(name, a [, b [, c]])| Name | Type | Description |
|---|---|---|
| name | string | Uniform declared in gfx.shader. |
| a | number | |
| boptional | number | Makes a vec2. |
| coptional | number | Makes a vec3. |
Sets a gfx.shader uniform; values persist every frame.
- Raises an error with no numbers.
- Undeclared names are ignored.
gfx.world_shader
gfx.world_shader(source | nil)| Name | Type | Description |
|---|---|---|
| source | string | nil | GLSL 1.20 source; nil removes it. |
Adds your xs_world function as the last per-pixel world shading step.
- Signature: vec3 xs_world(vec3 col, vec3 albedo, vec3 light, vec3 wpos, vec3 normal, vec2 uv).
- Needs the replacement world renderer; compile errors raise nothing.
gfx.world_uniform
gfx.world_uniform(name, a [, b [, c]])| Name | Type | Description |
|---|---|---|
| name | string | Uniform declared in world_shader. |
| a | number | |
| boptional | number | Makes a vec2. |
| coptional | number | Makes a vec3. |
Sets a gfx.world_shader uniform.
Raises an error with no numbers.
Constants
| Name | Value | Description |
|---|---|---|
| bloom | on/off | Bloom glow. |
| bloom_intensity | number | Glow strength, menu 0 to 3. |
| bloom_threshold | number | Glow cutoff, lower glows more, 0 to 1. |
| dof | on/off | Depth of field. |
| dof_strength | number | Max blur, menu 0 to 1. |
| motionblur | on/off | |
| motionblur_amount | number | Smear length, menu 0 to 1. |
| ssao | on/off | Screen-space ambient occlusion. |
| ssr | on/off | Screen-space reflections. |
| godrays | on/off | Sun shafts. |
| godrays_intensity | number | Menu 0 to 2. |
| fxaa | on/off | Anti-aliasing. |
| fog | on/off | Post-process fog. |
| outline | on/off | Edge outline pass. |
| grade | on/off | Master switch for grade parameters. |
| tonemap | on/off | Tone mapping (grade). |
| exposure | number | Grade, menu 0 to 2. |
| contrast | number | Grade, menu 0.5 to 1.5. |
| saturation | number | Grade, menu 0 to 2. |
| temperature | number | Grade, -1 cool to 1 warm. |
| vignette | number | Grade, menu 0 to 1. |
| chromatic | number | Chromatic aberration, grade, 0 to 1. |
| grain | number | Film grain, grade, 0 to 1. |
| sharpen | number | Grade, menu 0 to 1. |
| weather_radius | integer | Weather particle spawn radius around player. |
| wind | number | Weather wind speed. |
| fallspeed | number | Weather particle fall speed. |
| rain | on/off | |
| rain_density | number | |
| rain_style | integer | 0 classic, 1 enhanced streaks. |
| rain_sound | on/off | Rain ambient sound. |
| rain_volume | number | Rain sound volume. |
| rain_thunder | on/off | Thunder in the rain ambience. |
| snow | on/off | |
| snow_density | number | |
| snow_flake_size | integer | |
| snow_flake_life | number | Seconds before a flake fades. |
| snow_sound | on/off | Snow ambient sound. |
| snow_volume | number | Snow sound volume. |
| ground_fog | on/off | |
| ground_fog_density | integer | |
| ground_fog_size | number | Fog puff size. |
| world_fog | on/off | Global world fog. |
| world_fog_mode | integer | 0 exp, 1 exp2, 2 linear. |
| world_fog_start | number | Linear fog start distance, units. |
| world_fog_end | number | Linear fog end distance, units. |
| world_fog_density | number | Density for exp and exp2 modes. |