resonance 1.0.1
Loading...
Searching...
No Matches
HudScreenFlash Class Reference

Full-screen fade of the head-up display. More...

#include <hudscreenflash.h>

Public Member Functions

 HudScreenFlash ()
 Resolve the rectangle and show it fully opaque.
void Start (float flDuration, int nFadeIn)
 Start a fade.
void SetFrame ()
 Set the rectangle's alpha for the current time and show it.

Detailed Description

Full-screen fade of the head-up display.

The class is not polymorphic and emits no RTTI. No descriptor, tag, or file path identifies it, and its name is inferred from HUD screen rect, the one object it resolves. The head-up display panel embeds one at +0x40.

The fade is a black rectangle over the whole screen whose vertex alpha runs between 0 and 1 over a duration, timed by the free-running clock rather than by the song position.

Constructor & Destructor Documentation

◆ HudScreenFlash()

HudScreenFlash::HudScreenFlash ( )

Resolve the rectangle and show it fully opaque.

Ghidra address:
NTSC-U/C: 0x0041b150
Ghidra address:
PAL: 0x00455a88

Member Function Documentation

◆ Start()

void HudScreenFlash::Start ( float flDuration,
int nFadeIn )

Start a fade.

A duration below 1 is raised to 1. Overlay's FadeGameMsg handler is the caller. The title is inferred.

Parameters
flDurationThe time the fade takes, in milliseconds.
nFadeInNon-zero to fade from opaque to clear, and zero to fade from clear to opaque.
Ghidra address:
NTSC-U/C: 0x0042a548
Ghidra address:
PAL: 0x00465898

◆ SetFrame()

void HudScreenFlash::SetFrame ( )

Set the rectangle's alpha for the current time and show it.

Does nothing before the fade starts. Once the fade has run its duration, the alpha stays at its end value and the fade is marked finished.

Ghidra address:
NTSC-U/C: 0x0041b2a0
Ghidra address:
PAL: 0x00455bf8

The documentation for this class was generated from the following file: