ScummVM API documentation
Hollywood::SceneLayerStack Class Reference

#include <animation_layers.h>

Public Member Functions

void clear ()
 
template<uint size>
void configure (const SceneLayerSpec(&specs)[size])
 
void configureLayer (uint id, const SceneLayerSpec &spec)
 
void configureLayer (uint id, SceneAnimationStratum stratum, uint chunkIndex, uint16 descriptorCount, const byte *frameMap, uint frameMapSize, bool visible=true, byte initialFrame=0)
 
uint addLayer (SceneAnimationStratum stratum, uint chunkIndex, uint16 descriptorCount, const byte *frameMap, uint frameMapSize, bool visible=true, byte initialFrame=0)
 
void setLayerResource (uint id, uint chunkIndex, uint16 descriptorCount, const byte *frameMap, uint frameMapSize)
 
void reset ()
 
uint layerCount () const
 
bool hasLayer (uint id) const
 
bool isInStratum (uint id, SceneAnimationStratum stratum) const
 
void setLayerStratum (uint id, SceneAnimationStratum stratum)
 
bool hasVisibleLayers (SceneAnimationStratum stratum) const
 
ResourceSpriteLayer & layer (uint id)
 
const ResourceSpriteLayer & layer (uint id) const
 
void setLayerVisible (uint id, bool visible)
 
void setLayerChunk (uint id, uint chunkIndex)
 
void setLayerFrameMap (uint id, const byte *frameMap, uint frameMapSize)
 
void setLayerFrame (uint id, byte frameIndex)
 
void resetLayer (uint id, byte frameIndex)
 
void showLayerAtFrame (uint id, byte frameIndex)
 
bool advanceLayerFrame (uint id, byte lastFrame)
 
void setVisibleLayerFrame (uint id, byte frameIndex)
 
void setVisibleLayerFrameClamped (uint id, uint frameIndex)
 
byte layerFrame (uint id) const
 
bool layerVisible (uint id) const
 
uint maximumVisibleFrameCount () const
 

Static Public Attributes

static constexpr uint kInvalidLayer = 0xffffffff
 

Detailed Description

Stores ordered resource-layer state for a scene composite.

Specification order assigns layer IDs and draw order within a stratum. Most layers have a fixed actor-relative stratum; scene-placed layers are drawn by custom composites at the point required by the current scene mode.


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