@galacean/engine-core 1.6.8 → 1.6.10

package/types/shader/ShaderData.d.ts

@@ -0,0 +1,350 @@
+import { IClone } from "@galacean/engine-design";
+import { Color, Matrix, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { IReferable } from "../asset/IReferable";
+import { Texture } from "../texture/Texture";
+import { ShaderMacro } from "./ShaderMacro";
+import { ShaderProperty } from "./ShaderProperty";
+/**
+ * Shader data collection,Correspondence includes shader properties data and macros data.
+ */
+export declare class ShaderData implements IReferable, IClone {
+    private _macroMap;
+    private _refCount;
+    /**
+     * Get float by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Float
+     */
+    getFloat(propertyName: string): number;
+    /**
+     * Get float by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Float
+     */
+    getFloat(property: ShaderProperty): number;
+    /**
+     * Set float by shader property name.
+     * @remarks Corresponding float shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Float
+     */
+    setFloat(propertyName: string, value: number): void;
+    /**
+     * Set float by shader property.
+     * @remarks Corresponding float shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Float
+     */
+    setFloat(property: ShaderProperty, value: number): void;
+    /**
+     * Get int by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Int
+     */
+    getInt(propertyName: string): number;
+    /**
+     * Get int by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Int
+     */
+    getInt(property: ShaderProperty): number;
+    /**
+     * Set int by shader property name.
+     * @remarks Correspondence includes int and bool shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Int
+     */
+    setInt(propertyName: string, value: number): void;
+    /**
+     * Set int by shader property.
+     * @remarks Correspondence includes int and bool shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Int
+     */
+    setInt(property: ShaderProperty, value: number): void;
+    /**
+     * Get float array by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Float array
+     */
+    getFloatArray(propertyName: string): Float32Array;
+    /**
+     * Get float array by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Float array
+     */
+    getFloatArray(property: ShaderProperty): Float32Array;
+    /**
+     * Set float array by shader property name.
+     * @remarks Correspondence includes float array、vec2 array、vec3 array、vec4 array and matrix array shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Float array
+     */
+    setFloatArray(propertyName: string, value: Float32Array): void;
+    /**
+     * Set float array by shader property.
+     * @remarks Correspondence includes float array、vec2 array、vec3 array、vec4 array and matrix array shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Float array
+     */
+    setFloatArray(property: ShaderProperty, value: Float32Array): void;
+    /**
+     * Get int array by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Int Array
+     */
+    getIntArray(propertyName: string): Int32Array;
+    /**
+     * Get int array by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Int Array
+     */
+    getIntArray(property: ShaderProperty): Int32Array;
+    /**
+     * Set int array by shader property name.
+     * @remarks Correspondence includes bool array、int array、bvec2 array、bvec3 array、bvec4 array、ivec2 array、ivec3 array and ivec4 array shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Int Array
+     */
+    setIntArray(propertyName: string, value: Int32Array): void;
+    /**
+     * Set int array by shader property.
+     * @remarks Correspondence includes bool array、int array、bvec2 array、bvec3 array、bvec4 array、ivec2 array、ivec3 array and ivec4 array shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Int Array
+     */
+    setIntArray(property: ShaderProperty, value: Int32Array): void;
+    /**
+     * Get two-dimensional from shader property name.
+     * @param propertyName - Shader property name
+     * @returns Two-dimensional vector
+     */
+    getVector2(propertyName: string): Vector2;
+    /**
+     * Get two-dimensional from shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Two-dimensional vector
+     */
+    getVector2(property: ShaderProperty): Vector2;
+    /**
+     * Set two-dimensional vector from shader property name.
+     * @remarks Correspondence includes vec2、ivec2 and bvec2 shader property type.
+     * @param property - Shader property name
+     * @param value - Two-dimensional vector
+     */
+    setVector2(property: string, value: Vector2): void;
+    /**
+     * Set two-dimensional vector from shader property.
+     * @remarks Correspondence includes vec2、ivec2 and bvec2 shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Two-dimensional vector
+     */
+    setVector2(property: ShaderProperty, value: Vector2): void;
+    /**
+     * Get vector3 by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Three-dimensional vector
+     */
+    getVector3(propertyName: string): Vector3;
+    /**
+     * Get vector3 by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Three-dimensional vector
+     */
+    getVector3(property: ShaderProperty): Vector3;
+    /**
+     * Set three dimensional vector by shader property name.
+     * @remarks Correspondence includes vec3、ivec3 and bvec3 shader property type.
+     * @param property - Shader property name
+     * @param value - Three-dimensional vector
+     */
+    setVector3(property: string, value: Vector3): void;
+    /**
+     * Set three dimensional vector by shader property.
+     * @remarks Correspondence includes vec3、ivec3 and bvec3 shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Three-dimensional vector
+     */
+    setVector3(property: ShaderProperty, value: Vector3): void;
+    /**
+     * Get vector4 by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Four-dimensional vector
+     */
+    getVector4(propertyName: string): Vector4;
+    /**
+     * Get vector4 by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Four-dimensional vector
+     */
+    getVector4(property: ShaderProperty): Vector4;
+    /**
+     * Set four-dimensional vector by shader property name.
+     * @remarks Correspondence includes vec4、ivec4 and bvec4 shader property type.
+     * @param property - Shader property name
+     * @param value - Four-dimensional vector
+     */
+    setVector4(property: string, value: Vector4): void;
+    /**
+     * Set four-dimensional vector by shader property.
+     * @remarks Correspondence includes vec4、ivec4 and bvec4 shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Four-dimensional vector
+     */
+    setVector4(property: ShaderProperty, value: Vector4): void;
+    /**
+     * Get matrix by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Matrix
+     */
+    getMatrix(propertyName: string): Matrix;
+    /**
+     * Get matrix by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Matrix
+     */
+    getMatrix(property: ShaderProperty): Matrix;
+    /**
+     * Set matrix by shader property name.
+     * @remarks Correspondence includes matrix shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Matrix
+     */
+    setMatrix(propertyName: string, value: Matrix): any;
+    /**
+     * Set matrix by shader property.
+     * @remarks Correspondence includes matrix shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Matrix
+     */
+    setMatrix(property: ShaderProperty, value: Matrix): any;
+    /**
+     * Get color by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Color
+     */
+    getColor(propertyName: string): Color;
+    /**
+     * Get color by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Color
+     */
+    getColor(property: ShaderProperty): Color;
+    /**
+     * Set color by shader property name.
+     * @remarks Correspondence includes vec4 shader property type.
+     * @param propertyName - Shader property name
+     * @param value - Color
+     */
+    setColor(propertyName: string, value: Color): void;
+    /**
+     * Set color by shader property.
+     * @remarks Correspondence includes vec4 shader property type.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Color
+     */
+    setColor(property: ShaderProperty, value: Color): void;
+    /**
+     * Get texture by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Texture
+     */
+    getTexture(propertyName: string): Texture;
+    /**
+     * Get texture by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Texture
+     */
+    getTexture(property: ShaderProperty): Texture;
+    /**
+     * Set texture by shader property name.
+     * @param propertyName - Shader property name
+     * @param value - Texture
+     */
+    setTexture(propertyName: string, value: Texture): void;
+    /**
+     * Set texture by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Texture
+     */
+    setTexture(property: ShaderProperty, value: Texture): void;
+    /**
+     * Get texture array by shader property name.
+     * @param propertyName - Shader property name
+     * @returns Texture array
+     */
+    getTextureArray(propertyName: string): Texture[];
+    /**
+     * Get texture array by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @returns Texture array
+     */
+    getTextureArray(property: ShaderProperty): Texture[];
+    /**
+     * Set texture array by shader property name.
+     * @param propertyName - Shader property name
+     * @param value - Texture array
+     */
+    setTextureArray(propertyName: string, value: Texture[]): void;
+    /**
+     * Set texture array by shader property.
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
+     * @param value - Texture array
+     */
+    setTextureArray(property: ShaderProperty, value: Texture[]): void;
+    /**
+     * Get shader property value set on this shaderData.
+     * @param property - Shader property
+     * @returns Property value
+     */
+    getPropertyValue<T extends ShaderPropertyValueType>(property: string | ShaderProperty): T;
+    /**
+     * Enable macro with name.
+     * @param macroName - Macro name
+     */
+    enableMacro(macroName: string): void;
+    /**
+     * Enable macro with name and value.
+     * @remarks Name and value will combine, it's equal the macro of "name value".
+     * @param name - Macro name
+     * @param value - Macro value
+     */
+    enableMacro(name: string, value: string): void;
+    /**
+     * Enable macro with shaderMacro.
+     * @param macro - Shader macro
+     */
+    enableMacro(macro: ShaderMacro): void;
+    /**
+     * Disable macro.
+     * @param macroName - Macro name
+     */
+    disableMacro(macroName: string): void;
+    /**
+     * Disable macro.
+     * @param macro - Shader macro
+     */
+    disableMacro(macro: ShaderMacro): void;
+    /**
+     * Get shader macro array that are currently enabled for ShaderData.
+     */
+    getMacros(): ShaderMacro[];
+    /**
+     * Get shader macro array that are currently enabled for ShaderData.
+     * @param out - Shader macro array
+     */
+    getMacros(out: ShaderMacro[]): void;
+    /**
+     * Get all shader properties that have been set on this shaderData
+     * @returns  All shader properties
+     */
+    getProperties(): ShaderProperty[];
+    /**
+     * Get all shader properties that have been set on this shaderData
+     * @param out - All shader properties
+     */
+    getProperties(out: ShaderProperty[]): void;
+    clone(): ShaderData;
+    cloneTo(target: ShaderData): void;
+}
+export type ShaderPropertyValueType = number | Vector2 | Vector3 | Vector4 | Color | Matrix | Texture | Texture[] | Int32Array | Float32Array;

package/types/shader/ShaderMacro.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Shader macro。
+ */
+export declare class ShaderMacro {
+    private static _macroNameCounter;
+    private static _macroCounter;
+    private static _macroMap;
+    /**
+     * Get shader macro by name.
+     * @param name - Name of the shader macro
+     * @returns Shader macro
+     */
+    static getByName(name: string): ShaderMacro;
+    /**
+     * Get shader macro by name.
+     * @param name - Name of the shader macro
+     * @param value - Value of the shader macro
+     * @returns Shader macro
+     */
+    static getByName(name: string, value: string): ShaderMacro;
+    /** Name. */
+    readonly name: string;
+    /** Value. */
+    readonly value: string;
+    private constructor();
+}

package/types/shader/ShaderMacroCollection.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/ShaderPart.d.ts

@@ -0,0 +1,46 @@
+import { ShaderTagKey } from "./ShaderTagKey";
+/**
+ * Base class for shader structure.
+ */
+export declare abstract class ShaderPart {
+    protected _name: string;
+    private _tagsMap;
+    /**
+     * Name.
+     */
+    get name(): string;
+    /**
+     * Set tag by key name.
+     * @param keyName - Key name of the tag
+     * @param value - Tag value
+     */
+    setTag<T extends number | string | boolean>(keyName: string, value: T): void;
+    /**
+     * Set tag.
+     * @param key - Key of the tag
+     * @param value - Tag value
+     */
+    setTag<T extends number | string | boolean>(key: ShaderTagKey, value: T): void;
+    /**
+     * Delete a tag by key name.
+     * @param KeyName - Key name of the tag
+     */
+    deleteTag(KeyName: string): void;
+    /**
+     * Delete a tag by key.
+     * @param key - Key of the tag
+     */
+    deleteTag(key: ShaderTagKey): void;
+    /**
+     * Get tag by key name.
+     * @param keyName - Key name of the tag
+     * @returns Tag value
+     */
+    getTagValue<T extends number | string | boolean>(keyName: string): T;
+    /**
+     * Get tag value by key.
+     * @param key - Key of the tag
+     * @returns Tag value
+     */
+    getTagValue<T extends number | string | boolean>(key: ShaderTagKey): T;
+}

package/types/shader/ShaderPass.d.ts

@@ -0,0 +1,25 @@
+import { ShaderPart } from "./ShaderPart";
+/**
+ * Shader pass containing vertex and fragment source.
+ */
+export declare class ShaderPass extends ShaderPart {
+    private static _shaderPassCounter;
+    private _vertexSource;
+    private _fragmentSource;
+    /**
+     * Create a shader pass.
+     * @param name - Shader pass name
+     * @param vertexSource - Vertex shader source
+     * @param fragmentSource - Fragment shader source
+     * @param tags - Tags
+     */
+    constructor(name: string, vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
+    /**
+     * Create a shader pass.
+     * @param vertexSource - Vertex shader source
+     * @param fragmentSource - Fragment shader source
+     * @param tags - Tags
+     */
+    constructor(vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
+    private _getCanonicalShaderProgram;
+}

package/types/shader/ShaderPool.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/ShaderProgram.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/ShaderProgramPool.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/ShaderProperty.d.ts

@@ -0,0 +1,20 @@
+import { ShaderPropertyType } from "./enums/ShaderPropertyType";
+/**
+ * Shader property.
+ */
+export declare class ShaderProperty {
+    private static _propertyNameCounter;
+    private static _propertyNameMap;
+    /**
+     * Get shader property by name.
+     * @param name - Name of the shader property
+     * @returns Shader property
+     */
+    static getByName(name: string): ShaderProperty;
+    /** Shader property name. */
+    readonly name: string;
+    /**
+     * Shader property type.
+     */
+    get type(): ShaderPropertyType;
+}

package/types/shader/ShaderTagKey.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Shader tag key.
+ */
+export declare class ShaderTagKey {
+    private static _nameCounter;
+    private static _nameMap;
+    /**
+     * Get shader property by name.
+     * @param name - Name of the shader property
+     * @returns Shader property
+     */
+    static getByName(name: string): ShaderTagKey;
+    /** Shader tag property name. */
+    readonly name: string;
+    private constructor();
+}

package/types/shader/ShaderUniform.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/ShaderUniformBlock.d.ts

@@ -0,0 +1 @@
+export {};

package/types/shader/SubShader.d.ts

@@ -0,0 +1,18 @@
+import { ShaderPart } from "./ShaderPart";
+import { ShaderPass } from "./ShaderPass";
+/**
+ * Sub shader.
+ */
+export declare class SubShader extends ShaderPart {
+    private _passes;
+    /**
+     * Sub shader passes.
+     */
+    get passes(): ReadonlyArray<ShaderPass>;
+    /**
+     * Create a sub shader.
+     * @param name - Name of the sub shader
+     * @param passes - Sub shader passes
+     */
+    constructor(name: string, passes: ShaderPass[], tags?: Record<string, number | string | boolean>);
+}

package/types/shader/enums/BlendFactor.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Blend factor.
+ * @remarks defines which function is used for blending pixel arithmetic
+ */
+export declare enum BlendFactor {
+    /** (0, 0, 0, 0)*/
+    Zero = 0,
+    /** (1, 1, 1, 1)*/
+    One = 1,
+    /** (Rs, Gs, Bs, As) */
+    SourceColor = 2,
+    /** (1 - Rs, 1 - Gs, 1 - Bs, 1 - As)*/
+    OneMinusSourceColor = 3,
+    /** (Rd, Gd, Bd, Ad)*/
+    DestinationColor = 4,
+    /** (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad)*/
+    OneMinusDestinationColor = 5,
+    /** (As, As, As, As)*/
+    SourceAlpha = 6,
+    /** (1 - As, 1 - As, 1 - As, 1 - As)*/
+    OneMinusSourceAlpha = 7,
+    /** (Ad, Ad, Ad, Ad)*/
+    DestinationAlpha = 8,
+    /** (1 - Ad, 1 - Ad, 1 - Ad, 1 - Ad)*/
+    OneMinusDestinationAlpha = 9,
+    /** (min(As, 1 - Ad), min(As, 1 - Ad), min(As, 1 - Ad), 10)*/
+    SourceAlphaSaturate = 10,
+    /** (Rc, Gc, Bc, Ac)*/
+    BlendColor = 11,
+    /** (1 - Rc, 1 - Gc, 1 - Bc, 1 - Ac)*/
+    OneMinusBlendColor = 12
+}

package/types/shader/enums/BlendOperation.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Blend operation function.
+ * @remarks defines how a new pixel is combined with a pixel.
+ */
+export declare enum BlendOperation {
+    /** src + dst. */
+    Add = 0,
+    /** src - dst. */
+    Subtract = 1,
+    /** dst - src. */
+    ReverseSubtract = 2,
+    /** Minimum of source and destination. */
+    Min = 3,
+    /** Maximum of source and destination. */
+    Max = 4
+}

package/types/shader/enums/ColorWriteMask.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Set which color channels can be rendered to frame buffer.
+ * @remarks enumeration can be combined using bit operations.
+ */
+export declare enum ColorWriteMask {
+    /** Do not write to any channel. */
+    None = 0,
+    /** Write to the red channel. */
+    Red = 1,
+    /** Write to the green channel. */
+    Green = 2,
+    /** Write to the blue channel. */
+    Blue = 4,
+    /** Write to the alpha channel. */
+    Alpha = 8,
+    /** Write to all channel. */
+    All = 15
+}

package/types/shader/enums/CompareFunction.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Depth/Stencil comparison function.
+ * @remarks Specifies a function that compares incoming pixel depth/stencil to the current depth/stencil buffer value.
+ */
+export declare enum CompareFunction {
+    /** never pass. */
+    Never = 0,
+    /** pass if the incoming value is less than the depth/stencil buffer value. */
+    Less = 1,
+    /** pass if the incoming value equals the depth/stencil buffer value. */
+    Equal = 2,
+    /** pass if the incoming value is less than or equal to the depth/stencil buffer value. */
+    LessEqual = 3,
+    /** pass if the incoming value is greater than the depth/stencil buffer value. */
+    Greater = 4,
+    /** pass if the incoming value is not equal to the depth/stencil buffer value. */
+    NotEqual = 5,
+    /** pass if the incoming value is greater than or equal to the depth/stencil buffer value. */
+    GreaterEqual = 6,
+    /** always pass. */
+    Always = 7
+}

package/types/shader/enums/CullMode.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Culling mode.
+ * @remarks specifies whether or not front- and/or back-facing polygons can be culled.
+ */
+export declare enum CullMode {
+    /** Disable culling. */
+    Off = 0,
+    /** cut the front-face of the polygons. */
+    Front = 1,
+    /** cut the back-face of the polygons. */
+    Back = 2
+}

package/types/shader/enums/RenderQueueType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Render queue type.
+ */
+export declare enum RenderQueueType {
+    /** Opaque queue. */
+    Opaque = 0,
+    /** Opaque queue, alpha cutoff. */
+    AlphaTest = 1,
+    /** Transparent queue, rendering from back to front to ensure correct rendering of transparent objects. */
+    Transparent = 2
+}