akasha

Class OffscreenCanvas

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.OffscreenCanvas

All Implemented Interfaces:

Canvas, CanvasImageSource, TexImageSource, GPUImageCopyExternalImageSource, ImageBitmapSource, Transferable

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="OffscreenCanvas")
public class OffscreenCanvas
extends EventTarget
implements TexImageSource, GPUImageCopyExternalImageSource, Canvas, CanvasImageSource, Transferable

The OffscreenCanvas interface provides a canvas that can be rendered off screen. It is available in both the window and worker contexts.

See Also:

OffscreenCanvas - MDN, (HTML) # the-offscreencanvas-interface

Field Summary

Fields

Modifier and Type	Field and Description
int	height The height property returns and sets the height of an OffscreenCanvas object.
@JsNullable EventHandler	oncontextlost
@JsNullable EventHandler	oncontextrestored
int	width The width property returns and sets the width of an OffscreenCanvas object.

Constructor Summary

Constructors

Constructor and Description
OffscreenCanvas(int width, int height) The OffscreenCanvas() constructor returns a newly instantiated OffscreenCanvas object.

Method Summary

Modifier and Type	Method and Description
void	addContextlostListener(EventListener callback)
void	addContextlostListener(EventListener callback, AddEventListenerOptions options)
void	addContextlostListener(EventListener callback, boolean useCapture)
void	addContextrestoredListener(EventListener callback)
void	addContextrestoredListener(EventListener callback, AddEventListenerOptions options)
void	addContextrestoredListener(EventListener callback, boolean useCapture)
@JsNonNull Promise<Blob>	convertToBlob() The OffscreenCanvas.convertToBlob()method creates a Blob object representing the image contained in the canvas.
@JsNonNull Promise<Blob>	convertToBlob(ImageEncodeOptions options) The OffscreenCanvas.convertToBlob()method creates a Blob object representing the image contained in the canvas.
@JsNullable OffscreenRenderingContext	getContext(java.lang.String contextId) The OffscreenCanvas.getContext() method returns a drawing context for an offscreen canvas, or null if the context identifier is not supported.
@JsNullable OffscreenRenderingContext	getContext(java.lang.String contextId, java.lang.Object options) The OffscreenCanvas.getContext() method returns a drawing context for an offscreen canvas, or null if the context identifier is not supported.
void	removeContextlostListener(EventListener callback)
void	removeContextlostListener(EventListener callback, boolean useCapture)
void	removeContextlostListener(EventListener callback, EventListenerOptions options)
void	removeContextrestoredListener(EventListener callback)
void	removeContextrestoredListener(EventListener callback, boolean useCapture)
void	removeContextrestoredListener(EventListener callback, EventListenerOptions options)
@JsNonNull ImageBitmap	transferToImageBitmap() The OffscreenCanvas.transferToImageBitmap() method creates an ImageBitmap object from the most recently rendered image of the OffscreenCanvas.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

height

public int height

The height property returns and sets the height of an OffscreenCanvas object.

See Also:

OffscreenCanvas.height - MDN, OffscreenCanvas.height - HTML Living Standard

oncontextlost

public @JsNullable EventHandler oncontextlost

oncontextrestored

public @JsNullable EventHandler oncontextrestored

width

public int width

The width property returns and sets the width of an OffscreenCanvas object.

See Also:

OffscreenCanvas.width - MDN, OffscreenCanvas.width - HTML Living Standard

Constructor Detail

OffscreenCanvas

public OffscreenCanvas(int width,
                       int height)

The OffscreenCanvas() constructor returns a newly instantiated OffscreenCanvas object.

See Also:

OffscreenCanvas.OffscreenCanvas - MDN, OffscreenCanvas() - HTML Living Standard

Method Detail

convertToBlob

public @JsNonNull Promise<Blob> convertToBlob(@Nonnull
                                              ImageEncodeOptions options)

The OffscreenCanvas.convertToBlob()method creates a Blob object representing the image contained in the canvas.

See Also:

OffscreenCanvas.convertToBlob - MDN

convertToBlob

public @JsNonNull Promise<Blob> convertToBlob()

The OffscreenCanvas.convertToBlob()method creates a Blob object representing the image contained in the canvas.

See Also:

OffscreenCanvas.convertToBlob - MDN

getContext

public @JsNullable OffscreenRenderingContext getContext(@OffscreenRenderingContextId @Nonnull
                                                        java.lang.String contextId,
                                                        @Nullable
                                                        java.lang.Object options)

The OffscreenCanvas.getContext() method returns a drawing context for an offscreen canvas, or null if the context identifier is not supported.

See Also:

OffscreenCanvas.getContext - MDN, OffscreenCanvas.getContext() - HTML Living Standard

getContext

public @JsNullable OffscreenRenderingContext getContext(@OffscreenRenderingContextId @Nonnull
                                                        java.lang.String contextId)

The OffscreenCanvas.getContext() method returns a drawing context for an offscreen canvas, or null if the context identifier is not supported.

See Also:

OffscreenCanvas.getContext - MDN, OffscreenCanvas.getContext() - HTML Living Standard

transferToImageBitmap

public @JsNonNull ImageBitmap transferToImageBitmap()

The OffscreenCanvas.transferToImageBitmap() method creates an ImageBitmap object from the most recently rendered image of the OffscreenCanvas.

See Also:

OffscreenCanvas.transferToImageBitmap - MDN, OffscreenCanvas.transferToImageBitmap() - HTML Living Standard

addContextrestoredListener

@JsOverlay
public final void addContextrestoredListener(@Nonnull
                                                        EventListener callback,
                                                        @Nonnull
                                                        AddEventListenerOptions options)

addContextrestoredListener

@JsOverlay
public final void addContextrestoredListener(@Nonnull
                                                        EventListener callback,
                                                        boolean useCapture)

addContextrestoredListener

@JsOverlay
public final void addContextrestoredListener(@Nonnull
                                                        EventListener callback)

removeContextrestoredListener

@JsOverlay
public final void removeContextrestoredListener(@Nonnull
                                                           EventListener callback,
                                                           @Nonnull
                                                           EventListenerOptions options)

removeContextrestoredListener

@JsOverlay
public final void removeContextrestoredListener(@Nonnull
                                                           EventListener callback,
                                                           boolean useCapture)

removeContextrestoredListener

@JsOverlay
public final void removeContextrestoredListener(@Nonnull
                                                           EventListener callback)

addContextlostListener

@JsOverlay
public final void addContextlostListener(@Nonnull
                                                    EventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addContextlostListener

@JsOverlay
public final void addContextlostListener(@Nonnull
                                                    EventListener callback,
                                                    boolean useCapture)

addContextlostListener

@JsOverlay
public final void addContextlostListener(@Nonnull
                                                    EventListener callback)

removeContextlostListener

@JsOverlay
public final void removeContextlostListener(@Nonnull
                                                       EventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeContextlostListener

@JsOverlay
public final void removeContextlostListener(@Nonnull
                                                       EventListener callback,
                                                       boolean useCapture)

removeContextlostListener

@JsOverlay
public final void removeContextlostListener(@Nonnull
                                                       EventListener callback)