Class Pixmap

Represents an image in memory.

Hierarchy (View Summary)

ScriptObject
- Pixmap

Index

Constructors

Properties

aspectRatioMode height transformationMode width

Methods

crop getTypeName isOfType isSame load resize save

Constructors

constructor

new Pixmap(filename: Path): Pixmap
Constructs a new Pixmap instance for use in UI widgets.
Parameters
- filename: Path
Returns Pixmap
Overrides ScriptObject.constructor

Properties

aspectRatioMode

aspectRatioMode: AspectRatioMode

Controls how the aspect ratio is preserved during resize operations.

height

height: number

Height of the pixmap in pixels.

transformationMode

transformationMode: TransformationMode

Controls the transformation quality mode used when scaling the pixmap.

width

width: number

Width of the pixmap in pixels.

Methods

crop

crop(rect: Rect): void
Crops the pixmap to the specified rectangle.
Parameters
- rect: Rect
Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame

load

load(filename: Path): void
Loads an image from the given file path.
Parameters
- filename: Path
Returns void

resize

resize(width: number, height: number): void
Resizes the pixmap to the specified width and height.
Parameters
- width: number
- height: number
Returns void

save

save(filename: Path, quality?: number): void
Saves the pixmap to the given file path, with optional quality setting.
Parameters
- filename: Path
- Optionalquality: number
Returns void