@galacean/engine-core 0.0.0-experimental-animator-additive.1

package/types/texture/Texture2DArray.d.ts

@@ -0,0 +1,81 @@
+import { Engine } from "../Engine";
+import { TextureFormat } from "./enums/TextureFormat";
+import { Texture } from "./Texture";
+/**
+ * Two-dimensional texture array.
+ */
+export declare class Texture2DArray extends Texture {
+    private readonly _length;
+    /**
+     * The length of the texture.
+     */
+    get length(): number;
+    /**
+     * Create Texture2D Array.
+     * @param engine - Define the engine to use to render this texture
+     * @param width - Texture width
+     * @param height - Texture height
+     * @param length - Texture length
+     * @param format - Texture format. default `TextureFormat.R8G8B8A8`
+     * @param mipmap - Whether to use multi-level texture
+     */
+    constructor(engine: Engine, width: number, height: number, length: number, format?: TextureFormat, mipmap?: boolean);
+    /**
+     * Setting pixels data through color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
+     * @remarks If it is the WebGL1.0 platform and the texture format is compressed, the first upload must be filled with textures.
+     * @param offsetIndex - The texture array element offset index
+     * @param colorBuffer - Color buffer data
+     * @param mipLevel - Texture mipmapping level
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     * @param width - Data width. if it's empty, width is the width corresponding to mipLevel minus x , width corresponding to mipLevel is Math.max(1, this.width >> mipLevel)
+     * @param height - Data height. if it's empty, height is the height corresponding to mipLevel minus y , height corresponding to mipLevel is Math.max(1, this.height >> mipLevel)
+     * @param length - Data length. if it's empty, length is the length of Texture2DArray.length
+     */
+    setPixelBuffer(offsetIndex: number, colorBuffer: ArrayBufferView, mipLevel?: number, x?: number, y?: number, width?: number, height?: number, length?: number): void;
+    /**
+     * Setting pixels data through TexImageSource, designated area and texture mipmapping level.
+     * @param elementIndex - The texture array element index
+     * @param imageSource - The source of texture
+     * @param mipLevel - Texture mipmapping level
+     * @param flipY - Whether to flip the Y axis
+     * @param premultiplyAlpha - Whether to premultiply the transparent channel
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     */
+    setImageSource(elementIndex: number, imageSource: TexImageSource | OffscreenCanvas, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
+    /**
+     * Get pixel color buffer.
+     * @param elementIndex - The texture array element index
+     * @param out - Color buffer
+     */
+    getPixelBuffer(elementIndex: number, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified mip level.
+     * @param elementIndex - The texture array element index
+     * @param mipLevel - Tet mip level want to get
+     * @param out - Color buffer
+     */
+    getPixelBuffer(elementIndex: number, mipLevel: number, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified area.
+     * @param elementIndex - The texture array element index
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     * @param width - Area width
+     * @param height - Area height
+     * @param out - Color buffer
+     */
+    getPixelBuffer(elementIndex: number, x: number, y: number, width: number, height: number, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified area and mip level.
+     * @param elementIndex - The texture array element index
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     * @param width - Area width
+     * @param height - Area height
+     * @param mipLevel - Tet mip level want to get
+     * @param out - Color buffer
+     */
+    getPixelBuffer(elementIndex: number, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
+}

package/types/texture/TextureCube.d.ts

@@ -0,0 +1,70 @@
+import { Engine } from "../Engine";
+import { TextureCubeFace } from "./enums/TextureCubeFace";
+import { TextureFormat } from "./enums/TextureFormat";
+import { Texture } from "./Texture";
+/**
+ * Cube texture.
+ */
+export declare class TextureCube extends Texture {
+    /**
+     * Create TextureCube.
+     * @param engine - Define the engine to use to render this texture
+     * @param size - Texture size. texture width must be equal to height in cube texture
+     * @param format - Texture format,default TextureFormat.R8G8B8A8
+     * @param mipmap - Whether to use multi-level texture
+     */
+    constructor(engine: Engine, size: number, format?: TextureFormat, mipmap?: boolean);
+    /**
+     * Setting pixels data through cube face,color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
+     * @remarks When compressed texture is in WebGL1, the texture must be filled first before writing the sub-region
+     * @param face - Cube face
+     * @param colorBuffer - Color buffer data
+     * @param mipLevel - Texture mipmapping level
+     * @param x - X coordinate of area start
+     * @param y -  Y coordinate of area start
+     * @param width - Data width.if it's empty, width is the width corresponding to mipLevel minus x , width corresponding to mipLevel is Math.max(1, this.width >> mipLevel)
+     * @param height - Data height.if it's empty, height is the height corresponding to mipLevel minus y , height corresponding to mipLevel is Math.max(1, this.height >> mipLevel)
+     */
+    setPixelBuffer(face: TextureCubeFace, colorBuffer: ArrayBufferView, mipLevel?: number, x?: number, y?: number, width?: number, height?: number): void;
+    /**
+     * Setting pixels data through cube face, TexImageSource, designated area and texture mipmapping level.
+     * @param face - Cube face
+     * @param imageSource - The source of texture
+     * @param mipLevel - Texture mipmapping level
+     * @param flipY - Whether to flip the Y axis
+     * @param premultiplyAlpha - Whether to premultiply the transparent channel
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     */
+    setImageSource(face: TextureCubeFace, imageSource: TexImageSource | OffscreenCanvas, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
+    /**
+     * Get pixel color buffer.
+     * @param out - Color buffer
+     */
+    getPixelBuffer(face: TextureCubeFace, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified mip level.
+     * @param mipLevel - Tet mip level want to get
+     * @param out - Color buffer
+     */
+    getPixelBuffer(face: TextureCubeFace, mipLevel: number, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified area.
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     * @param width - Area width
+     * @param height - Area height
+     * @param out - Color buffer
+     */
+    getPixelBuffer(face: TextureCubeFace, x: number, y: number, width: number, height: number, out: ArrayBufferView): void;
+    /**
+     * Get the pixel color buffer according to the specified area and mip level.
+     * @param x - X coordinate of area start
+     * @param y - Y coordinate of area start
+     * @param width - Area width
+     * @param height - Area height
+     * @param mipLevel - Tet mip level want to get
+     * @param out - Color buffer
+     */
+    getPixelBuffer(face: TextureCubeFace, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
+}

package/types/texture/enums/RenderBufferDepthFormat.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Render buffer depth format enumeration.
+ */
+export declare enum RenderBufferDepthFormat {
+    /** Render to depth buffer,engine will automatically select the supported precision. */
+    Depth = 0,
+    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
+    DepthStencil = 1,
+    /** Render to stencil buffer. */
+    Stencil = 2,
+    /** Force 16-bit depth buffer. */
+    Depth16 = 3,
+    /** Force 24-bit depth buffer. */
+    Depth24 = 4,
+    /** Force 32-bit depth buffer. */
+    Depth32 = 5,
+    /** Force 16-bit depth + 8-bit stencil buffer. */
+    Depth24Stencil8 = 6,
+    /** Force 32-bit depth + 8-bit stencil buffer. */
+    Depth32Stencil8 = 7
+}

package/types/texture/enums/TextureCubeFace.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Define the face of the cube texture.
+ */
+export declare enum TextureCubeFace {
+    /** Positive X face for a cube-mapped texture. */
+    PositiveX = 0,
+    /** Negative X face for a cube-mapped texture. */
+    NegativeX = 1,
+    /** Positive Y face for a cube-mapped texture. */
+    PositiveY = 2,
+    /** Negative Y face for a cube-mapped texture. */
+    NegativeY = 3,
+    /** Positive Z face for a cube-mapped texture. */
+    PositiveZ = 4,
+    /** Negative Z face for a cube-mapped texture. */
+    NegativeZ = 5
+}

package/types/texture/enums/TextureDepthCompareFunction.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Define the compare mode of depth texture.
+ */
+export declare enum TextureDepthCompareFunction {
+    /** never pass. */
+    Never = 0,
+    /** pass if the compare value is less than the sample value. */
+    Less = 1,
+    /** pass if the compare value equals the sample value. */
+    Equal = 2,
+    /** pass if the compare value is less than or equal to the sample value. */
+    LessEqual = 3,
+    /** pass if the compare value is greater than the sample value. */
+    Greater = 4,
+    /** pass if the compare value is not equal to the sample value. */
+    NotEqual = 5,
+    /** pass if the compare value is greater than or equal to the sample value. */
+    GreaterEqual = 6,
+    /** always pass. */
+    Always = 7
+}

package/types/texture/enums/TextureFilterMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The filter mode of the texture.
+ */
+export declare enum TextureFilterMode {
+    /** Point filtering. */
+    Point = 0,
+    /** Bilinear filtering. */
+    Bilinear = 1,
+    /** Trilinear filtering. */
+    Trilinear = 2
+}

package/types/texture/enums/TextureFormat.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Texture format enumeration.
+ */
+export declare enum TextureFormat {
+    /** RGB format,8 bits per channel. */
+    R8G8B8 = 0,
+    /** RGBA format,8 bits per channel. */
+    R8G8B8A8 = 1,
+    /** RGBA format,4 bits per channel. */
+    R4G4B4A4 = 2,
+    /** RGBA format,5 bits in R channel,5 bits in G channel,5 bits in B channel, 1 bit in A channel. */
+    R5G5B5A1 = 3,
+    /** RGB format,5 bits in R channel,6 bits in G channel,5 bits in B channel. */
+    R5G6B5 = 4,
+    /** Transparent format,8 bits. */
+    Alpha8 = 5,
+    /** Luminance/alpha in RGB channel, alpha in A channel. */
+    LuminanceAlpha = 6,
+    /** RGBA format,16 bits per channel. */
+    R16G16B16A16 = 7,
+    /** RGBA format,32 bits per channel. */
+    R32G32B32A32 = 8,
+    /** RGB compressed format。*/
+    DXT1 = 9,
+    /** RGBA compressed format。*/
+    DXT5 = 10,
+    /** RGB compressed format,4 bits per pixel。*/
+    ETC1_RGB = 11,
+    /** RGB compressed format,4 bits per pixel。*/
+    ETC2_RGB = 12,
+    /** RGBA compressed format,5 bits per pixel,4 bit in RGB, 1 bit in A. */
+    ETC2_RGBA5 = 13,
+    /** RGB compressed format,8 bits per pixel. */
+    ETC2_RGBA8 = 14,
+    /** RGB compressed format,2 bits per pixel. */
+    PVRTC_RGB2 = 15,
+    /** RGBA compressed format,2 bits per pixel. */
+    PVRTC_RGBA2 = 16,
+    /** RGB compressed format,4 bits per pixel. */
+    PVRTC_RGB4 = 17,
+    /** RGBA compressed format,4 bits per pixel. */
+    PVRTC_RGBA4 = 18,
+    /** RGB(A) compressed format,128 bits per 4x4 pixel block. */
+    ASTC_4x4 = 19,
+    /** RGB(A) compressed format,128 bits per 5x5 pixel block. */
+    ASTC_5x5 = 20,
+    /** RGB(A) compressed format,128 bits per 6x6 pixel block. */
+    ASTC_6x6 = 21,
+    /** RGB(A) compressed format,128 bits per 8x8 pixel block. */
+    ASTC_8x8 = 22,
+    /** RGB(A) compressed format,128 bits per 10x10 pixel block. */
+    ASTC_10x10 = 23,
+    /** RGB(A) compressed format,128 bits per 12x12 pixel block. */
+    ASTC_12x12 = 24,
+    /** Automatic depth format,engine will automatically select the supported precision. */
+    Depth = 25,
+    /** Automatic depth setncil format, engine will automatically select the supported precision. */
+    DepthStencil = 26,
+    /** 16-bit depth format. */
+    Depth16 = 27,
+    /** 24-bit depth format. */
+    Depth24 = 28,
+    /** 32-bit depth format. */
+    Depth32 = 29,
+    /** 16-bit depth + 8-bit stencil format. */
+    Depth24Stencil8 = 30,
+    /** 32-bit depth + 8-bit stencil format. */
+    Depth32Stencil8 = 31
+}

package/types/texture/enums/TextureWrapMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Wrapping mode of the texture.
+ */
+export declare enum TextureWrapMode {
+    /** Clamping mode. use the color of edge pixels beyond the texture boundary. */
+    Clamp = 0,
+    /** Repeating mode. tiling will be repeated if it exceeds the texture boundary. */
+    Repeat = 1,
+    /** Mirror repeat mode. tiling will be mirrored and repeated if it exceeds the texture boundary. */
+    Mirror = 2
+}

package/types/texture/index.d.ts

@@ -0,0 +1,11 @@
+export { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
+export { TextureCubeFace } from "./enums/TextureCubeFace";
+export { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
+export { TextureFilterMode } from "./enums/TextureFilterMode";
+export { TextureFormat } from "./enums/TextureFormat";
+export { TextureWrapMode } from "./enums/TextureWrapMode";
+export { RenderTarget } from "./RenderTarget";
+export { Texture } from "./Texture";
+export { Texture2D } from "./Texture2D";
+export { Texture2DArray } from "./Texture2DArray";
+export { TextureCube } from "./TextureCube";

package/types/trail/TrailMaterial.d.ts

@@ -0,0 +1,5 @@
+import { Engine } from "../Engine";
+import { Material } from "../material/Material";
+export declare class TrailMaterial extends Material {
+    constructor(engine: Engine);
+}

package/types/trail/TrailRenderer.d.ts

@@ -0,0 +1,40 @@
+import { Entity } from "../Entity";
+import { MeshRenderer } from "../mesh/MeshRenderer";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Texture2D } from "../texture";
+/**
+ * @deprecated
+ */
+export declare class TrailRenderer extends MeshRenderer {
+    private _vertexStride;
+    private _vertices;
+    private _vertexBuffer;
+    private _stroke;
+    private _minSeg;
+    private _lifetime;
+    private _maxPointNum;
+    private _points;
+    private _pointStates;
+    private _strapPoints;
+    private _curPointNum;
+    private _prePointsNum;
+    /**
+     * @deprecated
+     */
+    constructor(entity: Entity, props: any);
+    /**
+     * @deprecated
+     * Set trail texture.
+     * @param texture
+     */
+    setTexture(texture: Texture2D): void;
+    /**
+     * @override
+     */
+    protected _render(context: RenderContext): void;
+    private _initGeometry;
+    private _updateStrapVertices;
+    private _updateStrapCoords;
+    private _projectOnVector;
+    private _projectOnPlane;
+}

package/types/trail/index.d.ts

@@ -0,0 +1,2 @@
+export { TrailRenderer } from "./TrailRenderer";
+export { TrailMaterial } from "./TrailMaterial";