Interface IImage

Represents an image that can be rendered on screen (usually as part of an animation).

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IImage

Properties

Height

Gets the height of the image (in pixels).

Declaration

float Height { get; }

Property Value

Type	Description
System.Single	The height.

ID

Gets the unique ID that represents that image. It will usually be the file path (unless the image is part of a sprite sheet, in that case the file path will not be a unique identifier).

Declaration

string ID { get; }

Property Value

Type	Description
System.String	The identifier.

LoadConfig

Gets the configuration with which the image was loaded.

Declaration

ILoadImageConfig LoadConfig { get; }

Property Value

Type	Description
ILoadImageConfig	The load configuration.

OriginalBitmap

Gets the original bitmap that this image is taken from.

Declaration

IBitmap OriginalBitmap { get; }

Property Value

Type	Description
IBitmap	The original bitmap.

SpriteSheet

If the image is part of a sprite sheet, this will return the sprite sheet data. Otherwise, this will return null.

Declaration

ISpriteSheet SpriteSheet { get; }

Property Value

Type	Description
ISpriteSheet	The sprite sheet.

Texture

Gets the texture.

Declaration

ITexture Texture { get; }

Property Value

Type	Description
ITexture	The texture.

Width

Gets the width of the image (in pixels).

Declaration

float Width { get; }

Property Value

Type	Description
System.Single	The width.