Cocogoat Web

https://github.com/yuehaiteam/cocogoat
Admin
Cocogoat Web is a 100% browser-based toolbox for Genshin Impact, offering features like achievement...
Tokens:1,890
Snippets:22
Trust Score:8.6
License:BSD-3-Clause
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build Project with Webpack

Source: https://github.com/yuehaiteam/cocogoat/blob/main/README_en.md

Use this command to build the project for deployment using webpack.

```bash
pnpm build
```

--------------------------------

### Build as a Single File with Vite

Source: https://github.com/yuehaiteam/cocogoat/blob/main/README_en.md

Use this command to build the project as a single HTML file using Vite.

```bash
pnpm build:singlefile
```

--------------------------------

### Run Locally with Vite

Source: https://github.com/yuehaiteam/cocogoat/blob/main/README_en.md

Use this command to run the project locally for development using Vite.

```bash
pnpm serve
```

--------------------------------

### OpenCV Utility Functions

Source: https://github.com/yuehaiteam/cocogoat/blob/main/src/views/Playground/opencv.d.ts.txt

Provides utility functions for image data conversion, matrix creation, and image display.

```APIDOC
## OpenCV Utility Functions

- **matFromImageData(imgData: ImageData): Mat**
  - Creates a `Mat` object from an `ImageData` object.

- **matFromArray(rows: number, cols: number, type: MatType, array: ArrayBuffer | number[]): Mat**
  - Creates a `Mat` object from an array buffer or a number array.

- **imshow(cvs: HTMLCanvasElement | string, mat: Mat): void**
  - Displays a `Mat` object on a canvas element.

- **imread(source: string | HTMLCanvasElement | HTMLImageElement): Mat**
  - Reads an image from a source (URL, canvas, or image element) into a `Mat` object.

- **cvtColor(source: Mat, dest: Mat, mode: MatType, _: number): unknown**
  - Converts an image from one color space to another.

- **CV_8U, CV_8UC1, ..., CV_64FC4**: Constants representing various OpenCV matrix types (e.g., CV_8U for 8-bit unsigned, CV_32F for 32-bit float).
```

--------------------------------

### OpenCV Type Definitions

Source: https://github.com/yuehaiteam/cocogoat/blob/main/src/views/Playground/opencv.d.ts.txt

Defines the structure of the global `cv` object, which exposes all OpenCV functionalities.

```APIDOC
## OpenCV Global Object

- **cv**: The global object that provides access to all OpenCV functionalities.
  - It includes all the classes and utility functions defined in the OpenCV namespace.
  - It also exposes various matrix type constants (e.g., `cv.CV_8U`, `cv.CV_32F`).
  - Example usage:
    ```typescript
    // Create a new Mat object
    const mat = new cv.Mat(100, 100, cv.CV_8UC3);
    
    // Display the Mat object on a canvas
    cv.imshow('canvasId', mat);
    ```
```

--------------------------------

### OpenCV Core Classes and Types

Source: https://github.com/yuehaiteam/cocogoat/blob/main/src/views/Playground/opencv.d.ts.txt

Defines fundamental types and classes used in the OpenCV JavaScript API, such as Mat, Point, Rect, and Size.

```APIDOC
## OpenCV Namespace

### Types

- **MatType**: Alias for `any`, representing various matrix data types.

### Classes

- **NativeObject**
  - `delete(): void` - Releases the native resources associated with the object.

- **MatData** (extends `ArrayBuffer`)
  - `set(data: ArrayBuffer): void` - Sets the data of the MatData object.

- **Range**
  - `start: number`
  - `end: number`
  - `constructor(start: number, end: number)`

- **Point**
  - `x: number`
  - `y: number`
  - `constructor(x: number, y: number)`

- **Size**
  - `width: number`
  - `height: number`
  - `constructor(width: number, height: number)`

- **Rect**
  - `x: number`
  - `y: number`
  - `width: number`
  - `height: number`
  - `constructor()`
  - `constructor(rect: Rect)`
  - `constructor(point: Point, size: Size)`
  - `constructor(x: number, y: number, width: number, height: number)`

- **Mat** (extends `NativeObject`)
  - `data: MatData`
  - `constructor()`
  - `constructor(width: number, height: number, type: number)`
  - `constructor(width: number, height: number, type: number, data: ArrayLike<any>)`
  - `size(): { width: number; height: number }`
  - `cols: number`
  - `rows: number`
  - `channels: number`
  - `empty(): boolean`
  - `clone(): Mat`
  - `copyTo(dest: Mat): void`
  - `setTo(value: number): void`
  - `get(row: number, col: number): number`
  - `set(row: number, col: number, value: number): void`
  - `roi(rect: Rect): Mat`
  - `type(): MatType`
  - `static ones(rows: number, cols: number, type: number): Mat`

- **RotateRect**
  - `center: Point`
  - `size: Size`
  - `angle: number`
  - `constructor()`
  - `constructor(center: Point, size: Size, angle: number)`
  - `static points(obj: any): any`
  - `static boundingRect(obj: any): any`
  - `static boundingRect2f(obj: any): any`

- **Scalar** (extends `Array`)
  - `static all(v: number): Scalar`
  - `constructor(v0: number, v1: number, v2: number, v3: number)`

- **MinMaxLoc**
  - `minVal: number`
  - `maxVal: number`
  - `minLoc: Point`
  - `maxLoc: Point`
  - `constructor()`
  - `constructor(minVal: number, maxVal: number, minLoc: Point, maxLoc: Point)`

- **Circle**
  - `center: Point`
  - `radius: number`
  - `constructor()`
  - `constructor(center: Point, radius: number)`

- **TermCriteria**
  - `type: number`
  - `maxCount: number`
  - `epsilon: number`
  - `constructor()`
  - `constructor(type: number, maxCount: number, epsilon: number)`
```
Tokens:
Raw