An ordered asset-pack sequence of images, movies, and static models.
More...
#include <introsequence.h>
|
| | ~IntroSequence () |
| | Release current sequence resources before renderer destruction.
|
| | IntroSequence (const IntroSequence &)=delete |
| | Prevent copying renderer-bound resources.
|
| IntroSequence & | operator= (const IntroSequence &)=delete |
| | Prevent assigning renderer-bound resources.
|
| void | Restart () |
| | Start again at the first available entry.
|
| bool | Update (float seconds, bool skip) |
| | Advance playback and optionally skip the current entry.
|
| void | ControlVideo (bool pause, int seek, bool restart) |
| | Control the current movie without affecting image or model entries.
|
| void | Draw () const |
| | Draw the current entry, preserving image and movie aspect ratios.
|
| void | DrawProgress (SceneRenderer &renderer, float width, float height) const |
| | Draw movie or timed-image progress along the bottom of the output area, fitted to the requested aspect ratio.
|
| bool | ShowsProgress () const |
| bool | PlayingVideo () const |
An ordered asset-pack sequence of images, movies, and static models.
◆ ~IntroSequence()
| coastline::IntroSequence::~IntroSequence |
( |
| ) |
|
Release current sequence resources before renderer destruction.
◆ IntroSequence()
| coastline::IntroSequence::IntroSequence |
( |
const IntroSequence & | | ) |
|
|
delete |
Prevent copying renderer-bound resources.
◆ Load()
Validate a pack sequence and resolve its files relative to prepared assets.
- Parameters
-
| renderer | The renderer used for sequence resources. |
| assets | The prepared, layered asset directory. |
| entries | Up to 64 entry objects with required type and file settings and optional duration, skippable, scale, and depth settings. |
| settings | Asset-pack settings, including optional videoControls preferences. |
- Returns
- The sequence, or null for an invalid definition.
◆ operator=()
Prevent assigning renderer-bound resources.
◆ Restart()
| void coastline::IntroSequence::Restart |
( |
| ) |
|
Start again at the first available entry.
◆ Update()
| bool coastline::IntroSequence::Update |
( |
float | seconds, |
|
|
bool | skip ) |
Advance playback and optionally skip the current entry.
- Parameters
-
| seconds | Elapsed frame time in seconds, clamped to [0, 0.25]; non-finite values are ignored. |
| skip | Whether a skip button was pressed during the frame. |
- Returns
- Whether an entry remains active.
◆ ControlVideo()
| void coastline::IntroSequence::ControlVideo |
( |
bool | pause, |
|
|
int | seek, |
|
|
bool | restart ) |
Control the current movie without affecting image or model entries.
- Parameters
-
| pause | Whether to toggle pause. |
| seek | Seek direction, negative for backward and positive for forward. |
| restart | Whether to restart the movie, taking precedence over seeking. |
◆ Draw()
| void coastline::IntroSequence::Draw |
( |
| ) |
const |
Draw the current entry, preserving image and movie aspect ratios.
◆ DrawProgress()
| void coastline::IntroSequence::DrawProgress |
( |
SceneRenderer & | renderer, |
|
|
float | width, |
|
|
float | height ) const |
Draw movie or timed-image progress along the bottom of the output area, fitted to the requested aspect ratio.
- Parameters
-
| renderer | The overlay renderer, between Begin() and RenderInto(). |
| width | Output width in pixels. |
| height | Output height in pixels; the bar is two pixels high. |
◆ ShowsProgress()
| bool coastline::IntroSequence::ShowsProgress |
( |
| ) |
const |
- Returns
- Whether the active movie or timed image has a progress bar enabled.
◆ PlayingVideo()
| bool coastline::IntroSequence::PlayingVideo |
( |
| ) |
const |
- Returns
- Whether current movie audio replaces menu music.
The documentation for this class was generated from the following file: