# HD_MAGIC0
const HD_MAGIC0 = 77Defines hd magic0 for the hdwad builder subsystem.
src/hdwad_builder.mlBuilds MiniDoom HDWAD cache files inside the game executable.
std/fs.ml as fs → ../MiniLangCompilerOptimization/MiniLangCompilerPy/std/fs.ml external dependencystd/math.ml → ../MiniLangCompilerOptimization/MiniLangCompilerPy/std/math.ml external dependencyconst HD_MAGIC0 = 77Defines hd magic0 for the hdwad builder subsystem.
const HD_MAGIC1 = 68Defines hd magic1 for the hdwad builder subsystem.
const HD_MAGIC2 = 72Defines hd magic2 for the hdwad builder subsystem.
const HD_MAGIC3 = 68Defines hd magic3 for the hdwad builder subsystem.
function HDB_BuildImages(wadData, lumps, scale)Loads the palette and patch namespace, then builds the complete HD image set from wall textures, flats, sprites, and remaining patch lumps.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `HDB_BuildImages`. |
lumps | dynamic | — | Lumps value supplied to `HDB_BuildImages`. |
scale | dynamic | — | Scale value supplied to `HDB_BuildImages`. |
function HDB_EstimateImageProgressUnits(wadData, lumps, scale)Estimates the progress units emitted while HDWAD graphics are built.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `HDB_EstimateImageProgressUnits`. |
lumps | dynamic | — | Lumps value supplied to `HDB_EstimateImageProgressUnits`. |
scale | dynamic | — | Scale value supplied to `HDB_EstimateImageProgressUnits`. |
function HDB_LegacyToolMain(args)Legacy helper kept for manual module testing.
| Parameter | Type | Default | Description |
|---|---|---|---|
args | dynamic | — | Args value supplied to `HDB_LegacyToolMain`. |
function HDB_LoadWadForBuild(path)Loads and validates the source WAD bytes and directory through the builder's shared WAD parser.
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
function HDB_WriteHDWAD(path, wadData, lumps, images, extraNames, extraDatas, scale)Exposes full HDWAD packaging, including synthetic lumps, through the builder module's stable public entry point.
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
wadData | dynamic | — | Wad data value supplied to `HDB_WriteHDWAD`. |
lumps | dynamic | — | Lumps value supplied to `HDB_WriteHDWAD`. |
images | dynamic | — | Images value supplied to `HDB_WriteHDWAD`. |
extraNames | dynamic | — | Extra names value supplied to `HDB_WriteHDWAD`. |
extraDatas | dynamic | — | Extra datas value supplied to `HDB_WriteHDWAD`. |
scale | dynamic | — | Scale value supplied to `HDB_WriteHDWAD`. |
function UP_AddAllPatchLumps(images, wadData, lumps, scale, pal)Extracts all remaining Doom patch-format graphics such as HUD, menu, title, finale and fonts.
| Parameter | Type | Default | Description |
|---|---|---|---|
images | dynamic | — | Images value supplied to `UP_AddAllPatchLumps`. |
wadData | dynamic | — | Wad data value supplied to `UP_AddAllPatchLumps`. |
lumps | dynamic | — | Lumps value supplied to `UP_AddAllPatchLumps`. |
scale | dynamic | — | Scale value supplied to `UP_AddAllPatchLumps`. |
pal | dynamic | — | Pal value supplied to `UP_AddAllPatchLumps`. |
function UP_AddFlatRange(images, wadData, lumps, startName, endName, scale, pal)Extracts flat images from a marker range.
| Parameter | Type | Default | Description |
|---|---|---|---|
images | dynamic | — | Images value supplied to `UP_AddFlatRange`. |
wadData | dynamic | — | Wad data value supplied to `UP_AddFlatRange`. |
lumps | dynamic | — | Lumps value supplied to `UP_AddFlatRange`. |
startName | dynamic | — | Start name value supplied to `UP_AddFlatRange`. |
endName | dynamic | — | End name value supplied to `UP_AddFlatRange`. |
scale | dynamic | — | Scale value supplied to `UP_AddFlatRange`. |
pal | dynamic | — | Pal value supplied to `UP_AddFlatRange`. |
function UP_AddPatchRange(images, wadData, lumps, startName, endName, kind, scale, pal)Extracts Doom patch images from a marker range.
| Parameter | Type | Default | Description |
|---|---|---|---|
images | dynamic | — | Images value supplied to `UP_AddPatchRange`. |
wadData | dynamic | — | Wad data value supplied to `UP_AddPatchRange`. |
lumps | dynamic | — | Lumps value supplied to `UP_AddPatchRange`. |
startName | dynamic | — | Start name value supplied to `UP_AddPatchRange`. |
endName | dynamic | — | End name value supplied to `UP_AddPatchRange`. |
kind | dynamic | — | Kind value supplied to `UP_AddPatchRange`. |
scale | dynamic | — | Scale value supplied to `UP_AddPatchRange`. |
pal | dynamic | — | Pal value supplied to `UP_AddPatchRange`. |
function UP_AddTextureLump(images, wadData, lumps, lumpName, patchLookup, scale, pal)Adds composited wall textures from TEXTURE1/TEXTURE2.
| Parameter | Type | Default | Description |
|---|---|---|---|
images | dynamic | — | Images value supplied to `UP_AddTextureLump`. |
wadData | dynamic | — | Wad data value supplied to `UP_AddTextureLump`. |
lumps | dynamic | — | Lumps value supplied to `UP_AddTextureLump`. |
lumpName | dynamic | — | Lump name value supplied to `UP_AddTextureLump`. |
patchLookup | dynamic | — | Patch lookup value supplied to `UP_AddTextureLump`. |
scale | dynamic | — | Scale value supplied to `UP_AddTextureLump`. |
pal | dynamic | — | Pal value supplied to `UP_AddTextureLump`. |
function UP_BestEdgeColor(pal, center, a, b, hasAlpha)Chooses the closer edge color for a corner blend.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_BestEdgeColor`. |
center | dynamic | — | Center value supplied to `UP_BestEdgeColor`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_BestEdgeColorCached(pal, cache, center, a, b, hasAlpha)Chooses the closer edge color using cached palette distances.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_BestEdgeColorCached`. |
cache | dynamic | — | Cache value supplied to `UP_BestEdgeColorCached`. |
center | dynamic | — | Center value supplied to `UP_BestEdgeColorCached`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_BlendCorner(dst, dw, blockX, blockY, scale, corner, base, edge, pal, cache, hasAlpha)Applies a triangular xBRZ corner blend inside one scaled block.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_BlendCorner`. |
dw | dynamic | — | Dw value supplied to `UP_BlendCorner`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
scale | dynamic | — | Scale value supplied to `UP_BlendCorner`. |
corner | dynamic | — | Corner value supplied to `UP_BlendCorner`. |
base | dynamic | — | Base value supplied to `UP_BlendCorner`. |
edge | dynamic | — | Edge value supplied to `UP_BlendCorner`. |
pal | dynamic | — | Pal value supplied to `UP_BlendCorner`. |
cache | dynamic | — | Cache value supplied to `UP_BlendCorner`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_BlendEdgeColumn(dst, dw, blockX, blockY, scale, col, base, edge, pal, cache, hasAlpha, weight)Blends one vertical edge of a scaled block toward a neighboring edge color.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_BlendEdgeColumn`. |
dw | dynamic | — | Dw value supplied to `UP_BlendEdgeColumn`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
scale | dynamic | — | Scale value supplied to `UP_BlendEdgeColumn`. |
col | dynamic | — | Col value supplied to `UP_BlendEdgeColumn`. |
base | dynamic | — | Base value supplied to `UP_BlendEdgeColumn`. |
edge | dynamic | — | Edge value supplied to `UP_BlendEdgeColumn`. |
pal | dynamic | — | Pal value supplied to `UP_BlendEdgeColumn`. |
cache | dynamic | — | Cache value supplied to `UP_BlendEdgeColumn`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
weight | dynamic | — | Weight value supplied to `UP_BlendEdgeColumn`. |
function UP_BlendEdgeRow(dst, dw, blockX, blockY, scale, row, base, edge, pal, cache, hasAlpha, weight)Blends one horizontal edge of a scaled block toward a neighboring edge color.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_BlendEdgeRow`. |
dw | dynamic | — | Dw value supplied to `UP_BlendEdgeRow`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
scale | dynamic | — | Scale value supplied to `UP_BlendEdgeRow`. |
row | dynamic | — | Row value supplied to `UP_BlendEdgeRow`. |
base | dynamic | — | Base value supplied to `UP_BlendEdgeRow`. |
edge | dynamic | — | Edge value supplied to `UP_BlendEdgeRow`. |
pal | dynamic | — | Pal value supplied to `UP_BlendEdgeRow`. |
cache | dynamic | — | Cache value supplied to `UP_BlendEdgeRow`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
weight | dynamic | — | Weight value supplied to `UP_BlendEdgeRow`. |
function UP_BlendIndex(pal, cache, base, edge, edgeWeight, hasAlpha)Blends two palette indices and quantizes the result.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_BlendIndex`. |
cache | dynamic | — | Cache value supplied to `UP_BlendIndex`. |
base | dynamic | — | Base value supplied to `UP_BlendIndex`. |
edge | dynamic | — | Edge value supplied to `UP_BlendIndex`. |
edgeWeight | dynamic | — | Edge weight value supplied to `UP_BlendIndex`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_BlendIndexRatio(pal, cache, base, edge, ratioCode, hasAlpha)Controls blend Index Ratio transitions in the HDWAD builder system.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_BlendIndexRatio`. |
cache | dynamic | — | Cache value supplied to `UP_BlendIndexRatio`. |
base | dynamic | — | Base value supplied to `UP_BlendIndexRatio`. |
edge | dynamic | — | Edge value supplied to `UP_BlendIndexRatio`. |
ratioCode | dynamic | — | Ratio code value supplied to `UP_BlendIndexRatio`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_BuildTextureImage(tex, wadData, lumps)Composites a wall texture from its source patch placements.
| Parameter | Type | Default | Description |
|---|---|---|---|
tex | dynamic | — | Texture identifier or texture data to process. |
wadData | dynamic | — | Wad data value supplied to `UP_BuildTextureImage`. |
lumps | dynamic | — | Lumps value supplied to `UP_BuildTextureImage`. |
inline function UP_ClampScale(v)Keeps output scale inside the supported package range.
| Parameter | Type | Default | Description |
|---|---|---|---|
v | dynamic | — | Value consumed by the operation. |
function UP_ColorDistance(pal, a, b, hasAlpha)Computes weighted RGB distance for xBRZ edge decisions.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_ColorDistance`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_ColorDistanceCached(pal, cache, a, b, hasAlpha)Computes palette distance with a per-image 256x256 cache.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_ColorDistanceCached`. |
cache | dynamic | — | Cache value supplied to `UP_ColorDistanceCached`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_CopyBytes(dst, dstOff, src, srcOff, count)Copies a byte range.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_CopyBytes`. |
dstOff | dynamic | — | Dst off value supplied to `UP_CopyBytes`. |
src | dynamic | — | Src value supplied to `UP_CopyBytes`. |
srcOff | dynamic | — | Src off value supplied to `UP_CopyBytes`. |
count | dynamic | — | Number of elements or iterations to process. |
inline function UP_CornerWeight(dist, scale)Returns the local xBRZ corner blend weight for one block coordinate.
| Parameter | Type | Default | Description |
|---|---|---|---|
dist | dynamic | — | Dist value supplied to `UP_CornerWeight`. |
scale | dynamic | — | Scale value supplied to `UP_CornerWeight`. |
function UP_CountMarkerRange(lumps, startName, endName)Counts WAD lumps between two marker names for progress estimation.
| Parameter | Type | Default | Description |
|---|---|---|---|
lumps | dynamic | — | Lumps value supplied to `UP_CountMarkerRange`. |
startName | dynamic | — | Start name value supplied to `UP_CountMarkerRange`. |
endName | dynamic | — | End name value supplied to `UP_CountMarkerRange`. |
function UP_DecodePatch(name, kind, lumpData)Converts a Doom patch lump into a palettized rectangular image.
| Parameter | Type | Default | Description |
|---|---|---|---|
name | dynamic | — | Resource or object name to resolve. |
kind | dynamic | — | Kind value supplied to `UP_DecodePatch`. |
lumpData | dynamic | — | Lump data value supplied to `UP_DecodePatch`. |
function UP_DefaultPalette()Builds a grayscale fallback palette.
function UP_DrawPatchToTexture(patch, canvas, texW, texH, originX, originY)Draws a decoded patch image into an indexed texture canvas.
| Parameter | Type | Default | Description |
|---|---|---|---|
patch | dynamic | — | Patch value supplied to `UP_DrawPatchToTexture`. |
canvas | dynamic | — | Canvas value supplied to `UP_DrawPatchToTexture`. |
texW | dynamic | — | Tex w value supplied to `UP_DrawPatchToTexture`. |
texH | dynamic | — | Tex h value supplied to `UP_DrawPatchToTexture`. |
originX | dynamic | — | Horizontal coordinate or vector component represented by origin x. |
originY | dynamic | — | Vertical coordinate or vector component represented by origin y. |
function UP_FindLump(lumps, name)Finds a lump by name.
| Parameter | Type | Default | Description |
|---|---|---|---|
lumps | dynamic | — | Lumps value supplied to `UP_FindLump`. |
name | dynamic | — | Resource or object name to resolve. |
function UP_FindMarker(lumps, name)Finds the first lump marker with the given name.
| Parameter | Type | Default | Description |
|---|---|---|---|
lumps | dynamic | — | Lumps value supplied to `UP_FindMarker`. |
name | dynamic | — | Resource or object name to resolve. |
const UP_FLAG_TRANSPARENT = 1Defines up flag transparent for the hdwad builder subsystem.
function UP_HasImage(images, kind, name)Checks whether an image with the same kind/name was already emitted.
| Parameter | Type | Default | Description |
|---|---|---|---|
images | dynamic | — | Images value supplied to `UP_HasImage`. |
kind | dynamic | — | Kind value supplied to `UP_HasImage`. |
name | dynamic | — | Resource or object name to resolve. |
up_image_t struct
function UP_IsLikelyPatch(data)Performs conservative validation for Doom patch data.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | dynamic | — | Binary or structured data to process. |
function UP_IsMarkerName(name)Avoids trying marker/control lumps as patch images.
| Parameter | Type | Default | Description |
|---|---|---|---|
name | dynamic | — | Resource or object name to resolve. |
inline function UP_IsTransparent(idx, hasAlpha)Checks whether an indexed pixel is transparent for patch-like images.
| Parameter | Type | Default | Description |
|---|---|---|---|
idx | dynamic | — | Zero-based element or table index. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_LoadingPulse()Pumps the host window while HDWAD generation performs long CPU-bound work.
function UP_LoadPalette(wadData, lumps)Extracts the first PLAYPAL palette from the WAD.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `UP_LoadPalette`. |
lumps | dynamic | — | Lumps value supplied to `UP_LoadPalette`. |
function UP_LoadWad(path)Reads a WAD and returns [data, lumps].
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
up_lump_t struct
function UP_LumpBytes(wadData, lumps, idx)Returns a lump payload or void.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `UP_LumpBytes`. |
lumps | dynamic | — | Lumps value supplied to `UP_LumpBytes`. |
idx | dynamic | — | Zero-based element or table index. |
const UP_MAGIC0 = 77Defines up magic0 for the hdwad builder subsystem.
const UP_MAGIC1 = 68Defines up magic1 for the hdwad builder subsystem.
const UP_MAGIC2 = 85Defines up magic2 for the hdwad builder subsystem.
const UP_MAGIC3 = 80Defines up magic3 for the hdwad builder subsystem.
function UP_Name8(b)Decodes a WAD name.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
function UP_NearestPaletteIndex(pal, r, g, b, hasAlpha)Quantizes an RGB color back to the Doom palette.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_NearestPaletteIndex`. |
r | dynamic | — | R value supplied to `UP_NearestPaletteIndex`. |
g | dynamic | — | G value supplied to `UP_NearestPaletteIndex`. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
const UP_OPAQUE_255_REMAP = 254Defines up opaque 255 remap for the hdwad builder subsystem.
function UP_ParsePnames(wadData, lumps)Builds PNAMES patch-name to lump-index mapping.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `UP_ParsePnames`. |
lumps | dynamic | — | Lumps value supplied to `UP_ParsePnames`. |
function UP_ParseTextureLump(wadData, lumps, lumpName, patchLookup)Parses TEXTURE1/TEXTURE2 wall texture definitions.
| Parameter | Type | Default | Description |
|---|---|---|---|
wadData | dynamic | — | Wad data value supplied to `UP_ParseTextureLump`. |
lumps | dynamic | — | Lumps value supplied to `UP_ParseTextureLump`. |
lumpName | dynamic | — | Lump name value supplied to `UP_ParseTextureLump`. |
patchLookup | dynamic | — | Patch lookup value supplied to `UP_ParseTextureLump`. |
inline function UP_PixelAt(src, w, h, x, y)Reads a clamped source pixel.
| Parameter | Type | Default | Description |
|---|---|---|---|
src | dynamic | — | Src value supplied to `UP_PixelAt`. |
w | dynamic | — | W value supplied to `UP_PixelAt`. |
h | dynamic | — | H value supplied to `UP_PixelAt`. |
x | dynamic | — | Horizontal map- or screen-space coordinate. |
y | dynamic | — | Vertical map- or screen-space coordinate. |
inline function UP_ReadS16(b, off)Reads a little-endian s16.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
off | dynamic | — | Zero-based byte or element offset. |
inline function UP_ReadS32(b, off)Reads a little-endian s32.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
off | dynamic | — | Zero-based byte or element offset. |
inline function UP_ReadU16(b, off)Reads a little-endian u16.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
off | dynamic | — | Zero-based byte or element offset. |
inline function UP_ReadU32(b, off)Reads a little-endian u32.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
off | dynamic | — | Zero-based byte or element offset. |
inline function UP_ReportProgress(units)Reports one or more HDWAD generation units to the frontend progress display.
| Parameter | Type | Default | Description |
|---|---|---|---|
units | dynamic | — | Units value supplied to `UP_ReportProgress`. |
inline function UP_SimilarColor(pal, a, b, hasAlpha)Evaluates xBRZ-style color equality with a distance threshold.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_SimilarColor`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_SimilarColorCached(pal, cache, a, b, hasAlpha)Evaluates xBRZ-style equality using the per-image distance cache.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_SimilarColorCached`. |
cache | dynamic | — | Cache value supplied to `UP_SimilarColorCached`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_StrongEdgeWeight(pal, base, edge, hasAlpha)Chooses a slightly stronger blend for hard pixel-art edges.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_StrongEdgeWeight`. |
base | dynamic | — | Base value supplied to `UP_StrongEdgeWeight`. |
edge | dynamic | — | Edge value supplied to `UP_StrongEdgeWeight`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_StrongEdgeWeightCached(pal, cache, base, edge, hasAlpha)Chooses blend strength using cached palette distances.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_StrongEdgeWeightCached`. |
cache | dynamic | — | Cache value supplied to `UP_StrongEdgeWeightCached`. |
base | dynamic | — | Base value supplied to `UP_StrongEdgeWeightCached`. |
edge | dynamic | — | Edge value supplied to `UP_StrongEdgeWeightCached`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
up_texpatch_t struct
up_texture_t struct
function UP_ToIntOr(v, fallback)Converts a value to int with fallback.
| Parameter | Type | Default | Description |
|---|---|---|---|
v | dynamic | — | Value consumed by the operation. |
fallback | dynamic | — | Value returned when the requested conversion or lookup is unavailable. |
const UP_TRANSPARENT_INDEX = 255Defines up transparent index for the hdwad builder subsystem.
const UP_TYPE_FLAT = 2Defines up type flat for the hdwad builder subsystem.
const UP_TYPE_PATCH = 1Defines up type patch for the hdwad builder subsystem.
const UP_TYPE_SPRITE = 4Defines up type sprite for the hdwad builder subsystem.
const UP_TYPE_TEXTURE = 3Defines up type texture for the hdwad builder subsystem.
const UP_VERSION = 6Defines up version for the hdwad builder subsystem.
function UP_WriteHDWADPackage(path, wadData, lumps, images, scale)Emits a complete HDWAD containing original lumps and upscaled images by delegating with no synthetic lumps.
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
wadData | dynamic | — | Wad data value supplied to `UP_WriteHDWADPackage`. |
lumps | dynamic | — | Lumps value supplied to `UP_WriteHDWADPackage`. |
images | dynamic | — | Images value supplied to `UP_WriteHDWADPackage`. |
scale | dynamic | — | Scale value supplied to `UP_WriteHDWADPackage`. |
function UP_WriteHDWADPackageWithExtraLumps(path, wadData, lumps, images, extraNames, extraDatas, scale)Lays out an HDWAD header, original and synthetic lump payloads, image payloads, and both directories before saving atomically.
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
wadData | dynamic | — | Wad data value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
lumps | dynamic | — | Lumps value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
images | dynamic | — | Images value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
extraNames | dynamic | — | Extra names value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
extraDatas | dynamic | — | Extra datas value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
scale | dynamic | — | Scale value supplied to `UP_WriteHDWADPackageWithExtraLumps`. |
function UP_WritePackage(path, images, scale)Writes extracted images as a MiniDoom upscaled package.
| Parameter | Type | Default | Description |
|---|---|---|---|
path | dynamic | — | Filesystem path to process. |
images | dynamic | — | Images value supplied to `UP_WritePackage`. |
scale | dynamic | — | Scale value supplied to `UP_WritePackage`. |
inline function UP_WriteU32(b, off, value)Writes a little-endian u32.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
off | dynamic | — | Zero-based byte or element offset. |
value | dynamic | — | Value consumed by the operation. |
const UP_XBRZ_BLEND_DOMINANT = 2Defines up xbrz blend dominant for the hdwad builder subsystem.
const UP_XBRZ_BLEND_NONE = 0Defines up xbrz blend none for the hdwad builder subsystem.
const UP_XBRZ_BLEND_NORMAL = 1Defines up xbrz blend normal for the hdwad builder subsystem.
const UP_XBRZ_DIST_LIMIT = 4200Defines up xbrz dist limit for the hdwad builder subsystem.
const UP_XBRZ_DOMINANT_DIRECTION_THRESHOLD = 3.6Defines up xbrz dominant direction threshold for the hdwad builder subsystem.
const UP_XBRZ_EQUAL_COLOR_TOLERANCE = 30.Defines the Doom palette selection for up xbrz equal color tolerance.
const UP_XBRZ_STEEP_DIRECTION_THRESHOLD = 2.2Defines up xbrz steep direction threshold for the hdwad builder subsystem.
function UP_XbrzBlendCorner3(dst, dw, blockX, blockY, rot, col, pal, blendCache, hasAlpha)Controls xbrz Blend Corner3 transitions in the HDWAD builder system.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendCorner3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendCorner3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendCorner3`. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendCorner3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendCorner3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendCorner3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzBlendLineDiagonal3(dst, dw, blockX, blockY, rot, col, pal, blendCache, hasAlpha)Applies the xBRZ 3x diagonal-edge weights to the two adjacent cells and corner cell.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendLineDiagonal3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendLineDiagonal3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendLineDiagonal3`. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendLineDiagonal3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendLineDiagonal3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendLineDiagonal3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzBlendLineShallow3(dst, dw, blockX, blockY, rot, col, pal, blendCache, hasAlpha)Applies the xBRZ 3x shallow-edge coverage pattern with weighted blends and one fully replaced corner pixel.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendLineShallow3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendLineShallow3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendLineShallow3`. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendLineShallow3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendLineShallow3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendLineShallow3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzBlendLineSteep3(dst, dw, blockX, blockY, rot, col, pal, blendCache, hasAlpha)Applies the rotated xBRZ 3x steep-edge coverage pattern to the current destination block.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendLineSteep3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendLineSteep3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendLineSteep3`. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendLineSteep3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendLineSteep3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendLineSteep3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzBlendLineSteepAndShallow3(dst, dw, blockX, blockY, rot, col, pal, blendCache, hasAlpha)Applies the combined xBRZ 3x corner pattern when both steep and shallow edge tests succeed.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendLineSteepAndShallow3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzBlendPixel3(dst, dw, blockX, blockY, blendInfo, rot, pal, distCache, blendCache, hasAlpha, a0, b0, c0, d0, e0, f0, g0, h0, i0)Controls xbrz Blend Pixel3 transitions in the HDWAD builder system.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendPixel3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendPixel3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
blendInfo | dynamic | — | Blend info value supplied to `UP_XbrzBlendPixel3`. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendPixel3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendPixel3`. |
distCache | dynamic | — | Dist cache value supplied to `UP_XbrzBlendPixel3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendPixel3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
a0 | dynamic | — | A0 value supplied to `UP_XbrzBlendPixel3`. |
b0 | dynamic | — | B0 value supplied to `UP_XbrzBlendPixel3`. |
c0 | dynamic | — | C0 value supplied to `UP_XbrzBlendPixel3`. |
d0 | dynamic | — | D0 value supplied to `UP_XbrzBlendPixel3`. |
e0 | dynamic | — | E0 value supplied to `UP_XbrzBlendPixel3`. |
f0 | dynamic | — | F0 value supplied to `UP_XbrzBlendPixel3`. |
g0 | dynamic | — | G0 value supplied to `UP_XbrzBlendPixel3`. |
h0 | dynamic | — | H0 value supplied to `UP_XbrzBlendPixel3`. |
i0 | dynamic | — | I0 value supplied to `UP_XbrzBlendPixel3`. |
function UP_XbrzBlendRef3(dst, dw, blockX, blockY, rot, i, j, col, pal, blendCache, hasAlpha, ratioCode)Controls xbrz Blend Ref3 transitions in the HDWAD builder system.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzBlendRef3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzBlendRef3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzBlendRef3`. |
i | dynamic | — | Zero-based iteration index. |
j | dynamic | — | Secondary zero-based iteration index. |
col | dynamic | — | Col value supplied to `UP_XbrzBlendRef3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzBlendRef3`. |
blendCache | dynamic | — | Blend cache value supplied to `UP_XbrzBlendRef3`. |
hasAlpha | dynamic | — | Whether has alpha holds. |
ratioCode | dynamic | — | Ratio code value supplied to `UP_XbrzBlendRef3`. |
function UP_XbrzDistanceCached(pal, cache, a, b, hasAlpha)Computes the palette distance used by the original xBRZ rules.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_XbrzDistanceCached`. |
cache | dynamic | — | Cache value supplied to `UP_XbrzDistanceCached`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_XbrzEq(pal, cache, a, b, hasAlpha)Tests palette equality using xBRZ's perceptual tolerance.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_XbrzEq`. |
cache | dynamic | — | Cache value supplied to `UP_XbrzEq`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
hasAlpha | dynamic | — | Whether has alpha holds. |
inline function UP_XbrzGetBottomL(b)Extracts the two-bit bottom-left corner blend classification from a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
inline function UP_XbrzGetBottomR(b)Extracts the two-bit bottom-right corner blend classification from a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
inline function UP_XbrzGetTopL(b)Extracts the two-bit top-left corner blend classification from a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
inline function UP_XbrzGetTopR(b)Extracts the two-bit top-right corner blend classification from a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
function UP_XbrzPreProcessCorners(pal, cache, a, b, c, d, e, f, g, h, ii, j, k, l, m, n, o, p, hasAlpha)Compares color-distance paths through a 4x4 neighborhood and classifies normal or dominant edge blends for the central corners.
| Parameter | Type | Default | Description |
|---|---|---|---|
pal | dynamic | — | Pal value supplied to `UP_XbrzPreProcessCorners`. |
cache | dynamic | — | Cache value supplied to `UP_XbrzPreProcessCorners`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
c | dynamic | — | C value supplied to `UP_XbrzPreProcessCorners`. |
d | dynamic | — | Divisor or direction value used by the operation. |
e | dynamic | — | E value supplied to `UP_XbrzPreProcessCorners`. |
f | dynamic | — | F value supplied to `UP_XbrzPreProcessCorners`. |
g | dynamic | — | G value supplied to `UP_XbrzPreProcessCorners`. |
h | dynamic | — | H value supplied to `UP_XbrzPreProcessCorners`. |
ii | dynamic | — | Ii value supplied to `UP_XbrzPreProcessCorners`. |
j | dynamic | — | Secondary zero-based iteration index. |
k | dynamic | — | K value supplied to `UP_XbrzPreProcessCorners`. |
l | dynamic | — | L value supplied to `UP_XbrzPreProcessCorners`. |
m | dynamic | — | M value supplied to `UP_XbrzPreProcessCorners`. |
n | dynamic | — | Number of values to process. |
o | dynamic | — | O value supplied to `UP_XbrzPreProcessCorners`. |
p | dynamic | — | Object or data record consumed by the operation. |
hasAlpha | dynamic | — | Whether has alpha holds. |
function UP_XbrzRefIndex3(dw, blockX, blockY, rot, i, j)Rotates a 3x3 xBRZ neighbor coordinate and returns its linear index in the source image.
| Parameter | Type | Default | Description |
|---|---|---|---|
dw | dynamic | — | Dw value supplied to `UP_XbrzRefIndex3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzRefIndex3`. |
i | dynamic | — | Zero-based iteration index. |
j | dynamic | — | Secondary zero-based iteration index. |
function UP_XbrzRotateBlendInfo(b, rot)Controls xbrz Rotate Blend Info transitions in the HDWAD builder system.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
rot | dynamic | — | Rot value supplied to `UP_XbrzRotateBlendInfo`. |
function UP_XbrzRotGet(rot, pos, a, b, c, d, e, f, g, h, ii)Returns a 3x3 neighborhood sample through a requested quarter-turn so one blend kernel handles all four orientations.
| Parameter | Type | Default | Description |
|---|---|---|---|
rot | dynamic | — | Rot value supplied to `UP_XbrzRotGet`. |
pos | dynamic | — | Pos value supplied to `UP_XbrzRotGet`. |
a | dynamic | — | First input operand. |
b | dynamic | — | Second input operand. |
c | dynamic | — | C value supplied to `UP_XbrzRotGet`. |
d | dynamic | — | Divisor or direction value used by the operation. |
e | dynamic | — | E value supplied to `UP_XbrzRotGet`. |
f | dynamic | — | F value supplied to `UP_XbrzRotGet`. |
g | dynamic | — | G value supplied to `UP_XbrzRotGet`. |
h | dynamic | — | H value supplied to `UP_XbrzRotGet`. |
ii | dynamic | — | Ii value supplied to `UP_XbrzRotGet`. |
function UP_XbrzScaleIndexed(img, scale, pal)Scales an indexed image with palette-aware xBRZ-style edge reconstruction.
| Parameter | Type | Default | Description |
|---|---|---|---|
img | dynamic | — | Img value supplied to `UP_XbrzScaleIndexed`. |
scale | dynamic | — | Scale value supplied to `UP_XbrzScaleIndexed`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzScaleIndexed`. |
function UP_XbrzScaleIndexed3(img, pal)Upscales one indexed image by exactly 3x using cached palette distances, preclassified corners, and rotation-invariant xBRZ edge blending.
| Parameter | Type | Default | Description |
|---|---|---|---|
img | dynamic | — | Img value supplied to `UP_XbrzScaleIndexed3`. |
pal | dynamic | — | Pal value supplied to `UP_XbrzScaleIndexed3`. |
inline function UP_XbrzSetBottomL(b, bt)Adds a bottom-left two-bit classification to a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
bt | dynamic | — | Bt value supplied to `UP_XbrzSetBottomL`. |
inline function UP_XbrzSetBottomR(b, bt)Adds a bottom-right two-bit classification to a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
bt | dynamic | — | Bt value supplied to `UP_XbrzSetBottomR`. |
inline function UP_XbrzSetRef3(dst, dw, blockX, blockY, rot, i, j, col)Writes one output color to a rotation-relative cell of the current 3x3 destination block.
| Parameter | Type | Default | Description |
|---|---|---|---|
dst | dynamic | — | Dst value supplied to `UP_XbrzSetRef3`. |
dw | dynamic | — | Dw value supplied to `UP_XbrzSetRef3`. |
blockX | dynamic | — | Horizontal coordinate or vector component represented by block x. |
blockY | dynamic | — | Vertical coordinate or vector component represented by block y. |
rot | dynamic | — | Rot value supplied to `UP_XbrzSetRef3`. |
i | dynamic | — | Zero-based iteration index. |
j | dynamic | — | Secondary zero-based iteration index. |
col | dynamic | — | Col value supplied to `UP_XbrzSetRef3`. |
inline function UP_XbrzSetTopL(b, bt)Adds a top-left two-bit classification to a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
bt | dynamic | — | Bt value supplied to `UP_XbrzSetTopL`. |
inline function UP_XbrzSetTopR(b, bt)Adds a top-right two-bit classification to a packed xBRZ blend byte.
| Parameter | Type | Default | Description |
|---|---|---|---|
b | dynamic | — | Second input operand. |
bt | dynamic | — | Bt value supplied to `UP_XbrzSetTopR`. |