ScummVM API documentation
Sci::PlaneScroll Struct Reference

#include <transitions32.h>

Public Attributes

reg_t plane
 
int16 x
 
int16 y
 
int16 deltaX
 
int16 deltaY
 
GuiResourceId newPictureId
 
GuiResourceId oldPictureId
 
bool animate
 
uint32 startTick
 

Detailed Description

PlaneScroll describes a transition between two different pictures within a single plane.

Member Data Documentation

◆ plane

reg_t Sci::PlaneScroll::plane

The ID of the plane to be scrolled.

◆ x

int16 Sci::PlaneScroll::x

The current position of the scroll.

◆ deltaX

int16 Sci::PlaneScroll::deltaX

The distance that should be scrolled. Only one of deltaX or deltaY may be set.

◆ newPictureId

GuiResourceId Sci::PlaneScroll::newPictureId

The pic that should be created and scrolled into view inside the plane.

◆ oldPictureId

GuiResourceId Sci::PlaneScroll::oldPictureId

The picture that should be scrolled out of view and deleted from the plane.

◆ animate

bool Sci::PlaneScroll::animate

If true, GfxTransitions32 will yield back to the main game loop after calculating the next frame. Otherwise, GfxTransitions32 takes exclusive control over the game loop until the transition has completed.

◆ startTick

uint32 Sci::PlaneScroll::startTick

The tick after which the animation will start.


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