Class RenderWebGL

Hierarchy (View Summary)

EventEmitter<ScratchRenderEventMap>
- RenderWebGL

Index

Constructors

Accessors

Methods

_addToDrawList _candidatesBounds _candidatesTouching _createGeometry _doExitDrawRegion _drawThese _endIndexForKnownLayerGroup _enterDrawBackground _exitDrawBackground _getConvexHullPointsForDrawable _getMaxPixelsForCPU _isTouchingColorGpuFin _isTouchingColorGpuStart _reskin _setNativeSize _touchingBounds _updateOffsets _updateOverlays _updateRenderQuality addListener addOverlay canHazPixels clientSpaceToScratchBounds createBitmapSkin createDrawable createPenSkin createSVGSkin createTextSkin createTextWrapper destroyDrawable destroySkin draw drawableTouching emit enterDrawRegion extractColor extractDrawableScreenSpace getBounds getBoundsForBubble getCurrentSkinSize getDrawableOrder getFencedPositionOfDrawable getNativeSize getSkinRotationCenter getSkinSize isTouchingColor isTouchingDrawables listeners markDrawableAsNoninteractive markSkinAsPrivate off on once onNativeSizeChanged penClear penLine penPoint penStamp pick removeListener removeOverlay requestSnapshot resize sampleColor4b setBackgroundColor setCustomFonts setDebugCanvas setDrawableOrder setLayerGroupOrdering setMaxTextureDimension setPrivateSkinAccess setStageSize setUseGpuMode setUseHighQualityRender skinWasAltered updateBitmapSkin updateDrawableDirection updateDrawableDirectionScale updateDrawableEffect updateDrawablePosition updateDrawableProperties updateDrawableScale updateDrawableSkinId updateDrawableVisible updateSVGSkin updateTextSkin _getContext isSupported

Constructors

constructor

new RenderWebGL(
    canvas: HTMLCanvasElement,
    xLeft?: number,
    xRight?: number,
    yBottom?: number,
    yTop?: number,
): RenderWebGL
Parameters
- canvas: HTMLCanvasElement
- OptionalxLeft: number
- OptionalxRight: number
- OptionalyBottom: number
- OptionalyTop: number
Returns RenderWebGL
Overrides EventEmitter.constructor
- Defined in types/scratch-render.d.ts:557

Properties

_allDrawables

_allDrawables: Drawable[]

_allSkins

_allSkins: Skin[]

_backgroundColor3b

_backgroundColor3b: [number, number, number]

RGB from 0-255

_backgroundColor4f

_backgroundColor4f: [number, number, number, number]

RGBA from 0-1

_backgroundDrawRegionId

_backgroundDrawRegionId: DrawingRegion

_bufferInfo

_bufferInfo: BufferInfo

_customFontStyles

_customFontStyles: HTMLStyleElement | null

`Optional`_debugCanvas

_debugCanvas?: HTMLCanvasElement

_drawList

_drawList: number[]

_exitRegion

_exitRegion: Function | null

_gl

_gl: AnyWebGLContext

_groupOrdering

_groupOrdering: string[]

_layerGroups

_layerGroups: Record<LayerGroup, { drawListOffset: number; groupIndex: number }>

_nativeSize

_nativeSize: [number, number]

_nextDrawableId

_nextDrawableId: number

_nextSkinId

_nextSkinId: number

_overlays

_overlays: Overlay[]

_penSkinId

_penSkinId: number | null

_projection

_projection: M4

_regionId

_regionId: unknown

_shaderManager

_shaderManager: ShaderManager

_snapshotCallbacks

_snapshotCallbacks: ((dataURL: string) => void)[]

_useGpuMode

_useGpuMode: UseGpuModes

_xLeft

_xLeft: number

_xRight

_xRight: number

_yBottom

_yBottom: number

_yTop

_yTop: number

allowPrivateSkinAccess

allowPrivateSkinAccess: boolean

Whether projects should be able to access the contents of private skins such as webcams. If set to false, routines such as isTouchingColor will ignore private skins. Private skins will still be rendered on the canvas regardless of this setting.

customFonts

customFonts: Record<string, string>

dirty

dirty: boolean

exports

exports: {
    BitmapSkin: new (id: number, renderer: RenderWebGL) => BitmapSkin;
    CanvasMeasurementProvider: new (
        ctx: CanvasRenderingContext2D,
    ) => CanvasMeasurementProvider;
    Drawable: new (id: number, renderer: RenderWebGL) => Drawable;
    EffectTransform: {
        transformColor(
            drawable: Drawable,
            inOutColor: Uint8ClampedArray,
            effectMask?: number,
        ): Uint8ClampedArray;
        transformPoint(drawable: Drawable, vec: V3, dst: V3): V3;
    };
    PenSkin: new (id: number, renderer: RenderWebGL) => PenSkin;
    Skin: new (id: number, renderer: RenderWebGL) => Skin;
    SVGSkin: new (id: number, renderer: RenderWebGL) => SVGSkin;
    TextBubbleSkin: new (id: number, renderer: RenderWebGL) => TextBubbleSkin;
    twgl: twgl;
}

maxTextureDimension

maxTextureDimension: number

Suggested maximum texture size in texels. This is not a hard limit.

offscreenTouching

offscreenTouching: boolean

overlayContainer

overlayContainer: HTMLElement

Element that contains all overlays.

useHighQualityRender

useHighQualityRender: boolean

aka high quality pen.

`Static`powerPreference

powerPreference: WebGLPowerPreference

Accessors

_visibleDrawList

get _visibleDrawList(): number[]
Returns number[]
- Defined in types/scratch-render.d.ts:596

canvas

get canvas(): HTMLCanvasElement
Returns HTMLCanvasElement
- Defined in types/scratch-render.d.ts:559

gl

get gl(): AnyWebGLContext
Returns AnyWebGLContext
- Defined in types/scratch-render.d.ts:561

Methods

_addToDrawList

_addToDrawList(drawableID: number, group: string): void
Parameters
- drawableID: number
- group: string
Returns void
- Defined in types/scratch-render.d.ts:594

_candidatesBounds

_candidatesBounds(
    candidates: {
        drawable: Drawable;
        id: number;
        intersection: RenderWebGL.Rectangle;
    }[],
): RenderWebGL.Rectangle
Parameters
- candidates: { drawable: Drawable; id: number; intersection: RenderWebGL.Rectangle }[]
Returns RenderWebGL.Rectangle
- Defined in types/scratch-render.d.ts:752

_candidatesTouching

_candidatesTouching(
drawableId: number,
candidateIds: number[],
): { drawable: Drawable; id: number; intersection: RenderWebGL.Rectangle }[]
Parameters
- drawableId: number
- candidateIds: number[]
Returns { drawable: Drawable; id: number; intersection: RenderWebGL.Rectangle }[]
- Defined in types/scratch-render.d.ts:746

_createGeometry

_createGeometry(): void
Returns void
- Defined in types/scratch-render.d.ts:829

_doExitDrawRegion

_doExitDrawRegion(): void
Returns void
- Defined in types/scratch-render.d.ts:794

_drawThese

_drawThese(
    drawableIds: number[],
    drawMode: DrawMode,
    projection: M4,
    opts?: {
        effectMask?: number;
        extraUniforms?: object;
        filter?: (drawableId: number) => boolean;
        framebufferHeight?: number;
        framebufferWidth?: number;
        ignoreVisibility?: boolean;
        skipPrivateSkins?: boolean;
    },
): void
Parameters
- drawableIds: number[]
- drawMode: DrawMode
- projection: M4
- Optionalopts: {
      effectMask?: number;
      extraUniforms?: object;
      filter?: (drawableId: number) => boolean;
      framebufferHeight?: number;
      framebufferWidth?: number;
      ignoreVisibility?: boolean;
      skipPrivateSkins?: boolean;
  }
Returns void
- Defined in types/scratch-render.d.ts:581

_endIndexForKnownLayerGroup

_endIndexForKnownLayerGroup(layerGroup: string): number
Parameters
- layerGroup: string
Returns number
- Defined in types/scratch-render.d.ts:606

_enterDrawBackground

_enterDrawBackground(): void
Returns void
- Defined in types/scratch-render.d.ts:797

_exitDrawBackground

_exitDrawBackground(): void
Returns void
- Defined in types/scratch-render.d.ts:798

_getConvexHullPointsForDrawable

_getConvexHullPointsForDrawable(drawableID: number): [number, number][]
Parameters
- drawableID: number
Returns [number, number][]
- Defined in types/scratch-render.d.ts:656

_getMaxPixelsForCPU

_getMaxPixelsForCPU(): number
Returns number
- Defined in types/scratch-render.d.ts:823

_isTouchingColorGpuFin

_isTouchingColorGpuFin(
    bounds: RenderWebGL.Rectangle,
    color: [number, number, number],
    stop: number,
): boolean
Parameters
- bounds: RenderWebGL.Rectangle
- color: [number, number, number]
- stop: number
Returns boolean
- Defined in types/scratch-render.d.ts:670

_isTouchingColorGpuStart

_isTouchingColorGpuStart(
    drawableId: number,
    candidateIds: number[],
    bounds: RenderWebGL.Rectangle,
    color: [number, number, number],
    mask?: [number, number, number],
): void
Parameters
- drawableId: number
- candidateIds: number[]
- bounds: RenderWebGL.Rectangle
- color: [number, number, number]
- Optionalmask: [number, number, number]
Returns void
- Defined in types/scratch-render.d.ts:669

_reskin

_reskin(skinId: number, newSkin: Skin): void
Parameters
- skinId: number
- newSkin: Skin
Returns void
- Defined in types/scratch-render.d.ts:651

_setNativeSize

_setNativeSize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in types/scratch-render.d.ts:573

_touchingBounds

_touchingBounds(drawableId: number): RenderWebGL.Rectangle | null
Get the "candidate bounding box" to use for "touching" queries.
Parameters
- drawableId: number
Returns RenderWebGL.Rectangle | null
The rectangle, or null if the drawable is offscreen or has no skin.
- Defined in types/scratch-render.d.ts:744

_updateOffsets

_updateOffsets(updateType: "add" | "delete", index: number): void
Parameters
- updateType: "add" | "delete"
- index: number
Returns void
- Defined in types/scratch-render.d.ts:595

_updateOverlays

_updateOverlays(): void
Returns void
- Defined in types/scratch-render.d.ts:505

_updateRenderQuality

_updateRenderQuality(): void
Returns void
- Defined in types/scratch-render.d.ts:489

addListener

addListener<K extends keyof ScratchRenderEventMap>(
event: K,
callback: EventEmitterCallback<ScratchRenderEventMap, K>,
): void
Type Parameters
- K extends keyof ScratchRenderEventMap
Parameters
- event: K
- callback: EventEmitterCallback<ScratchRenderEventMap, K>
Returns void
Inherited from EventEmitter.addListener
- Defined in types/events.d.ts:9

addOverlay

addOverlay(element: HTMLElement, mode?: OverlayMode): Overlay
Parameters
- element: HTMLElement
- Optionalmode: OverlayMode
Returns Overlay
- Defined in types/scratch-render.d.ts:498

canHazPixels

canHazPixels(
    drawableID: number,
): {
    height: number;
    imageData: ImageData;
    width: number;
    x: number;
    y: number;
}
:3
Parameters
- drawableID: number
Returns { height: number; imageData: ImageData; width: number; x: number; y: number }
See
- Defined in types/scratch-render.d.ts:720

clientSpaceToScratchBounds

clientSpaceToScratchBounds(
    centerX: number,
    centerY: number,
    width?: number,
    height?: number,
): RenderWebGL.Rectangle
Parameters
- centerX: number
  X coordinate in client space
- centerY: number
  Y coordinate in client space
- Optionalwidth: number
  Defaults to 1
- Optionalheight: number
  Defaults to 1
Returns RenderWebGL.Rectangle
- Defined in types/scratch-render.d.ts:685

createBitmapSkin

createBitmapSkin(
    image: BitmapData,
    bitmapResolution?: BitmapResolution,
    rotationCenter?: [number, number],
): number
Parameters
- image: BitmapData
- OptionalbitmapResolution: BitmapResolution
- OptionalrotationCenter: [number, number]
Returns number
See
- Defined in types/scratch-render.d.ts:620

createDrawable

createDrawable(group: string): number
Parameters
- group: string
Returns number
- Defined in types/scratch-render.d.ts:611

createPenSkin

createPenSkin(): number
Returns number
- Defined in types/scratch-render.d.ts:647

createSVGSkin

createSVGSkin(svgData: string, rotationCenter?: [number, number]): number
Parameters
- svgData: string
- OptionalrotationCenter: [number, number]
Returns number
See
- Defined in types/scratch-render.d.ts:630

createTextSkin

createTextSkin(type: TextBubbleType, text: string, pointsLeft: boolean): number
Parameters
- type: TextBubbleType
- text: string
- pointsLeft: boolean
Returns number
See
- Defined in types/scratch-render.d.ts:640

createTextWrapper

createTextWrapper(measurementProvider: CanvasMeasurementProvider): TextWrapper
Parameters
- measurementProvider: CanvasMeasurementProvider
Returns TextWrapper
- Defined in types/scratch-render.d.ts:494

destroyDrawable

destroyDrawable(drawableID: number, group: string): void
Parameters
- drawableID: number
- group: string
Returns void
- Defined in types/scratch-render.d.ts:612

destroySkin

destroySkin(skinId: number): void
Parameters
- skinId: number
Returns void
- Defined in types/scratch-render.d.ts:649

draw

draw(): void
Renders the stage on the canvas.

Returns void
- Defined in types/scratch-render.d.ts:579

drawableTouching

drawableTouching(
    drawableId: number,
    centerX: number,
    centerY: number,
    width?: number,
    height?: number,
): boolean
Determine if a drawable is touching a point.
Parameters
- drawableId: number
  ID of the target drawable
- centerX: number
  X coordinate in client space
- centerY: number
  Y coordinate in client space
- Optionalwidth: number
  Defaults to 1
- Optionalheight: number
  Defaults to 1
Returns boolean
- Defined in types/scratch-render.d.ts:695

emit

emit<K extends keyof ScratchRenderEventMap>(
event: K,
...args: EventEmitterArgs<ScratchRenderEventMap, K>,
): void
Type Parameters
- K extends keyof ScratchRenderEventMap
Parameters
- event: K
- ...args: EventEmitterArgs<ScratchRenderEventMap, K>
Returns void
Inherited from EventEmitter.emit
- Defined in types/events.d.ts:14

enterDrawRegion

enterDrawRegion(regionId: unknown, enter?: Function, exit?: Function): void
Enter a drawing region.
Parameters
- regionId: unknown
  Any arbitrary unique object.
- Optionalenter: Function
  Called when entering the drawing region (which is what this function does). Defaults to regionId.enter.
- Optionalexit: Function
  Called when leaving the drawing region. Defaults to regionId.exit.
Returns void
- Defined in types/scratch-render.d.ts:792

extractColor

extractColor(
    x: number,
    y: number,
    radius: number,
): {
    color: { a: number; b: number; g: number; r: number };
    data: Uint8Array;
    height: number;
    width: number;
}
Parameters
- x: number
  X coordinate in client space
- y: number
  Y coordinate in client space
- radius: number
  "Radius" of the square, in pixels
Returns {
    color: { a: number; b: number; g: number; r: number };
    data: Uint8Array;
    height: number;
    width: number;
}
Data about the pixels in a square around the coordinates. Color channels are RGBA from 0-255
- Defined in types/scratch-render.d.ts:728

extractDrawableScreenSpace

extractDrawableScreenSpace(
    drawableId: number,
): {
    height: number;
    imageData: ImageData;
    width: number;
    x: number;
    y: number;
}
Parameters
- drawableId: number
Returns { height: number; imageData: ImageData; width: number; x: number; y: number }
- Defined in types/scratch-render.d.ts:708

getBounds

getBounds(drawableId: number): RenderWebGL.Rectangle
Parameters
- drawableId: number
Returns RenderWebGL.Rectangle
- Defined in types/scratch-render.d.ts:653

getBoundsForBubble

getBoundsForBubble(drawableId: number): RenderWebGL.Rectangle
Parameters
- drawableId: number
Returns RenderWebGL.Rectangle
- Defined in types/scratch-render.d.ts:654

getCurrentSkinSize

getCurrentSkinSize(drawableId: number): [number, number]
Parameters
- drawableId: number
Returns [number, number]
- Defined in types/scratch-render.d.ts:658

getDrawableOrder

getDrawableOrder(drawableID: number): number
Parameters
- drawableID: number
Returns number
- Defined in types/scratch-render.d.ts:597

getFencedPositionOfDrawable

getFencedPositionOfDrawable(
drawableId: number,
position: [number, number],
): [number, number]
Parameters
- drawableId: number
- position: [number, number]
Returns [number, number]
- Defined in types/scratch-render.d.ts:772

getNativeSize

getNativeSize(): [number, number]
Returns [number, number]
- Defined in types/scratch-render.d.ts:572

getSkinRotationCenter

getSkinRotationCenter(skinId: number): [number, number]
Parameters
- skinId: number
Returns [number, number]
- Defined in types/scratch-render.d.ts:660

getSkinSize

getSkinSize(skinId: number): [number, number]
Parameters
- skinId: number
Returns [number, number]
- Defined in types/scratch-render.d.ts:659

isTouchingColor

isTouchingColor(
    drawableId: number,
    color: [number, number, number],
    mask?: [number, number, number],
): boolean
Determine if a drawable is touching a color or if a certain color of the drawable is touching a color.
Parameters
- drawableId: number
- color: [number, number, number]
  RGB color from 0-255
- Optionalmask: [number, number, number]
  RGB color from 0-255. Used by "is color touching color" block.
Returns boolean
- Defined in types/scratch-render.d.ts:667

isTouchingDrawables

isTouchingDrawables(drawableId: number, candidateIds?: number[]): boolean
Determine if a drawable is intersecting a set of other drawables.
Parameters
- drawableId: number
  ID of the target drawable
- OptionalcandidateIds: number[]
  The IDs of the drawables to test for collision with the target drawable. Defaults to all drawables.
Returns boolean
- Defined in types/scratch-render.d.ts:677

listeners

listeners<K extends keyof ScratchRenderEventMap>(
event: K,
): EventEmitterCallback<ScratchRenderEventMap, K>[]
Type Parameters
- K extends keyof ScratchRenderEventMap
Parameters
- event: K
Returns EventEmitterCallback<ScratchRenderEventMap, K>[]
Inherited from EventEmitter.listeners
- Defined in types/events.d.ts:13

markDrawableAsNoninteractive

markDrawableAsNoninteractive(drawableId: number): void
Parameters
- drawableId: number
Returns void
- Defined in types/scratch-render.d.ts:492

markSkinAsPrivate

markSkinAsPrivate(skinId: number): void
Parameters
- skinId: number
Returns void
- Defined in types/scratch-render.d.ts:491

onNativeSizeChanged

onNativeSizeChanged(event: { newSize: [number, number] }): void
Parameters
- event: { newSize: [number, number] }
Returns void
- Defined in types/scratch-render.d.ts:574

penClear

penClear(penSkinId: number): void
Parameters
- penSkinId: number
Returns void
- Defined in types/scratch-render.d.ts:774

penLine

penLine(
    penSkinId: number,
    penAttributes: PenAttributes,
    x1: number,
    y1: number,
    x2: number,
    y2: number,
): void
Parameters
- penSkinId: number
- penAttributes: PenAttributes
- x1: number
- y1: number
- x2: number
- y2: number
Returns void
- Defined in types/scratch-render.d.ts:776

penPoint

penPoint(
    penSkinId: number,
    penAttributes: PenAttributes,
    x: number,
    y: number,
): void
Parameters
- penSkinId: number
- penAttributes: PenAttributes
- x: number
- y: number
Returns void
- Defined in types/scratch-render.d.ts:775

penStamp

penStamp(penSkinId: number, stampDrawableId: number): void
Parameters
- penSkinId: number
- stampDrawableId: number
Returns void
- Defined in types/scratch-render.d.ts:777

pick

pick(
    centerX: number,
    centerY: number,
    width?: number,
    height?: number,
    candidateIds?: number[],
): number
Determine the top-most drawable at a point.
Parameters
- centerX: number
  X coordinate in client space
- centerY: number
  Y coordinate in client space
- Optionalwidth: number
  Defaults to 1
- Optionalheight: number
  Defaults to 1
- OptionalcandidateIds: number[]
  Defaults to all drawables
Returns number
The ID of the top-most drawable, or -1 if there is none. (TW: returns false instead of -1 in Scratch)
- Defined in types/scratch-render.d.ts:706

removeListener

removeListener<K extends keyof ScratchRenderEventMap>(
event: K,
callback: EventEmitterCallback<ScratchRenderEventMap, K>,
): void
Type Parameters
- K extends keyof ScratchRenderEventMap
Parameters
- event: K
- callback: EventEmitterCallback<ScratchRenderEventMap, K>
Returns void
Inherited from EventEmitter.removeListener
- Defined in types/events.d.ts:12

removeOverlay

removeOverlay(element: HTMLElement): void
Parameters
- element: HTMLElement
Returns void
- Defined in types/scratch-render.d.ts:499

requestSnapshot

requestSnapshot(callback: (dataURL: string) => void): void
Parameters
- callback: (dataURL: string) => void
Returns void
- Defined in types/scratch-render.d.ts:819

resize

resize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in types/scratch-render.d.ts:569

sampleColor4b

sampleColor4b(
    vector: V3,
    drawables: {
        drawable: Drawable;
        id: number;
        intersection: RenderWebGL.Rectangle;
    }[],
    destination?: Uint8ClampedArray<ArrayBuffer>,
): Uint8ClampedArray
Parameters
- vector: V3
- drawables: { drawable: Drawable; id: number; intersection: RenderWebGL.Rectangle }[]
- Optionaldestination: Uint8ClampedArray<ArrayBuffer>
Returns Uint8ClampedArray
- Defined in types/scratch-render.d.ts:555

setBackgroundColor

setBackgroundColor(
    red: number,
    green: number,
    blue: number,
    alpha?: number,
): void
Parameters
- red: number
  Red from 0-1
- green: number
  Green from 0-1
- blue: number
  Blue from 0-1
- Optionalalpha: number
  Alpha from 0-1, defaults to 1. (from TW)
Returns void
- Defined in types/scratch-render.d.ts:816

setCustomFonts

setCustomFonts(customFonts: Record<string, string>): void
Parameters
- customFonts: Record<string, string>
Returns void
- Defined in types/scratch-render.d.ts:497

setDebugCanvas

setDebugCanvas(canvas: HTMLCanvasElement): void
Parameters
- canvas: HTMLCanvasElement
Returns void
- Defined in types/scratch-render.d.ts:826

setDrawableOrder

setDrawableOrder(
    drawableID: number,
    order: number,
    group: string,
    isRelative?: boolean,
    min?: number,
): void
Parameters
- drawableID: number
- order: number
- group: string
- OptionalisRelative: boolean
- Optionalmin: number
Returns void
- Defined in types/scratch-render.d.ts:598

setLayerGroupOrdering

setLayerGroupOrdering(groupOrdering: string[]): void
Parameters
- groupOrdering: string[]
Returns void
- Defined in types/scratch-render.d.ts:605

setMaxTextureDimension

setMaxTextureDimension(newMax: number): void
Modify the suggested maximum texture dimension. This should be set before any skins are created.
Parameters
- newMax: number
  The new maximum in texels
Returns void
- Defined in types/scratch-render.d.ts:542

setPrivateSkinAccess

setPrivateSkinAccess(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in types/scratch-render.d.ts:490

setStageSize

setStageSize(xLeft: number, xRight: number, yBottom: number, yTop: number): void
Parameters
- xLeft: number
- xRight: number
- yBottom: number
- yTop: number
Returns void
- Defined in types/scratch-render.d.ts:568

setUseGpuMode

setUseGpuMode(useGpuMode: UseGpuModes): void
Parameters
- useGpuMode: UseGpuModes
Returns void
- Defined in types/scratch-render.d.ts:822

setUseHighQualityRender

setUseHighQualityRender(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in types/scratch-render.d.ts:488

skinWasAltered

skinWasAltered(skin: Skin): void
Parameters
- skin: Skin
Returns void
- Defined in types/scratch-render.d.ts:493

updateBitmapSkin

updateBitmapSkin(
    skinId: number,
    image: BitmapData,
    bitmapResolution?: BitmapResolution,
    rotationCenter?: [number, number],
): void
Parameters
- skinId: number
- image: BitmapData
- OptionalbitmapResolution: BitmapResolution
- OptionalrotationCenter: [number, number]
Returns void
See
- Defined in types/scratch-render.d.ts:625

updateDrawableDirection

updateDrawableDirection(drawableId: number, direction: number): void
Parameters
- drawableId: number
- direction: number
Returns void
- Defined in types/scratch-render.d.ts:756

updateDrawableDirectionScale

updateDrawableDirectionScale(
    drawableId: number,
    direction: number,
    scale: [number, number],
): void
Parameters
- drawableId: number
- direction: number
- scale: [number, number]
Returns void
- Defined in types/scratch-render.d.ts:758

updateDrawableEffect

updateDrawableEffect(
    drawableId: number,
    effectName: RenderWebGL.Effect,
    value: number,
): void
Parameters
- drawableId: number
- effectName: RenderWebGL.Effect
- value: number
Returns void
- Defined in types/scratch-render.d.ts:760

updateDrawablePosition

updateDrawablePosition(drawableId: number, position: [number, number]): void
Parameters
- drawableId: number
- position: [number, number]
Returns void
- Defined in types/scratch-render.d.ts:755

updateDrawableProperties

updateDrawableProperties(
    drawableId: number,
    properties:
        | Record<RenderWebGL.Effect, number>
        | {
            direction?: number;
            position?: [number, number];
            scale?: number;
            skinId?: number;
            visible?: number;
        },
): void
Parameters
- drawableId: number
- properties:
      | Record<RenderWebGL.Effect, number>
      | {
          direction?: number;
          position?: [number, number];
          scale?: number;
          skinId?: number;
          visible?: number;
      }
Returns void
Deprecated
Use the individual updateDrawable* methods instead.
- Defined in types/scratch-render.d.ts:764

updateDrawableScale

updateDrawableScale(drawableId: number, scale: [number, number]): void
Parameters
- drawableId: number
- scale: [number, number]
Returns void
- Defined in types/scratch-render.d.ts:757

updateDrawableSkinId

updateDrawableSkinId(drawableId: number, skinId: number): void
Parameters
- drawableId: number
- skinId: number
Returns void
- Defined in types/scratch-render.d.ts:754

updateDrawableVisible

updateDrawableVisible(drawableId: number, visible: boolean): void
Parameters
- drawableId: number
- visible: boolean
Returns void
- Defined in types/scratch-render.d.ts:759

updateSVGSkin

updateSVGSkin(
    skinId: number,
    svgData: string,
    rotationCenter?: [number, number],
): void
Parameters
- skinId: number
- svgData: string
- OptionalrotationCenter: [number, number]
Returns void
See
- Defined in types/scratch-render.d.ts:635

updateTextSkin

updateTextSkin(
    skinId: number,
    type: TextBubbleType,
    text: string,
    pointsLeft: boolean,
): void
Parameters
- skinId: number
- type: TextBubbleType
- text: string
- pointsLeft: boolean
Returns void
See
- Defined in types/scratch-render.d.ts:645

`Static`_getContext

_getContext(canvas: HTMLCanvasElement): AnyWebGLContext | null
If WebGL 1 is supported, returns a WebGL 1 context. If WebGL 1 is not supported but WebGL 2 is supported, returns a WebGL 2 context. Otherwise, returns null.
Parameters
- canvas: HTMLCanvasElement
Returns AnyWebGLContext | null
- Defined in types/scratch-render.d.ts:552

`Static`isSupported

isSupported(canvas?: HTMLCanvasElement): boolean
Parameters
- Optionalcanvas: HTMLCanvasElement
Returns boolean
- Defined in types/scratch-render.d.ts:545

Class RenderWebGL

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderWebGL

Properties

_allDrawables

_allSkins

_backgroundColor3b

_backgroundColor4f

_backgroundDrawRegionId

_bufferInfo

_customFontStyles

Optional_debugCanvas

_drawList

_exitRegion

_gl

_groupOrdering

_layerGroups

_nativeSize

_nextDrawableId

_nextSkinId

_overlays

_penSkinId

_projection

_regionId

_shaderManager

_snapshotCallbacks

_useGpuMode

_xLeft

_xRight

_yBottom

_yTop

allowPrivateSkinAccess

customFonts

dirty

exports

maxTextureDimension

offscreenTouching

overlayContainer

useHighQualityRender

StaticpowerPreference

Accessors

_visibleDrawList

Returns number[]

canvas

Returns HTMLCanvasElement

gl

Returns AnyWebGLContext

Methods

_addToDrawList

Parameters

Returns void

_candidatesBounds

Parameters

Returns RenderWebGL.Rectangle

_candidatesTouching

Parameters

Returns { drawable: Drawable; id: number; intersection: RenderWebGL.Rectangle }[]

_createGeometry

Returns void

_doExitDrawRegion

Returns void

_drawThese

Parameters

Returns void

_endIndexForKnownLayerGroup

Parameters

Returns number

_enterDrawBackground

Returns void

_exitDrawBackground

Returns void

_getConvexHullPointsForDrawable

`Optional`_debugCanvas

`Static`powerPreference