UNPKG

1.89 kBTypeScriptView Raw
1import { Resource } from './Resource';
2import type { Renderer } from '../../Renderer';
3import type { BaseTexture, ImageSource } from '../BaseTexture';
4import type { GLTexture } from '../GLTexture';
5/**
6 * Base for all the image/canvas resources.
7 * @memberof PIXI
8 */
9export declare class BaseImageResource extends Resource {
10 /**
11 * The source element.
12 * @member {HTMLImageElement|HTMLVideoElement|ImageBitmap|PIXI.ICanvas}
13 * @readonly
14 */
15 source: ImageSource;
16 /**
17 * If set to `true`, will force `texImage2D` over `texSubImage2D` for uploading.
18 * Certain types of media (e.g. video) using `texImage2D` is more performant.
19 * @default false
20 * @private
21 */
22 noSubImage: boolean;
23 /**
24 * @param {HTMLImageElement|HTMLVideoElement|ImageBitmap|PIXI.ICanvas} source
25 */
26 constructor(source: ImageSource);
27 /**
28 * Set cross origin based detecting the url and the crossorigin
29 * @param element - Element to apply crossOrigin
30 * @param url - URL to check
31 * @param crossorigin - Cross origin value to use
32 */
33 static crossOrigin(element: HTMLImageElement | HTMLVideoElement, url: string, crossorigin?: boolean | string): void;
34 /**
35 * Upload the texture to the GPU.
36 * @param renderer - Upload to the renderer
37 * @param baseTexture - Reference to parent texture
38 * @param glTexture
39 * @param {HTMLImageElement|HTMLVideoElement|ImageBitmap|PIXI.ICanvas} [source] - (optional)
40 * @returns - true is success
41 */
42 upload(renderer: Renderer, baseTexture: BaseTexture, glTexture: GLTexture, source?: ImageSource): boolean;
43 /**
44 * Checks if source width/height was changed, resize can cause extra baseTexture update.
45 * Triggers one update in any case.
46 */
47 update(): void;
48 /** Destroy this {@link PIXI.BaseImageResource} */
49 dispose(): void;
50}