ScummVM API documentation
Hollywood::PresentationScene Class Reference
Inheritance diagram for Hollywood::PresentationScene:
Hollywood::SceneAnimationPlayerDelegate Hollywood::ChapterIntroScene Hollywood::Scene3110 Hollywood::Scene5130 Hollywood::Scene9000 Hollywood::Scene9010 Hollywood::Scene9030 Hollywood::Scene9050 Hollywood::Scene9090 Hollywood::Scene9100 Hollywood::Scene9110 Hollywood::Scene9120 Hollywood::Scene9130 Hollywood::Scene9140 Hollywood::Scene9150 Hollywood::Scene9160 Hollywood::Scene9170 Hollywood::Scene9180

Classes

class  TimedPresentationLoop
 

Protected Member Functions

 PresentationScene (HollywoodEngine *vm, const char *debugName, uint32 sceneFramebufferSize=kSceneBufferByteCount, uint32 savedFramebufferSize=kSceneBufferByteCount)
 
virtual void stopAudio ()
 
virtual void drawFrameOverlays ()
 
virtual uint presentRowOffset () const
 
virtual uint presentXOffset () const
 
virtual int subtitleViewportYOffset () const
 
bool animationPlaybackShouldStop () const override
 
void presentAnimationFrame () override
 
bool waitForAnimationFrame (uint32 millis, bool allowSkip) override
 
bool showAnchoredSubtitle (const Common::String &text, byte colorIndex, int centerX, int anchorBottomY, SpeechOverlayWrapStyle wrapStyle=kSpeechOverlayAdaptiveWrap)
 
bool showAnchoredSubtitle (SpeechOverlay &overlay, const Common::String &text, byte colorIndex, int centerX, int anchorBottomY, SpeechOverlayWrapStyle wrapStyle=kSpeechOverlayAdaptiveWrap)
 
bool showPositionedSubtitle (const Common::String &text, byte colorIndex, int centerX, int topY, SpeechOverlayWrapStyle wrapStyle=kSpeechOverlayAdaptiveWrap)
 
bool showPositionedSubtitle (SpeechOverlay &overlay, const Common::String &text, byte colorIndex, int centerX, int topY, SpeechOverlayWrapStyle wrapStyle=kSpeechOverlayAdaptiveWrap)
 
void clearSubtitle ()
 
void clearSubtitle (SpeechOverlay &overlay)
 
bool loadFixedChunk (uint index, Common::Array< byte > &destination, uint fixedSize)
 
bool loadFixedChunk (uint index, IndexedSurfaceBuffer &destination, uint fixedSize)
 
bool loadVariableChunk (uint index, Common::Array< byte > &destination)
 
bool loadChunkTo (uint index, Common::Array< byte > &destination, uint32 destinationOffset)
 
bool loadArenaChunk (uint index)
 
bool loadArenaChunk (uint archiveIndex, uint localChunkIndex)
 
bool loadArenaChunkAlias (uint sourceIndex, uint aliasIndex, uint targetIndex)
 
void drawResourceSpriteLayer (const ResourceSpriteLayer &layer)
 
void drawLayerStack (SceneAnimationStratum stratum)
 
void presentFrame ()
 
void presentFrame (uint rowOffset, uint xOffset)
 
virtual bool pollEvents (bool allowSkip=true)
 
bool delay (uint32 millis, bool allowSkip=true)
 
bool consumeStepAdvanceRequest ()
 
bool revealSavedFramebufferWithCurtain (byte bandWidth=0x14)
 
bool clearSceneFramebufferWithCurtain (byte bandWidth=0x14)
 
void revealSavedFramebufferBand (uint sweepOffset, byte bandWidth, uint xOffset=0)
 
void clearSceneFramebufferBand (uint sweepOffset, byte bandWidth)
 
void copySavedFramebufferRun (int y, int x, int width)
 
void clearSceneFramebufferRun (int y, int x, int width)
 

Protected Attributes

HollywoodEngine * _vm
 
const char * _debugName
 
SceneResources _resources
 
SceneLayerStack _sceneLayers
 
RealtimeAnimationTracks _realtimeAnimationTracks
 
SceneAnimationPlayer _animationPlayer
 
Common::Array< byte > _paletteCurrent
 
IndexedSurfaceBuffer _sceneFramebuffer
 
IndexedSurfaceBuffer _savedFramebuffer
 
Graphics::ManagedSurface _screen
 
Palette6Bit _displayPalette
 
SpeechOverlay _subtitle
 
bool _skipRequested
 
bool _stepAdvanceRequested
 

Additional Inherited Members

- Public Member Functions inherited from Hollywood::SceneAnimationPlayerDelegate
virtual bool animationPlaybackShouldStop () const =0
 
virtual void presentAnimationFrame ()=0
 
virtual bool waitForAnimationFrame (uint32 millis, bool allowSkip)=0
 
virtual bool consumeAnimationFastForwardRequest ()
 
virtual void handleAnimationFrameEvent (const AnimationFrameEvent &event, uint frame)
 
virtual void handleAnimationFrameHook (byte hookId, uint frame)
 

Member Function Documentation

◆ animationPlaybackShouldStop()

bool Hollywood::PresentationScene::animationPlaybackShouldStop ( ) const
overrideprotectedvirtual

◆ presentAnimationFrame()

void Hollywood::PresentationScene::presentAnimationFrame ( )
overrideprotectedvirtual

◆ waitForAnimationFrame()

bool Hollywood::PresentationScene::waitForAnimationFrame ( uint32  millis,
bool  allowSkip 
)
overrideprotectedvirtual

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