Class Image

Represents a JPEG or PNG image instance.

Hierarchy (View Summary)

ObjectBase
- Image

Index

Accessors

height id om opaque type width

Methods

load free rebind save toBitmap

Accessors

height

get height(): number
Gets the height of the image, in pixels.

Returns number

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

opaque

get opaque(): boolean
Gets the value indicating if the image is opaque.

Returns boolean

type

get type(): ImageType
Gets the type of the image, such as JPEG or PNG.

Returns ImageType

width

get width(): number
Gets the width of the image, in pixels.

Returns number

Methods

`Static`load

load(imageBytes: Uint8Array): Image
Creates an Image from the byte array with JPEG or PNG encoded image data.
Parameters
- imageBytes: Uint8Array
  The binary data of the image.
Returns Image
A new instance of the Image.
load(om: ObjectManager, imageBytes: Uint8Array): Image
Creates an Image from the byte array with JPEG or PNG encoded image data.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Image object.
- imageBytes: Uint8Array
  The binary data of the image.
Returns Image
A new instance of the Image.

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

save

save(): Uint8Array
Saves the Image as a byte array with PNG or JPEG-encoded image data.

Returns Uint8Array
A byte array with image data.

toBitmap

toBitmap(): Bitmap
Creates a Bitmap instance from the current Image.

Returns Bitmap
A new instance of Bitmap with image data.