fluffos/docs/efun/general/scale.md
gesslar 6e6d1c772b
docs: flesh out 31 TBW efun reference pages (#1248)
* empty

* docs: flesh out 31 TBW efun reference pages

Replace the placeholder "TBW" DESCRIPTION and type-only SYNOPSIS in 31
efun docs with real descriptions and named parameters, verified against
the driver source:

- math (general/): log10, log2, norm, dotprod, distance, angle
- matrix (general/): id_matrix, translate, scale, rotate_x/y/z,
  lookat_rotate, lookat_rotate2 -- note the in-place mutation of the
  passed matrix and that rotations are in degrees
- compress (general/): compress, uncompress, compress_file,
  uncompress_file -- note the file variants delete the source on success
- interactive/: send_zmp, act_mxp, request_term_type,
  start_request_term_type, request_term_size
- internals/: dump_trace, destructed_objects, check_memory (flag
  bitmask + DEBUGMALLOC build requirement), dump_stralloc, dump_jemalloc
- core: next_bit, explode_reversible, shallow_inherit_list

Each page keeps the existing manpage-style layout (4-space-indented
NAME/SYNOPSIS/DESCRIPTION, name(3) SEE ALSO). Example blocks are indented
to match, so all files are markdownlint-clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-11 22:07:47 -04:00

730 B

title
general / scale

scale

NAME

scale() - apply a scaling to a transformation matrix

SYNOPSIS

float *scale(float *matrix, float x, float y, float z)

DESCRIPTION

Post-multiplies the 4x4 transformation `matrix` (a 16-element flat
array of floats, as produced by id_matrix()) by a scaling of
(`x`, `y`, `z`), computing `matrix` = `matrix` * scaling.

The passed `matrix` array is modified IN PLACE: its 16 elements are
overwritten with the result, and that same array is left on the stack
as the return value. scale() mutates its first argument; the return
value is the very array you passed in, not a copy.

SEE ALSO

id_matrix(3), translate(3), rotate_x(3)