MiniDoom

src/r_upscaled.ml

Loads optional MiniDoom upscaled graphics packages and shared render-scale settings.

Package
(global)
Reachable
Yes

Imports

Declarations

RH_MAGIC2

const RH_MAGIC2 = 72

Defines rh magic2 for the r upscaled subsystem.

View source

RH_MAGIC3

const RH_MAGIC3 = 68

Defines rh magic3 for the r upscaled subsystem.

View source

RU_ArgValue

function RU_ArgValue(flag)

Reads the value after a command-line flag.

ParameterTypeDefaultDescription
flagdynamic—Flag value supplied to `RU_ArgValue`.

View source

RU_ClampScale

inline function RU_ClampScale(v)

Keeps renderer scale inside the supported range.

ParameterTypeDefaultDescription
vdynamic—Value consumed by the operation.

View source

ru_enabled

ru_enabled

Tracks whether ru enabled is active in the r upscaled subsystem.

View source

ru_entries

ru_entries

Stores the ru entries collection used by the r upscaled subsystem.

View source

ru_entry_t struct

RU_FindEntry

function RU_FindEntry(kind, name)

Finds an entry by kind and Doom name.

ParameterTypeDefaultDescription
kinddynamic—Kind value supplied to `RU_FindEntry`.
namedynamic—Resource or object name to resolve.

View source

RU_FindPackagePath

function RU_FindPackagePath(iwadPath)

Resolves explicit or automatic upscaled package path.

ParameterTypeDefaultDescription
iwadPathdynamic—Iwad path value supplied to `RU_FindPackagePath`.

View source

RU_GetFlat

inline function RU_GetFlat(name)

Returns an upscaled flat image entry or void.

ParameterTypeDefaultDescription
namedynamic—Resource or object name to resolve.

View source

RU_GetPatch

inline function RU_GetPatch(name)

Returns an upscaled patch image entry or void.

ParameterTypeDefaultDescription
namedynamic—Resource or object name to resolve.

View source

RU_GetSprite

inline function RU_GetSprite(name)

Returns an upscaled sprite image entry or void.

ParameterTypeDefaultDescription
namedynamic—Resource or object name to resolve.

View source

RU_GetTexture

inline function RU_GetTexture(name)

Returns an upscaled wall texture image entry or void.

ParameterTypeDefaultDescription
namedynamic—Resource or object name to resolve.

View source

RU_Init

function RU_Init(iwadPath)

Initializes optional upscaled graphics support.

ParameterTypeDefaultDescription
iwadPathdynamic—Iwad path value supplied to `RU_Init`.

View source

RU_IsEnabled

inline function RU_IsEnabled()

Returns true when a package is active.

View source

ru_loaded

ru_loaded

Tracks whether ru loaded is active in the r upscaled subsystem.

View source

RU_LoadPackage

function RU_LoadPackage(path)

Loads an upscaled package from disk.

ParameterTypeDefaultDescription
pathdynamic—Filesystem path to process.

View source

RU_MAGIC0

const RU_MAGIC0 = 77

Defines ru magic0 for the r upscaled subsystem.

View source

RU_MAGIC1

const RU_MAGIC1 = 68

Defines ru magic1 for the r upscaled subsystem.

View source

RU_MAGIC2

const RU_MAGIC2 = 85

Defines ru magic2 for the r upscaled subsystem.

View source

RU_MAGIC3

const RU_MAGIC3 = 80

Defines ru magic3 for the r upscaled subsystem.

View source

RU_Name8

function RU_Name8(name)

Normalizes names to Doom's 8-character lump namespace.

ParameterTypeDefaultDescription
namedynamic—Resource or object name to resolve.

View source

RU_ParsePackage

function RU_ParsePackage(data)

Parses MiniDoom upscaled package bytes.

ParameterTypeDefaultDescription
datadynamic—Binary or structured data to process.

View source

RU_ParseScaleFromArgs

function RU_ParseScaleFromArgs()

Initializes the requested physical render scale.

View source

ru_path

ru_path

Stores the mutable ru path text used by the r upscaled subsystem.

View source

RU_ReadS32

inline function RU_ReadS32(b, off)

Reads a little-endian s32 from package bytes.

ParameterTypeDefaultDescription
bdynamic—Second input operand.
offdynamic—Zero-based byte or element offset.

View source

RU_ReadU32

inline function RU_ReadU32(b, off)

Reads a little-endian u32 from package bytes.

ParameterTypeDefaultDescription
bdynamic—Second input operand.
offdynamic—Zero-based byte or element offset.

View source

RU_RendererAllowsHD

inline function RU_RendererAllowsHD()

Returns true when the active renderer may consume HDWAD assets.

View source

RU_RenderScale

inline function RU_RenderScale()

Returns the physical render scale requested for this run.

View source

ru_scale

ru_scale

Tracks the mutable ru scale value used by the r upscaled subsystem.

View source

RU_ToIntOr

function RU_ToIntOr(v, fallback)

Converts a MiniLang value to int with fallback.

ParameterTypeDefaultDescription
vdynamic—Value consumed by the operation.
fallbackdynamic—Value returned when the requested conversion or lookup is unavailable.

View source

RU_ToUpperAscii

function RU_ToUpperAscii(s)

Converts a string to uppercase ASCII for WAD-style names.

ParameterTypeDefaultDescription
sdynamic—S value supplied to `RU_ToUpperAscii`.

View source

RU_TYPE_FLAT

const RU_TYPE_FLAT = 2

Defines ru type flat for the r upscaled subsystem.

View source

RU_TYPE_PATCH

const RU_TYPE_PATCH = 1

Defines ru type patch for the r upscaled subsystem.

View source

RU_TYPE_SPRITE

const RU_TYPE_SPRITE = 4

Defines ru type sprite for the r upscaled subsystem.

View source

RU_TYPE_TEXTURE

const RU_TYPE_TEXTURE = 3

Defines ru type texture for the r upscaled subsystem.

View source

RU_VERSION

const RU_VERSION = 6

Defines ru version for the r upscaled subsystem.

View source