Winter Cardinal UI - v0.442.0 / UtilExtract

Class: UtilExtract

Table of contents

Constructors

• constructor

Properties

• WORK_RENDER_TEXTURE

Methods

• base64
• canvas
• destroy
• file
• pixels
• texture

Constructors

constructor

• new UtilExtract(): UtilExtract

Returns

UtilExtract

Properties

WORK_RENDER_TEXTURE

▪ Static Protected Optional WORK_RENDER_TEXTURE: RenderTexture

Defined in

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

Methods

base64

▸ base64(options): string

Parameters

Name	Type
options	UtilExtractBase64Options

Returns

string

Defined in

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

---

canvas

▸ canvas(options): CanvasRenderTarget

Parameters

Name	Type
options	UtilExtractCanvasOptions

Returns

CanvasRenderTarget

Defined in

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

---

destroy

▸ destroy(): void

Clears all the memories.

Returns

void

Defined in

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

---

file

▸ file(options): void

Parameters

Name	Type
options	UtilExtractFileOptions

Returns

void

Defined in

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

---

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:126

---

texture

▸ texture(options): RenderTexture

Parameters

Name	Type
options	UtilExtractTextureOptions

Returns

RenderTexture

Defined in

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

Edit this page.