blaze-2d/lib/src/texture/texture.d.ts

A fast and simple WebGL 2 2D game engine written in TypeScript

import Color from "../utils/color";
export interface TextureUnit {
    unit: number;
    lastUsed: number;
    texture?: Texture;
}
/**
 * Represents a texture with a color and optionally an image that can be applied to {@link Shape}s
 */
export default class Texture {
    color: Color;
    imagePath: string;
    image: HTMLImageElement;
    isOld: boolean;
    private unit;
    /**
     * Creates a {@link Texture} instance with a color.
     *
     * @param color The color of the texture
     */
    constructor(color?: Color);
    /**
     * Loads an image from a path and stores it in the {@link Texture}.
     *
     * @param imagePath A path to an image
     * @returns A promise that resolves once the image has loaded or rejects if there is an error while loading the image.
     */
    loadImage(imagePath: string): Promise<void>;
    /**
     * Set the texture unit to be read from when rendering the texture.
     *
     * **Should only be used if you know what you are doing.**
     *
     * @param unit The texture unit the texture is stored in on the GPU
     */
    setTextureUnit(unit: number): void;
    /**
     * Gets the texture unit the texture is stored in on the GPU, only applies to texture's which use an image.
     *
     * @returns The texture unit the texture is stored in on the GPU, -1 if it is not currently loaded.
     */
    getTextureUnit(): number;
}