coastline 0.0.4
Loading...
Searching...
No Matches
coastline::Intro Class Reference

The regional splash screens, drawn with converted models or the Japanese title image. More...

#include <intro.h>

Public Member Functions

 ~Intro ()
 Release splash-screen resources before their renderer is destroyed.
 Intro (const Intro &)=delete
 Prevent copying renderer-bound splash-screen resources.
Intro & operator= (const Intro &)=delete
 Prevent assignment of renderer-bound splash-screen resources.
void Restart ()
 Start the splash screens again from the first logo, fading in.
IntroEnd Update (float seconds, const IntroButtons &buttons)
 Advance the splash screens by a frame.
void Draw (SceneRenderer &renderer) const
 Draw the frame.
void DrawProgress (SceneRenderer &renderer, float width, float height) const
 Draw pack-sequence progress after screen filters, or omit it for regional splash screens.
bool ShowsProgress () const
bool PlayingVideo () const

Static Public Member Functions

static std::unique_ptr< Intro > Load (SceneRenderer &renderer, const std::filesystem::path &release, std::string_view region={}, const std::filesystem::path &assets={}, const nlohmann::json &settings=nlohmann::json::object())
 Read the models, the lights, the fonts, and the sounds of the splash screens.

Detailed Description

The regional splash screens, drawn with converted models or the Japanese title image.

Constructor & Destructor Documentation

◆ ~Intro()

coastline::Intro::~Intro ( )

Release splash-screen resources before their renderer is destroyed.

◆ Intro()

coastline::Intro::Intro ( const Intro & )
delete

Prevent copying renderer-bound splash-screen resources.

Member Function Documentation

◆ Load()

std::unique_ptr< Intro > coastline::Intro::Load ( SceneRenderer & renderer,
const std::filesystem::path & release,
std::string_view region = {},
const std::filesystem::path & assets = {},
const nlohmann::json & settings = nlohmann::json::object() )
static

Read the models, the lights, the fonts, and the sounds of the splash screens.

Parameters
rendererThe renderer that draws them.
releaseThe selected cartridge directory, n64/base of the prepared assets.
regionThe chosen title region, or empty to read converted metadata.
assetsThe prepared asset root for pack-defined sequences, or empty.
settingsThe merged asset-pack settings, or an empty object.
Returns
The splash screens, or nothing with the reason logged.

◆ operator=()

Intro & coastline::Intro::operator= ( const Intro & )
delete

Prevent assignment of renderer-bound splash-screen resources.

◆ Restart()

void coastline::Intro::Restart ( )

Start the splash screens again from the first logo, fading in.

◆ Update()

IntroEnd coastline::Intro::Update ( float seconds,
const IntroButtons & buttons )

Advance the splash screens by a frame.

Parameters
secondsThe nonnegative elapsed frame time, in seconds.
buttonsThe buttons held on the first controller.
Returns
Where the splash screens go, once they have faded out.

◆ Draw()

void coastline::Intro::Draw ( SceneRenderer & renderer) const

Draw the frame.

Parameters
rendererThe renderer of the frame, between Begin() and End().

◆ DrawProgress()

void coastline::Intro::DrawProgress ( SceneRenderer & renderer,
float width,
float height ) const

Draw pack-sequence progress after screen filters, or omit it for regional splash screens.

Parameters
rendererThe overlay renderer, between Begin() and RenderInto().
widthOutput width in pixels.
heightOutput height in pixels.

◆ ShowsProgress()

bool coastline::Intro::ShowsProgress ( ) const
Returns
Whether the current pack-sequence entry displays progress.

◆ PlayingVideo()

bool coastline::Intro::PlayingVideo ( ) const
Returns
Whether a pack movie currently replaces menu music.

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