ScummVM API documentation
Sci::PalCycler Struct Reference

#include <palette32.h>

Public Attributes

uint8 fromColor
 
uint16 numColorsToCycle
 
uint8 currentCycle
 
PalCyclerDirection direction
 
uint32 lastUpdateTick
 
int16 delay
 
uint16 numTimesPaused
 

Detailed Description

PalCycler represents a range of palette entries that are rotated on a timer.

Member Data Documentation

◆ fromColor

uint8 Sci::PalCycler::fromColor

The color index of this palette cycler. This value is used as the unique key for this PalCycler object.

◆ numColorsToCycle

uint16 Sci::PalCycler::numColorsToCycle

The number of palette slots which are to be cycled by this cycler.

◆ currentCycle

uint8 Sci::PalCycler::currentCycle

The current position of the first palette entry.

◆ direction

PalCyclerDirection Sci::PalCycler::direction

The direction of the cycler.

◆ lastUpdateTick

uint32 Sci::PalCycler::lastUpdateTick

The last tick the cycler cycled.

◆ delay

int16 Sci::PalCycler::delay

The amount of time in ticks each cycle should take to complete. In other words, the higher the delay, the slower the cycle animation. If delay is 0, the cycler does not automatically cycle and needs to be cycled manually by calling doCycle.

◆ numTimesPaused

uint16 Sci::PalCycler::numTimesPaused

The number of times this cycler has been paused.


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