TwinE::Screens Class Reference

Public Member Functions
	Screens (TwinEEngine *engine)
int32	mapLba2Palette (int32 palIndex)
bool	adelineLogo ()
void	loadCustomPalette (const TwineResource &resource)
void	loadMenuImage (bool fadeIn=true)
void	loadImage (TwineImage image, bool fadeIn=true)
bool	loadImageDelay (TwineImage image, int32 seconds)
bool	loadBitmapDelay (const char *image, int32 seconds)
void	fadePalToPal (const Graphics::Palette &pal1, const Graphics::Palette &pal2)
void	fadeToBlack (const Graphics::Palette &palette)
void	fadeWhiteToPal (const Graphics::Palette &ptrpal)
void	fadeToPal (const Graphics::Palette &palette)
void	whiteFade ()
void	setBlackPal ()
void	fadeToRed (const Graphics::Palette &palette)
void	fadeRedToPal (const Graphics::Palette &palette)
void	copyScreen (const Graphics::ManagedSurface &source, Graphics::ManagedSurface &destination)
void	clearScreen ()
void	initPalettes ()

Public Attributes
Graphics::Palette	_ptrPal {0}
Graphics::Palette	_palettePcx {0}
bool	_flagBlackPal = false
bool	_flagFade = false
bool	_flagPalettePcx = false

Member Function Documentation

adelineLogo()

bool TwinE::Screens::adelineLogo

(

)

Load and display Adeline Logo

loadCustomPalette()

void TwinE::Screens::loadCustomPalette

(

const TwineResource &

resource

)

Load a custom palette

Parameters

index

RESS.HQR entry index (starting from 0)

loadMenuImage()

void TwinE::Screens::loadMenuImage

(

bool

fadeIn = true

)

Load and display Main Menu image

loadImage()

void TwinE::Screens::loadImage	(	TwineImage	image,
		bool	fadeIn = true
	)

Load and display a particularly image on RESS.HQR file with cross fade effect

Parameters

index	RESS.HQR entry index (starting from 0)
paletteIndex	RESS.HQR entry index of the palette for the given image. This is often the index + 1
fadeIn	if we fade in before using the palette

loadImageDelay()

bool TwinE::Screens::loadImageDelay	(	TwineImage	image,
		int32	seconds
	)

Load and display a particularly image on RESS.HQR file with cross fade effect and delay

Parameters

index	RESS.HQR entry index (starting from 0)
paletteIndex	RESS.HQR entry index of the palette for the given image. This is often the index + 1
seconds	number of seconds to delay

Returns

true if aborted

fadePalToPal()

void TwinE::Screens::fadePalToPal	(	const Graphics::Palette &	pal1,
		const Graphics::Palette &	pal2
	)

Adjust between two palettes

Parameters

pal1	palette from adjust
pal2	palette to adjust

fadeToBlack()

void TwinE::Screens::fadeToBlack

(

const Graphics::Palette &

palette

)

Fade image to black

Parameters

palette

current palette to fade

fadeToPal()

void TwinE::Screens::fadeToPal

(

const Graphics::Palette &

palette

)

Fade image with another palette source

Parameters

palette

current palette to fade

whiteFade()

void TwinE::Screens::whiteFade

(

)

Fade black palette to white palette

setBlackPal()

void TwinE::Screens::setBlackPal

(

)

Resets both in-game and sdl palettes

fadeToRed()

void TwinE::Screens::fadeToRed

(

const Graphics::Palette &

palette

)

Fade palette to red palette

Parameters

palette

current palette to fade

fadeRedToPal()

void TwinE::Screens::fadeRedToPal

(

const Graphics::Palette &

palette

)

Fade red to palette

Parameters

palette

current palette to fade

copyScreen()

void TwinE::Screens::copyScreen	(	const Graphics::ManagedSurface &	source,
		Graphics::ManagedSurface &	destination
	)

Copy a determinate screen buffer to another

Parameters

source	screen buffer
destination	screen buffer

clearScreen()

void TwinE::Screens::clearScreen

(

)

Clear front buffer screen

initPalettes()

void TwinE::Screens::initPalettes

(

)

Init palettes

Member Data Documentation

_ptrPal

Graphics::Palette TwinE::Screens::_ptrPal {0}

main palette

_flagBlackPal

bool TwinE::Screens::_flagBlackPal = false

flag to check in the game palette was changed

_flagFade

bool TwinE::Screens::_flagFade = false

flag to check if the main flag is locked

_flagPalettePcx

bool TwinE::Screens::_flagPalettePcx = false

flag to check if we are using a different palette than the main one

---

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

• engines/twine/renderer/screens.h