Files
src/f_wipe.ml
Captures transition screens and incrementally blends or melts the old image into the new one.
- Package
(global)- Reachable
- Yes
Imports
Declarations
# _FW_ByteCopy
function _FW_ByteCopy(dst, src, count)
Copies the common bounded prefix of two byte buffers without overrunning either allocation.
| Parameter | Type | Default | Description |
|---|
dst | dynamic | — | Dst value supplied to `_FW_ByteCopy`. |
src | dynamic | — | Src value supplied to `_FW_ByteCopy`. |
count | dynamic | — | Number of elements or iterations to process. |
View source
# _FW_ReadU16LE
inline function _FW_ReadU16LE(buf, wordIndex)
Reads one bounds-checked little-endian 16-bit pixel pair from a byte buffer.
| Parameter | Type | Default | Description |
|---|
buf | dynamic | — | Buf value supplied to `_FW_ReadU16LE`. |
wordIndex | dynamic | — | Index identifying word. |
View source
# _FW_WriteU16LE
inline function _FW_WriteU16LE(buf, wordIndex, v)
Writes one bounds-checked little-endian 16-bit pixel pair into a byte buffer.
| Parameter | Type | Default | Description |
|---|
buf | dynamic | — | Buf value supplied to `_FW_WriteU16LE`. |
wordIndex | dynamic | — | Index identifying word. |
v | dynamic | — | Value consumed by the operation. |
View source
# _wipeRand
inline function _wipeRand()
Produces deterministic 15-bit fallback randomness for melt-column delays when the game RNG is unavailable.
View source
# wipe_ColorXForm
const wipe_ColorXForm = 0
Defines the Doom palette selection for wipe color xform.
View source
# wipe_doColorXForm
function wipe_doColorXForm(width, height, ticks)
Moves every live palette index toward its target by at most ticks and reports when no differing pixels remain.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_doColorXForm`. |
View source
# wipe_doMelt
function wipe_doMelt(width, height, ticks)
Advances each delayed two-pixel melt column, exposing target pixels above and retaining source pixels below its frontier.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_doMelt`. |
View source
# wipe_EndScreen
function wipe_EndScreen(x, y, width, height)
Captures the newly drawn display as the target snapshot, then restores the start image before animation begins.
| Parameter | Type | Default | Description |
|---|
x | dynamic | — | Horizontal map- or screen-space coordinate. |
y | dynamic | — | Vertical map- or screen-space coordinate. |
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
View source
# wipe_EndScreenFromBuffer
function wipe_EndScreenFromBuffer(x, y, width, height, buf)
Uses a supplied target snapshot and restores the captured start image, avoiding a display readback.
| Parameter | Type | Default | Description |
|---|
x | dynamic | — | Horizontal map- or screen-space coordinate. |
y | dynamic | — | Vertical map- or screen-space coordinate. |
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
buf | dynamic | — | Buf value supplied to `wipe_EndScreenFromBuffer`. |
View source
# wipe_exitColorXForm
function wipe_exitColorXForm(width, height, ticks)
Completes the color-wipe lifecycle; this mode owns no temporary state requiring release.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_exitColorXForm`. |
View source
# wipe_exitMelt
function wipe_exitMelt(width, height, ticks)
Releases the per-column melt-frontier array after the transition reaches the bottom of the screen.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_exitMelt`. |
View source
# wipe_go
wipe_go
Tracks whether wipe go is active in the f wipe subsystem.
View source
# wipe_initColorXForm
function wipe_initColorXForm(width, height, ticks)
Seeds the live framebuffer from the captured start image before a palette-index crossfade.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_initColorXForm`. |
View source
# wipe_initMelt
function wipe_initMelt(width, height, ticks)
Copies the start image, converts snapshots to column-major pairs, and assigns correlated random delays to melt columns.
| Parameter | Type | Default | Description |
|---|
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_initMelt`. |
View source
# wipe_Melt
const wipe_Melt = 1
Defines wipe melt for the f wipe subsystem.
View source
# wipe_scr
wipe_scr
Holds the optional wipe scr resource used by the f wipe subsystem.
View source
# wipe_scr_end
wipe_scr_end
Holds the optional wipe scr end resource used by the f wipe subsystem.
View source
# wipe_scr_start
wipe_scr_start
Holds the optional wipe scr start resource used by the f wipe subsystem.
View source
# wipe_ScreenWipe
function wipe_ScreenWipe(wipeno, x, y, width, height, ticks)
Initializes, advances, and finalizes the selected wipe mode; returns true only after the transition completes.
| Parameter | Type | Default | Description |
|---|
wipeno | dynamic | — | Wipeno value supplied to `wipe_ScreenWipe`. |
x | dynamic | — | Horizontal map- or screen-space coordinate. |
y | dynamic | — | Vertical map- or screen-space coordinate. |
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
ticks | dynamic | — | Ticks value supplied to `wipe_ScreenWipe`. |
View source
# wipe_seed
wipe_seed
Tracks the mutable wipe seed value used by the f wipe subsystem.
View source
# wipe_shittyColMajorXform
function wipe_shittyColMajorXform(array16, width, height)
Transposes packed two-pixel words in place from row-major to column-major order for independent melt columns.
| Parameter | Type | Default | Description |
|---|
array16 | dynamic | — | Array16 value supplied to `wipe_shittyColMajorXform`. |
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
View source
# wipe_StartScreen
function wipe_StartScreen(x, y, width, height)
Captures the current display into the start snapshot and selects screen zero as the transition output buffer.
| Parameter | Type | Default | Description |
|---|
x | dynamic | — | Horizontal map- or screen-space coordinate. |
y | dynamic | — | Vertical map- or screen-space coordinate. |
width | dynamic | — | Width of the target in pixels or map units. |
height | dynamic | — | Height of the target in pixels or map units. |
View source
# wipe_y
wipe_y
Holds the optional wipe y resource used by the f wipe subsystem.
View source