Winter Cardinal UI - v0.457.0 / UtilExtract

Class: UtilExtract

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new UtilExtract(): UtilExtract

Returns

UtilExtract

Properties

WORK_CANVAS

▪ Static Protected Optional WORK_CANVAS: UtilExtractorCanvas

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:111

WORK_RENDER_TEXTURE

▪ Static Protected Optional WORK_RENDER_TEXTURE: RenderTexture

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:110

Methods

base64

▸ base64(options): string

Extracts Base64 data URL from the target. This method internally creates a render texture and a canvas render target. They are used to extract pixels from the target. To free the allocated render texture and canvas render target, please call ().

Parameters

Name Type Description
options UtilExtractBase64Options an extraction options

Returns

string

extracted Base64 data URL

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:208

canvas

▸ canvas(options): UtilExtractorCanvas

Parameters

Name Type
options UtilExtractCanvasOptions

Returns

UtilExtractorCanvas

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:192

destroy

▸ destroy(): void

Clears all the memories.

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:228

file

▸ file(options): void

Parameters

Name Type
options UtilExtractFileOptions

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:221

pixels

▸ pixels(options): UtilExtractorPixels

Extracts pixels from the target. This method internally creates one render texture and use that to extract pixels from the target. To free the allocated render texture, please call ().

Parameters

Name Type Description
options UtilExtractPixelsOptions an extraction options

Returns

UtilExtractorPixels

extracted pixels

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:128

texture

▸ texture(options): RenderTexture

Parameters

Name Type
options UtilExtractTextureOptions

Returns

RenderTexture

Defined in

src/main/typescript/wcardinal/ui/util/util-extract.ts:113

Edit this page.