nuclide/Documentation/Materials/SurfaceCommands/bemode.md

77 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2024-06-22 07:24:13 +00:00
# Material Command List {#mat_commands}
## bemode {#bemode}
2024-06-22 07:24:13 +00:00
### Syntax
2024-06-22 07:24:13 +00:00
**bemode \<mode\>**
2024-06-22 07:24:13 +00:00
### Overview
2024-06-22 07:24:13 +00:00
Filters which back end rendering features are drawn on top of the material.
While you're not encouraged to be overriding this value, it is sometimes necessary.
### Modes {#bemode_sides}
2024-06-22 07:24:13 +00:00
These are the different modes that we can specify.
#### rtlight {#bemode_rtlight}
2024-06-22 07:24:13 +00:00
All light types will be drawn onto this surface.
#### rtlight_only {#bemode_rtlight_only}
2024-06-22 07:24:13 +00:00
Dynamic lights only.
#### rtlight_smap {#bemode_rtlight_smap}
2024-06-22 07:24:13 +00:00
Shadowmaps only.
#### rtlight_spot {#bemode_rtlight_spot}
2024-06-22 07:24:13 +00:00
Spotlights only.
#### rtlight_cube {#bemode_rtlight_cube}
2024-06-22 07:24:13 +00:00
Cubemap lights only.
#### rtlight_cube_smap {#bemode_rtlight_cube_smap}
2024-06-22 07:24:13 +00:00
Cubemap lights and shadowmaps only.
#### rtlight_cube_spot {#bemode_rtlight_cube_spot}
2024-06-22 07:24:13 +00:00
Cubemap lights and spotlights only.
#### rtlight_spot_smap {#bemode_rtlight_spot_smap}
2024-06-22 07:24:13 +00:00
Spot lights and shadowmaps only.
#### rtlight_cube_spot_smap {#bemode_rtlight_cube_spot_smap}
2024-06-22 07:24:13 +00:00
Cubemap lights, spot lights and shadowmaps only.
#### crepuscular {#bemode_crepuscular}
2024-06-22 07:24:13 +00:00
For skies that might cast rays.
Those are rendered to a frame buffer object (with everything else being [depthdark](@ref bemode_depthdark)) and is then applied to the screen as a post-processing effect.
2024-06-22 07:24:13 +00:00
#### depthonly {#bemode_depthonly}
2024-06-22 07:24:13 +00:00
Used mainly by shadow maps.
#### depthdark {#bemode_depthdark}
2024-06-22 07:24:13 +00:00
Black depth passes only.
Used to draw a black world, when `r_shadow_realtime_world_lightmaps` is `0` for example.
#### gbuffer {#bemode_gbuffer}
#### prelight {#bemode_prelight}
2024-06-22 07:24:13 +00:00
Deferred lighting only.
#### fog {#bemode_fog}
2024-06-22 07:24:13 +00:00
Fog layer only.