Class Clipboard

A class abstracting the OS clipboad functionality and allowing to set and get data.

Index

Constructors

Methods

getResource getText setResource setSceneObjects setText setTexture

Constructors

constructor

new Clipboard(): Clipboard
Returns Clipboard

Methods

`Static`getResource

getResource(): Resource
Returns a resource handle from the clipboard.

Returns Resource

`Static`getText

getText(): string
Reads a string from the clipboard and returns it. If there is no string in the clipboard it returns an empty string.

Returns string
Note
Both wide and normal strings will be read, but normal strings will be converted to a wide string before returning.

Note
Thread safe.

`Static`setResource

setResource(resource): boolean
Set a resource handle in the clipboard.
Parameters
- resource: Resource | ResourceHandle<Resource>
Returns boolean

`Static`setSceneObjects

setSceneObjects(sceneObjects): void
Set scene objects to the clipboard.
Parameters
- sceneObjects: SceneObject[]
  The scene objects to serialize on the clipboard.
Returns void

`Static`setText

setText(text): void
Set some text to the clipboard.
Parameters
- text: string
Returns void
Note
Thread safe.

`Static`setTexture

setTexture(pixelData): void
Set texture to clipboard.
Parameters
- pixelData: PixelData
  The pixel information to serialize.
Returns void