类 Material

En

The Material class is used to create materials.

Zh

Material 类用于创建材质。

层级 (查看层级一览)

实现

  • IClone

属性

_id destroyedImmediately lock? name? ownerElements url uuid ALPHATESTVALUE DEBUG RENDERQUEUE_ALPHATEST RENDERQUEUE_OPAQUE RENDERQUEUE_TRANSPARENT SHADERDEFINE_ADDTIVEFOG SHADERDEFINE_ALPHATEST SHADERDEFINE_MAINTEXTURE

访问器

_defineDatas alphaTest alphaTestValue blend blendDst blendDstAlpha blendDstRGB blendEquation blendEquationAlpha blendEquationRGB blendSrc blendSrcAlpha blendSrcRGB cpuMemory cull deps depthTest depthWrite destroyed gpuMemory id MaterialDefine MaterialProperty materialRenderMode obsolute referenceCount renderQueue shader shaderData stencilOp stencilRef stencilTest stencilWrite cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDefine addDep addDeps clone cloneTo destroy effectiveProperty event getBool getBoolByIndex getBuffer getBufferByIndex getColor getColorByIndex getFloat getFloatByIndex getInt getIntByIndex getMatrix3x3 getMatrix3x3ByIndex getMatrix4x4 getMatrix4x4ByIndex getShaderData getShaderDataByIndex getTexture getTextureByIndex getVector2 getVector2ByIndex getVector3 getVector3ByIndex getVector4 getVector4ByIndex hasDefine hasListener isCreateFromURL off offAll offAllCaller oldparseEndEvent on once removeDefine setBool setBoolByIndex setBuffer setBufferByIndex setColor setColorByIndex setDefine setFloat setFloatByIndex setInt setIntByIndex setMatrix3x3 setMatrix3x3ByIndex setMatrix4x4 setMatrix4x4ByIndex setShaderData setShaderDataByIndex setShaderName setTexture setTextureByIndex setVector2 setVector2ByIndex setVector3 setVector3ByIndex setVector4 setVector4ByIndex destroyUnusedResources load

属性

_id

_id: number = 0

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

ownerElements

ownerElements: Set<IRenderElement3D> = ...

En

Owner element.

Zh

所属元素

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态ALPHATESTVALUE

ALPHATESTVALUE: number

En

Shader variables, transparent test values.

Zh

着色器变量,透明测试值。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

静态RENDERQUEUE_ALPHATEST

RENDERQUEUE_ALPHATEST: number = 2450

En

RenderQueue: Alpha Testing

Zh

渲染队列：阿尔法测试。

静态RENDERQUEUE_OPAQUE

RENDERQUEUE_OPAQUE: number = 2000

En

RenderQueue: Opaque

Zh

渲染队列：不透明。

静态RENDERQUEUE_TRANSPARENT

RENDERQUEUE_TRANSPARENT: number = 3000

En

RenderQueue: Transparent

Zh

渲染队列：透明。

静态SHADERDEFINE_ADDTIVEFOG

SHADERDEFINE_ADDTIVEFOG: ShaderDefine

En

Material grade shader macro definition, additive fog.

Zh

材质级着色器宏定义,叠加雾效。

静态SHADERDEFINE_ALPHATEST

SHADERDEFINE_ALPHATEST: ShaderDefine

En

Material grade shader macro definition, transparency testing.

Zh

材质级着色器宏定义,透明测试。

静态SHADERDEFINE_MAINTEXTURE

SHADERDEFINE_MAINTEXTURE: ShaderDefine

En

Material grade shader macro definition, main texture.

Zh

材质级着色器宏定义,主贴图。

访问器

_defineDatas

alphaTest

alphaTestValue

blend

blendDst

blendDstAlpha

blendDstRGB

blendEquation

blendEquationAlpha

blendEquationRGB

blendSrc

blendSrcAlpha

blendSrcRGB

cpuMemory

cull

deps

depthTest

depthWrite

destroyed

gpuMemory

id

MaterialDefine

MaterialProperty

materialRenderMode

obsolute

  • get obsolute(): boolean

    返回 boolean

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

referenceCount

renderQueue

shader

shaderData

stencilOp

stencilRef

stencilTest

stencilWrite

静态cpuMemory

静态gpuMemory

方法

_addReference

  • _addReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to increment the reference count, default is 1.

    返回 void

    En

    Increments the reference count of the resource by the specified amount.

    Zh

    按指定数量增加资源的引用计数。

_clearReference

_removeReference

  • _removeReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to decrement the reference count, default is 1.

    返回 void

    En

    Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

    Zh

    按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

_setCreateURL

  • _setCreateURL(url: string, uuid?: string): void

    参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDefine

addDep

addDeps

clone

  • clone(): any

    返回 any

    A new material instance that is a clone of the current material.

    En

    Creates a clone of the current material.

    Zh

    创建当前材质的克隆副本。

cloneTo

destroy

effectiveProperty

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

getBool

  • getBool(name: string): boolean

    参数

    • name: string

      The name of the property.

    返回 boolean

    The boolean value.

    En

    Gets a boolean value of uniformIndex by property name.

    Zh

    根据属性名称获得uniform索引的布尔值。

getBoolByIndex

  • getBoolByIndex(uniformIndex: number): boolean

    参数

    • uniformIndex: number

      The index of the uniform.

    返回 boolean

    The boolean value of the property.

    En

    Gets the boolean uniform value by index.

    Zh

    通过uniform索引获取布尔值。

getBuffer

  • getBuffer(name: string): Float32Array

    参数

    • name: string

      The name of the property.

    返回 Float32Array

    The retrieved buffer.

    En

    Retrieves a buffer by property name.

    Zh

    根据属性名称获得Buffer。

getBufferByIndex

  • getBufferByIndex(uniformIndex: number): Float32Array

    参数

    • uniformIndex: number

      The index of the property.

    返回 Float32Array

    The retrieved buffer.

    En

    Retrieves a buffer by its uniform index.

    Zh

    通过属性索引获得Buffer。

getColor

getColorByIndex

  • getColorByIndex(uniformIndex: number): Color

    参数

    • uniformIndex: number

      The index of the property.

    返回 Color

    The retrieved Color value.

    En

    Retrieves a Color value by its uniform index.

    Zh

    通过属性索引获得颜色值。

getFloat

  • getFloat(name: string): number

    参数

    • name: string

      The name of the property.

    返回 number

    The float value.

    En

    Gets a float value by property name.

    Zh

    根据属性名称获得浮点值。

getFloatByIndex

  • getFloatByIndex(uniformIndex: number): number

    参数

    • uniformIndex: number

      The index of the property.

    返回 number

    The float value.

    En

    Gets a float value by uniform index.

    Zh

    通过属性索引获得浮点值。

getInt

  • getInt(name: string): number

    参数

    • name: string

      The name of the property.

    返回 number

    The integer value.

    En

    Gets an integer value by property name.

    Zh

    根据属性名称获得整数值。

getIntByIndex

  • getIntByIndex(uniformIndex: number): number

    参数

    • uniformIndex: number

      The index of the property.

    返回 number

    The integer value.

    En

    Gets an integer value by uniform index.

    Zh

    通过属性索引获得整数值。

getMatrix3x3

getMatrix3x3ByIndex

getMatrix4x4

getMatrix4x4ByIndex

getShaderData

getShaderDataByIndex

getTexture

getTextureByIndex

getVector2

getVector2ByIndex

getVector3

  • getVector3(name: string): Vector3

    参数

    • name: string

      The name of the property as defined in the shader.

    返回 Vector3

    The retrieved Vector3 value.

    En

    Retrieves a Vector3 value by its property name.

    Zh

    根据属性名称获得Vector3值。

getVector3ByIndex

  • getVector3ByIndex(uniformIndex: number): Vector3

    参数

    • uniformIndex: number

      The index of the property.

    返回 Vector3

    The retrieved Vector3 value.

    En

    Retrieves a Vector3 value by its uniform index.

    Zh

    通过属性索引获得Vector3值。

getVector4

getVector4ByIndex

  • getVector4ByIndex(uniformIndex: number): Vector4

    参数

    • uniformIndex: number

      The index of the property.

    返回 Vector4

    The retrieved Vector4 value.

    En

    Retrieves a Vector4 value by uniform index.

    Zh

    通过属性索引获取Vector4值。

hasDefine

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url: string): boolean

    参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

off

  • off(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

  • off(
        type: string,
        caller: any,
        listener?: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • 可选listener: Function

      The listener function.

    • 可选args: any[]

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

offAll

  • offAll(type?: string): EventDispatcher

    参数

    • 可选type: string

      (Optional) The type of event. If the value is null, all types of listeners on this object are removed.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove all listeners of the specified event type from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除指定事件类型的所有侦听器。

offAllCaller

oldparseEndEvent

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

removeDefine

setBool

  • setBool(name: string, value: boolean): void

    参数

    • name: string

      The name of the property.

    • value: boolean

      The value to set.

    返回 void

    En

    Sets a boolean value by property name.

    Zh

    设置属性名称对应的布尔值。

setBoolByIndex

  • setBoolByIndex(uniformIndex: number, value: boolean): void

    参数

    • uniformIndex: number

      The index of the uniform.

    • value: boolean

      The bool value to set.

    返回 void

    En

    Sets the boolean value by uniform index.

    Zh

    通过uniform索引设置布尔值。

setBuffer

  • setBuffer(name: string, value: Float32Array): void

    参数

    • name: string

      The name of the property.

    • value: Float32Array

      The buffer to set.

    返回 void

    En

    Sets a buffer by property name.

    Zh

    根据属性名称设置Buffer。

setBufferByIndex

  • setBufferByIndex(uniformIndex: number, value: Float32Array): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Float32Array

      The buffer to set.

    返回 void

    En

    Sets a buffer by its uniform index.

    Zh

    通过属性索引设置Buffer。

setColor

  • setColor(name: string, value: Color): void

    参数

    • name: string

      The name of the property.

    • value: Color

      The Color value to set.

    返回 void

    En

    Sets a Color value by property name.

    Zh

    设置属性名称对应的颜色值。

setColorByIndex

  • setColorByIndex(uniformIndex: number, value: Color): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Color

      The Color value to set.

    返回 void

    En

    Sets a Color value by its uniform index.

    Zh

    通过属性索引设置颜色值。

setDefine

setFloat

  • setFloat(name: string, value: number): void

    参数

    • name: string

      The name of the property.

    • value: number

      The value to set.

    返回 void

    En

    Sets a float value by property name.

    Zh

    设置属性名称对应的浮点值。

setFloatByIndex

  • setFloatByIndex(uniformIndex: number, value: number): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: number

      The value to set.

    返回 void

    En

    Sets a float value by uniform index.

    Zh

    通过属性索引设置浮点值。

setInt

  • setInt(name: string, value: number): void

    参数

    • name: string

      The name of the property.

    • value: number

      The value to set.

    返回 void

    En

    Sets an integer value by property name.

    Zh

    设置属性名称对应的整数值。

setIntByIndex

  • setIntByIndex(uniformIndex: number, value: number): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: number

      The value to set.

    返回 void

    En

    Sets an integer value by uniform index.

    Zh

    通过属性索引设置整数值。

setMatrix3x3

setMatrix3x3ByIndex

  • setMatrix3x3ByIndex(index: number, value: Matrix3x3): void

    参数

    • index: number

      The index of the matrix within the shader data.

    • value: Matrix3x3

      The 3x3 matrix value to set.

    返回 void

    En

    Sets a 3x3 matrix value by its index.

    Zh

    通过索引设置3x3矩阵值。

setMatrix4x4

setMatrix4x4ByIndex

  • setMatrix4x4ByIndex(uniformIndex: number, value: Matrix4x4): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Matrix4x4

      The Matrix4x4 value to set.

    返回 void

    En

    Sets a Matrix4x4 value by its uniform index.

    Zh

    通过属性索引设置4x4矩阵值。

setShaderData

setShaderDataByIndex

setShaderName

  • setShaderName(name: string): void

    参数

    • name: string

      The name of the shader to set.

    返回 void

    En

    Sets the shader by its name.

    Zh

    通过名称设置使用Shader。

setTexture

setTextureByIndex

setVector2

  • setVector2(name: string, value: Vector2): void

    参数

    • name: string

      The name of the property.

    • value: Vector2

      The Vector2 value to set.

    返回 void

    En

    Sets a Vector2 value by property name.

    Zh

    设置属性名称对应的Vector2值。

setVector2ByIndex

  • setVector2ByIndex(uniformIndex: number, value: Vector2): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Vector2

      The Vector2 value to set.

    返回 void

    En

    Sets a Vector2 value by uniform index.

    Zh

    通过属性索引设置Vector2值。

setVector3

  • setVector3(name: string, value: Vector3): void

    参数

    • name: string

      The name of the property as defined in the shader.

    • value: Vector3

      The Vector3 value to set.

    返回 void

    En

    Sets a Vector3 value by its property name.

    Zh

    设置属性名称对应的Vector3值。

setVector3ByIndex

  • setVector3ByIndex(uniformIndex: number, value: Vector3): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Vector3

      The Vector3 value to set.

    返回 void

    En

    Sets a Vector3 value by its uniform index.

    Zh

    通过属性索引设置Vector3值。

setVector4

  • setVector4(name: string, value: Vector4): void

    参数

    • name: string

      The name of the property.

    • value: Vector4

      The Vector4 value to set.

    返回 void

    En

    Sets a Vector4 value by property name.

    Zh

    设置属性名称对应的Vector4值。

setVector4ByIndex

  • setVector4ByIndex(uniformIndex: number, value: Vector4): void

    参数

    • uniformIndex: number

      The index of the property.

    • value: Vector4

      The Vector4 value to set.

    返回 void

    En

    Sets a Vector4 value by uniform index.

    Zh

    通过属性索引设置Vector4值。

静态destroyUnusedResources

静态load

  • load(url: string, complete: Handler): void

    参数

    • url: string

      The URL from which to load the material.

    • complete: Handler

      A callback function that is called when the material has been loaded.

    返回 void

    En

    Loads a material from a URL.

    Zh

    从URL加载材质。

显示设置

成员可见性

目录

属性
访问器
方法
_addReference_clearReference_removeReference_setCPUMemory_setCreateURL_setGPUMemoryaddDefineaddDepaddDepsclonecloneTodestroyeffectivePropertyeventgetBoolgetBoolByIndexgetBuffergetBufferByIndexgetColorgetColorByIndexgetFloatgetFloatByIndexgetIntgetIntByIndexgetMatrix3x3getMatrix3x3ByIndexgetMatrix4x4getMatrix4x4ByIndexgetShaderDatagetShaderDataByIndexgetTexturegetTextureByIndexgetVector2getVector2ByIndexgetVector3getVector3ByIndexgetVector4getVector4ByIndexhasDefinehasListenerisCreateFromURLoffoffAlloffAllCalleroldparseEndEventononceremoveDefinesetBoolsetBoolByIndexsetBuffersetBufferByIndexsetColorsetColorByIndexsetDefinesetFloatsetFloatByIndexsetIntsetIntByIndexsetMatrix3x3setMatrix3x3ByIndexsetMatrix4x4setMatrix4x4ByIndexsetShaderDatasetShaderDataByIndexsetShaderNamesetTexturesetTextureByIndexsetVector2setVector2ByIndexsetVector3setVector3ByIndexsetVector4setVector4ByIndexdestroyUnusedResourcesload