C# Class Alexandria.Engines.Sciagi.Resources.PictureCanvas

Manages the four rasters of an SCI game.

显示文件 Open project: Burton-Radons/Alexandria Class Usage Examples

Public Methods

Method	Description
Clear ( byte visualValue = 15, byte priorityValue, byte controlValue, byte auxiliaryValue, PictureLayer mask = PictureLayer.All ) : void	Clear all of the layers to their default values (by default), or specific layers with specific values if desired. This locks, then unlocks the bitmaps.
GetRaster ( PictureLayer layer ) : Raster	Get a raster layer.
Lock ( ) : void	Lock all the raster images to start drawing to them.
PictureCanvas ( Picture picture ) : System	Create a new PictureCanvas using the Picture's dimensions, and using the Picture's Palette, if any.
PictureCanvas ( Vector2i resolution, Palette palette = null ) : System	Initialise the canvas.
PictureCanvas ( int width, int height ) : System	Initialise the canvas.
Unlock ( ) : void	Unlock all the raster images, flushing their changes.

Method Details

Clear() public method

Clear all of the layers to their default values (by default), or specific layers with specific values if desired. This locks, then unlocks the bitmaps.

public Clear ( byte visualValue = 15, byte priorityValue, byte controlValue, byte auxiliaryValue, PictureLayer mask = PictureLayer.All ) : void
visualValue	byte	What to clear the visual map to if Layer.Visual is included in mask.
priorityValue	byte	What to clear the priority map to if Layer.Priority is included in mask.
controlValue	byte	What to clear the control map to if Layer.Control is included in mask.
auxiliaryValue	byte	What to clear the auxiliary map to if Layer.Auxiliary is included in mask.
mask	PictureLayer
return	void

GetRaster() public method

Get a raster layer.

public GetRaster ( PictureLayer layer ) : Raster
layer	PictureLayer
return	Raster

Lock() public method

Lock all the raster images to start drawing to them.

public Lock ( ) : void
return	void

PictureCanvas() public method

Create a new PictureCanvas using the Picture's dimensions, and using the Picture's Palette, if any.

public PictureCanvas ( Picture picture ) : System
picture	Picture
return	System

PictureCanvas() public method

Initialise the canvas.

public PictureCanvas ( Vector2i resolution, Palette palette = null ) : System
resolution	Vector2i
palette	Palette
return	System

PictureCanvas() public method

Initialise the canvas.

public PictureCanvas ( int width, int height ) : System
width	int
height	int
return	System

Unlock() public method

Unlock all the raster images, flushing their changes.

public Unlock ( ) : void
return	void