AgateLib.DisplayLib.ISurface Interface Reference

Public Surface interface. More...

Inheritance diagram for AgateLib.DisplayLib.ISurface:

List of all members.

Public Member Functions
void	Draw (Point destPt)
	Draws the surface at the specified point.
void	Draw (PointF destPt)
	Draws the surface at the specified point.
void	Draw (int destX, int destY)
	Draws the surface at the specified point.
void	Draw (float destX, float destY)
	Draws the surface at the specified point.
void	GetScale (out double width, out double height)
	Gets the current scale values.
void	IncrementRotationAngle (double radians)
	Increases the rotation angle.
void	IncrementRotationAngleDegrees (double degrees)
	Increases the rotation angle.
void	SetScale (double width, double height)
	Sets the width and height scale values simultaneously.
Properties
double	Alpha [get, set]
	Gets or sets the alpha value for the surface. 0.0 is completely transparent and 1.0 is completely opaque.
Color	Color [get, set]
	Gets or sets the color the surface is multiplied by when drawn. Setting this value overwrites the Alpha value.
Gradient	ColorGradient [get, set]
	Gets or sets a color gradient used for this surface.
OriginAlignment	DisplayAlignment [get, set]
	Gets or sets how coordinate arguments to Draw overloads are interpreted.
int	DisplayHeight [get, set]
	Gets or sets the display height of the surface, in pixels.
Size	DisplaySize [get, set]
	Gets or sets the display size of the surface, in pixels.
int	DisplayWidth [get, set]
	Gets or sets the display width of the surface, in pixels.
double	RotationAngle [get, set]
	The amount the surface is rotated when drawn. The angle is measured up from the horizontal axis.
double	RotationAngleDegrees [get, set]
	The amount the surface is rotated when drawn. The angle is measured up from the horizontal axis.
OriginAlignment	RotationCenter [get, set]
	The point where the surface is rotated around when drawn.
double	ScaleHeight [get, set]
	The amount the height of the surface is scaled when drawn. 1.0 is no scaling.
double	ScaleWidth [get, set]
	The amount the width of the surface is scaled when drawn. 1.0 is no scaling.
int	SurfaceHeight [get]
	Gets the height of the surface data in pixels.
Size	SurfaceSize [get]
	Gets the size of the surface data in pixels.
int	SurfaceWidth [get]
	Gets the width of the surface data in pixels.

---

Detailed Description

Public Surface interface.

---

Member Function Documentation

void AgateLib.DisplayLib.ISurface.Draw	(	float	destX,
		float	destY
	)

Draws the surface at the specified point.

Parameters:

	destX
	destY

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.Draw	(	int	destX,
		int	destY
	)

Draws the surface at the specified point.

Parameters:

	destX
	destY

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.Draw

(

PointF

destPt

)

Draws the surface at the specified point.

Parameters:

destPt

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.Draw

(

Point

destPt

)

Draws the surface at the specified point.

Parameters:

destPt

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.GetScale	(	out double	width,
		out double	height
	)

Gets the current scale values.

Parameters:

	width
	height

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.IncrementRotationAngle

(

double

radians

)

Increases the rotation angle.

Parameters:

radians

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.IncrementRotationAngleDegrees

(

double

degrees

)

Increases the rotation angle.

Parameters:

degrees

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISurface.SetScale	(	double	width,
		double	height
	)

Sets the width and height scale values simultaneously.

Parameters:

	width
	height

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

---

Property Documentation

double AgateLib.DisplayLib.ISurface.Alpha [get, set]

Gets or sets the alpha value for the surface. 0.0 is completely transparent and 1.0 is completely opaque.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

Color AgateLib.DisplayLib.ISurface.Color [get, set]

Gets or sets the color the surface is multiplied by when drawn. Setting this value overwrites the Alpha value.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

Gradient AgateLib.DisplayLib.ISurface.ColorGradient [get, set]

Gets or sets a color gradient used for this surface.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

OriginAlignment AgateLib.DisplayLib.ISurface.DisplayAlignment [get, set]

Gets or sets how coordinate arguments to Draw overloads are interpreted.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISurface.DisplayHeight [get, set]

Gets or sets the display height of the surface, in pixels.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

Size AgateLib.DisplayLib.ISurface.DisplaySize [get, set]

Gets or sets the display size of the surface, in pixels.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISurface.DisplayWidth [get, set]

Gets or sets the display width of the surface, in pixels.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

double AgateLib.DisplayLib.ISurface.RotationAngle [get, set]

The amount the surface is rotated when drawn. The angle is measured up from the horizontal axis.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

double AgateLib.DisplayLib.ISurface.RotationAngleDegrees [get, set]

The amount the surface is rotated when drawn. The angle is measured up from the horizontal axis.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

OriginAlignment AgateLib.DisplayLib.ISurface.RotationCenter [get, set]

The point where the surface is rotated around when drawn.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

double AgateLib.DisplayLib.ISurface.ScaleHeight [get, set]

The amount the height of the surface is scaled when drawn. 1.0 is no scaling.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

double AgateLib.DisplayLib.ISurface.ScaleWidth [get, set]

The amount the width of the surface is scaled when drawn. 1.0 is no scaling.

Implemented in AgateLib.DisplayLib.Surface, and AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISurface.SurfaceHeight [get]

Gets the height of the surface data in pixels.

Implemented in AgateLib.DisplayLib.Surface.

Size AgateLib.DisplayLib.ISurface.SurfaceSize [get]

Gets the size of the surface data in pixels.

Implemented in AgateLib.DisplayLib.Surface.

int AgateLib.DisplayLib.ISurface.SurfaceWidth [get]

Gets the width of the surface data in pixels.

Implemented in AgateLib.DisplayLib.Surface.

---

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

• DisplayLib/ISurface.cs