ScreenFade Struct Reference

Fades the whole screen to black and back with a subtractive rectangle. More...

#include <engine/gfx.h>

Data Fields
s32	id
s32	key1
s32	key2
s32	state
s32	substate
s32	step
s32	counter
s32	paused
s32	childCount
void *	children
void(*	setState )(struct ScreenFade *task, s32 state)
void(*	setSubstate )(struct ScreenFade *task, s32 substate)
void(*	setStep )(struct ScreenFade *task, s32 step)
void(*	setCounter )(struct ScreenFade *task, s32 counter)
void(*	nextState )(struct ScreenFade *task)
void(*	nextSubstate )(struct ScreenFade *task)
void(*	nextStep )(struct ScreenFade *task)
void(*	tickCounter )(struct ScreenFade *task)
void(*	update )()
void(*	destroy )(struct ScreenFade *task)
s32	layerId
s32	depth
s32	fadeIn
	0: to black
s32	level
	0-FADE_LEVEL_MAX
s32	levelStep
void(*	start )(struct ScreenFade *fade, s32 fadeIn, s32 frames)
	TASK_DONE when done.

Detailed Description

Fades the whole screen to black and back with a subtractive rectangle.

Definition at line 361 of file gfx.h.

Field Documentation

id

s32 ScreenFade::id

Definition at line 362 of file gfx.h.

key1

s32 ScreenFade::key1

Definition at line 362 of file gfx.h.

key2

s32 ScreenFade::key2

Definition at line 362 of file gfx.h.

state

s32 ScreenFade::state

Definition at line 362 of file gfx.h.

Referenced by FIGHTSTG_updateFader(), STCRDABM_runAlbum(), STCRDDEK_stepScreen(), STCRDSHP_runShop(), STDGNAME_stepScreen(), STFGTREP_runReport(), STGDGLAB_runLab(), STGMCARD_updateScreen(), STGTRAIN_runScreen(), STITSHOP_runShop(), STSTATUS_runCardScreen(), updateInnMenu(), updateScreenFade(), and warpAway().

substate

s32 ScreenFade::substate

Definition at line 362 of file gfx.h.

Referenced by FIGHTSTG_updateFader(), screenFadeStart(), and updateScreenFade().

step

s32 ScreenFade::step

Definition at line 362 of file gfx.h.

counter

s32 ScreenFade::counter

Definition at line 362 of file gfx.h.

paused

s32 ScreenFade::paused

Definition at line 362 of file gfx.h.

childCount

s32 ScreenFade::childCount

Definition at line 362 of file gfx.h.

children

void* ScreenFade::children

Definition at line 362 of file gfx.h.

setState

void(* ScreenFade::setState) (struct ScreenFade *task, s32 state)

Definition at line 362 of file gfx.h.

Referenced by screenFadeStart().

setSubstate

void(* ScreenFade::setSubstate) (struct ScreenFade *task, s32 substate)

Definition at line 362 of file gfx.h.

setStep

void(* ScreenFade::setStep) (struct ScreenFade *task, s32 step)

Definition at line 362 of file gfx.h.

setCounter

void(* ScreenFade::setCounter) (struct ScreenFade *task, s32 counter)

Definition at line 362 of file gfx.h.

nextState

void(* ScreenFade::nextState) (struct ScreenFade *task)

Definition at line 362 of file gfx.h.

Referenced by updateScreenFade().

nextSubstate

void(* ScreenFade::nextSubstate) (struct ScreenFade *task)

Definition at line 362 of file gfx.h.

nextStep

void(* ScreenFade::nextStep) (struct ScreenFade *task)

Definition at line 362 of file gfx.h.

tickCounter

void(* ScreenFade::tickCounter) (struct ScreenFade *task)

Definition at line 362 of file gfx.h.

update

void(* ScreenFade::update) ()

Definition at line 362 of file gfx.h.

destroy

void(* ScreenFade::destroy) (struct ScreenFade *task)

Definition at line 362 of file gfx.h.

layerId

s32 ScreenFade::layerId

Definition at line 363 of file gfx.h.

Referenced by createFader(), createScreenFade(), drawScreenFade(), and FIGHTSTG_createFader().

depth

s32 ScreenFade::depth

Definition at line 364 of file gfx.h.

Referenced by createFader(), createScreenFade(), drawScreenFade(), FIGHTSTG_createFader(), and STCRDSHP_closeOptions().

fadeIn

s32 ScreenFade::fadeIn

0: to black

Definition at line 365 of file gfx.h.

Referenced by FIGHTSTG_updateFader(), screenFadeStart(), and updateScreenFade().

level

s32 ScreenFade::level

0-FADE_LEVEL_MAX

Definition at line 366 of file gfx.h.

Referenced by drawScreenFade(), FIGHTSTG_updateFader(), screenFadeStart(), and updateScreenFade().

levelStep

s32 ScreenFade::levelStep

Definition at line 367 of file gfx.h.

Referenced by FIGHTSTG_updateFader(), screenFadeStart(), and updateScreenFade().

start

void(* ScreenFade::start) (struct ScreenFade *fade, s32 fadeIn, s32 frames)

TASK_DONE when done.

Definition at line 368 of file gfx.h.

Referenced by createFader(), createScreenFade(), FIGHTSTG_createFader(), startFadeOut(), STCRDABM_browseAlbum(), STCRDDEK_stepScreen(), STCRDSHP_closeOptions(), STCRDSHP_runShop(), STDGNAME_fadeOutScreen(), STGDGLAB_fadeOutLab(), STGMCARD_updateScreen(), STGTRAIN_startLeaving(), STITSHOP_runShop(), STSTATUS_runCardScreen(), updateInnMenu(), warpAway(), and WFIGHTMN_endBattle().

---

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

• include/engine/gfx.h