docs: fill in some missing docs

- fix comments around new BSPX lumps
This commit is contained in:
Eric Wasylishen 2023-08-13 21:55:10 -06:00
parent 1e3a5a0915
commit 54d5838f29
4 changed files with 33 additions and 4 deletions

View File

@ -351,7 +351,7 @@ Experimental options
.. option:: -lightgrid
Experimental LIGHTGRID bspx lump.
Generates a lightgrid and writes it to a bspx lump (LIGHTGRID_OCTREE).
.. option:: -lightgrid_dist x y z
@ -359,7 +359,7 @@ Experimental options
.. option:: -lightgrid_format octree
Lightgrid BSPX lump to use.
Lightgrid BSPX lump to use. Currently there is only one supported format, octree.
Model Entity Keys
=================
@ -686,6 +686,26 @@ func_detail/func_group as well, if qbsp from these tools is used.
its brushes from emitting bounced light they receive from elsewhere.)
Only has an effect if "_bounce" is enabled in worldspawn.
.. bmodel-key:: "_autominlight" "n"
"Autominlight" is a feature for automatically choosing a suitable
minlight color for a bmodel entity (e.g. a func_door), by averaging
incoming light at the center of the bmodel bounding box.
Default behaviour is to apply autominlight on occluded luxels only (e.g., for a
door that opens vertically upwards, it would apply to the bottom face of the
door, which is initially pressed against the ground).
A value of "-1" disables the feature (occluded luxels will be solid black),
and "1" enables it as a minlight color even on non-occluded luxels.
.. bmodel-key:: "_autominlight_target" "name"
For autominlight, instead of using the center of the model bounds as the sample point,
searches for an entity with its "targetname" key set to "name",
and use that entity's origin (typically you'd use an "info_null" for this).
Light Entity Keys
=================

View File

@ -32,6 +32,10 @@ Options
Whether to fill the map from the outside in (lenient), from the inside out
(aggressive), or to automatically decide based on the hull being used.
.. option:: -filldetail [n]
Whether to fill enclosed pockets of empty space surrounded by solid detail. Default is 1 (enabled).
.. option:: -nomerge
Don't perform face merging.
@ -351,6 +355,10 @@ Options
first, only falling back to the prior two steps if it fails.
.. option:: -noextendedsurfflags
Don't write .texinfo file, even if it would normally be needed (debug)
.. option:: -omitdetail
Detail brushes are omitted from the compile.

View File

@ -120,7 +120,7 @@ struct bspxfacenormals
void stream_read(std::istream &s, const mbsp_t &bsp);
};
// DECOUPLED_LM BSPX lump (subject to change!)
// DECOUPLED_LM BSPX lump
struct bspx_decoupled_lm_perface
{
uint16_t lmwidth; // pixels

View File

@ -341,7 +341,8 @@ light_settings::light_settings()
exportobj{this, "exportobj", false, &output_group, "export an .OBJ for inspection"},
lmshift{this, "lmshift", 4, &output_group,
"force a specified lmshift to be applied to the entire map; this is useful if you want to re-light a map with higher quality BSPX lighting without the sources. Will add the LMSHIFT lump to the BSP."},
lightgrid{this, "lightgrid", false, &experimental_group, "experimental LIGHTGRID bspx lump"},
lightgrid{this, "lightgrid", false, &experimental_group,
"generates a lightgrid and writes it to a bspx lump (LIGHTGRID_OCTREE)"},
lightgrid_dist{this, "lightgrid_dist", 32.f, 32.f, 32.f, &experimental_group,
"distance between lightgrid sample points, in world units. controls lightgrid size."},
lightgrid_format{this, "lightgrid_format", lightgrid_format_t::OCTREE, {{"octree", lightgrid_format_t::OCTREE}},