diff --git a/api/classes/AnimationChunk.html b/api/classes/AnimationChunk.html index 80b0201a..04ecd44b 100644 --- a/api/classes/AnimationChunk.html +++ b/api/classes/AnimationChunk.html @@ -1,18 +1,18 @@ AnimationChunk | @masatomakino/threejs-shader-materials

Class AnimationChunk

IAnimatableインターフェースで定義されたアニメーションを実行するGLSLチャンク。 uniformのtime値を操作する。 time値によってどのように変化するかは実装するShaderによる。

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Methods

addTime getChunk getChunkName getDefines getUniform registerChunk -

Constructors

constructor

Methods

StaticaddTime

Protected StaticgetChunk

Protected StaticgetChunkName

StaticgetDefines

  • getDefines(): Object

  • Chunkに関連する定数Defineを格納したオブジェクトを取得する。

    +

Constructors

constructor

Methods

StaticaddTime

Protected StaticgetChunk

Protected StaticgetChunkName

StaticgetDefines

StaticgetUniform

  • getUniform(): { isAnimate: { value: boolean }; time: { value: number } }

  • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

    +

StaticgetUniform

StaticregisterChunk

Settings

Member Visibility

On This Page

Constructors
Methods
+

StaticregisterChunk

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CellularNoiseMaterial.html b/api/classes/CellularNoiseMaterial.html index 672016f1..db24b540 100644 --- a/api/classes/CellularNoiseMaterial.html +++ b/api/classes/CellularNoiseMaterial.html @@ -4,7 +4,7 @@
  • アニメーション再生/停止フラグisAnimate

    • のそれぞれの変数にアクセスできることを保証する。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -105,7 +105,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -259,7 +259,7 @@

    side

    side: Side

    Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

    Default

    THREE.FrontSide

    -

    speed

    speed: number = -0.02

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    speed

    speed: number = -0.02

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -337,7 +337,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -346,7 +346,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    divisionScaleX

    emissive

    grid

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    divisionScaleX

    emissive

    grid

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -354,20 +354,20 @@

    opacity

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -379,11 +379,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -394,13 +394,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, CellularNoiseMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ContourMaterial.html b/api/classes/ContourMaterial.html index 6bf682e1..15f311dd 100644 --- a/api/classes/ContourMaterial.html +++ b/api/classes/ContourMaterial.html @@ -1,6 +1,6 @@ ContourMaterial | @masatomakino/threejs-shader-materials

    Class ContourMaterial

    テクスチャを等高線状にマップするマテリアル。 マッピング以外の機能はMeshPhongMaterialに準じる。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -95,7 +95,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -327,7 +327,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -336,7 +336,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -344,15 +344,15 @@

    opacity

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -367,11 +367,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    loadMap

    • loadMap(url: string, geo: BufferGeometry<NormalBufferAttributes>): void

    • Parameters

      • url: string
      • geo: BufferGeometry<NormalBufferAttributes>

      Returns void

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    loadMap

    • loadMap(url: string, geo: BufferGeometry<NormalBufferAttributes>): void

    • Parameters

      • url: string
      • geo: BufferGeometry<NormalBufferAttributes>

      Returns void

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -382,13 +382,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, ContourMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/CrossGridMaterial.html b/api/classes/CrossGridMaterial.html index 72938110..3581cdf9 100644 --- a/api/classes/CrossGridMaterial.html +++ b/api/classes/CrossGridMaterial.html @@ -1,5 +1,5 @@ CrossGridMaterial | @masatomakino/threejs-shader-materials

    Class CrossGridMaterial

    十字線を正方形グリッドの中心に描画するマテリアル。

    -

    Hierarchy

    • WavyGridMaterial
      • CrossGridMaterial

    Constructors

    constructor +

    Hierarchy

    • WavyGridMaterial
      • CrossGridMaterial

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -110,7 +110,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -120,7 +120,7 @@

    Default

    false
    -

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom +

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

    Default

    0
    @@ -226,7 +226,7 @@

    ReadonlyisShaderMaterial

    isShaderMaterial: true

    Read-only flag to check if a given object is of type ShaderMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false
+

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -267,7 +267,7 @@

    speed

    speed: number = -0.5

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -345,7 +345,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -354,11 +354,11 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      -

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      +

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -366,24 +366,24 @@

    opacity

    radius

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      -

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    radius

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      +

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 +

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 1の場合、幅1ヘックス 0.5の場合、幅2ヘックスになる

      -

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -394,11 +394,11 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

    Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -409,12 +409,12 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, CrossGridMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      +

      Returns void

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

        -

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ExpansionChunk.html b/api/classes/ExpansionChunk.html index 3cbea904..666a5691 100644 --- a/api/classes/ExpansionChunk.html +++ b/api/classes/ExpansionChunk.html @@ -1,16 +1,16 @@ ExpansionChunk | @masatomakino/threejs-shader-materials

    Class ExpansionChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): { [uniform: string]: IUniform<any> }

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/ExpansionDissolveMaterial.html b/api/classes/ExpansionDissolveMaterial.html index ec1573de..bd10e77b 100644 --- a/api/classes/ExpansionDissolveMaterial.html +++ b/api/classes/ExpansionDissolveMaterial.html @@ -1,7 +1,7 @@ ExpansionDissolveMaterial | @masatomakino/threejs-shader-materials

    Class ExpansionDissolveMaterial

    FBMノイズによるジオメトリの膨張でディゾルブを行うマテリアル。 爆発しながら消滅するような表現になる。 膨張の進行度合いはprogressで制御する。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -108,7 +108,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -262,7 +262,7 @@

    side

    side: Side

    Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

    Default

    THREE.FrontSide

    -

    speed

    speed: number = -0.5

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    speed

    speed: number = -0.5

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -340,7 +340,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -348,8 +348,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    amp

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    dissolveColor

    dissolveOutColor

    emissive

    hashLoop

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    amp

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    dissolveColor

    dissolveOutColor

    emissive

    hashLoop

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -357,20 +357,20 @@

    opacity

    progress

    scaleMax

    tiles

    time

    uniformOpacity

    progress

    scaleMax

    tiles

    time

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -382,11 +382,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -397,13 +397,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionDissolveMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ExpansionMaterial.html b/api/classes/ExpansionMaterial.html index b5b8b9f2..2c21c4fc 100644 --- a/api/classes/ExpansionMaterial.html +++ b/api/classes/ExpansionMaterial.html @@ -1,6 +1,6 @@ ExpansionMaterial | @masatomakino/threejs-shader-materials

    Class ExpansionMaterial

    MeshPhongMaterialに準じるShaderMaterialクラス。

    See

    https://github.com/mrdoob/three.js/blob/76c64b23d422dcfb36a28353f45b1effa1f68c5a/src/renderers/shaders/ShaderLib.js#L53

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -95,7 +95,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -327,7 +327,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -336,7 +336,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    expansionStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    expansionStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -344,15 +344,15 @@

    opacity

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -367,11 +367,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -382,13 +382,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, ExpansionMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ExpansionUniformChunk.html b/api/classes/ExpansionUniformChunk.html index 4cf358ae..a0d93391 100644 --- a/api/classes/ExpansionUniformChunk.html +++ b/api/classes/ExpansionUniformChunk.html @@ -1,16 +1,16 @@ ExpansionUniformChunk | @masatomakino/threejs-shader-materials

    Class ExpansionUniformChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/ExpansionVertexChunk.html b/api/classes/ExpansionVertexChunk.html index 63bb883d..caa5c4ad 100644 --- a/api/classes/ExpansionVertexChunk.html +++ b/api/classes/ExpansionVertexChunk.html @@ -1,16 +1,16 @@ ExpansionVertexChunk | @masatomakino/threejs-shader-materials

    Class ExpansionVertexChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/FBMDissolveMaterial.html b/api/classes/FBMDissolveMaterial.html index 4d207d27..1042146b 100644 --- a/api/classes/FBMDissolveMaterial.html +++ b/api/classes/FBMDissolveMaterial.html @@ -1,6 +1,6 @@ FBMDissolveMaterial | @masatomakino/threejs-shader-materials

    Class FBMDissolveMaterial

    MeshPhongMaterialに準じるShaderMaterialクラス。

    See

    https://github.com/mrdoob/three.js/blob/76c64b23d422dcfb36a28353f45b1effa1f68c5a/src/renderers/shaders/ShaderLib.js#L53

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -100,7 +100,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -332,7 +332,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -340,8 +340,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    amp

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    edgeColor

    edgeWeight

    emissive

    hashLoop

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    amp

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    edgeColor

    edgeWeight

    emissive

    hashLoop

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -349,15 +349,15 @@

    opacity

    progress

    tiles

    uniformOpacity

    progress

    tiles

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -372,11 +372,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -387,13 +387,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, FBMDissolveMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/FBMFireMaterial.html b/api/classes/FBMFireMaterial.html index a88d568c..f542e91a 100644 --- a/api/classes/FBMFireMaterial.html +++ b/api/classes/FBMFireMaterial.html @@ -4,7 +4,7 @@
  • アニメーション再生/停止フラグisAnimate

    • のそれぞれの変数にアクセスできることを保証する。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -110,7 +110,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -267,7 +267,7 @@

    speed

    speed: number = -0.5

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -345,7 +345,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -353,9 +353,9 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    amp

    bloom

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    hashLoop

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    amp

    bloom

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    hashLoop

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -363,20 +363,20 @@

    opacity

    rimPow

    rimStrength

    strength

    tiles

    uniformOpacity

    rimPow

    rimStrength

    strength

    tiles

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -388,11 +388,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -403,13 +403,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, FBMFireMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/GLSLChunk.html b/api/classes/GLSLChunk.html index a1f3fc3b..cb98463d 100644 --- a/api/classes/GLSLChunk.html +++ b/api/classes/GLSLChunk.html @@ -1,16 +1,16 @@ GLSLChunk | @masatomakino/threejs-shader-materials

    Class GLSLChunkAbstract

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    • getDefines(): Object

    • Chunkに関連する定数Defineを格納したオブジェクトを取得する。

      +

      Returns string

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/HalftoneGridMaterial.html b/api/classes/HalftoneGridMaterial.html index 1e13795b..e7a33e99 100644 --- a/api/classes/HalftoneGridMaterial.html +++ b/api/classes/HalftoneGridMaterial.html @@ -1,5 +1,5 @@ HalftoneGridMaterial | @masatomakino/threejs-shader-materials

    Class HalftoneGridMaterial

    MaskMapをハーフトーン分解するマテリアル

    -

    Hierarchy

    • WavyGridMaterial
      • HalftoneGridMaterial

    Constructors

    constructor +

    Hierarchy

    • WavyGridMaterial
      • HalftoneGridMaterial

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -109,7 +109,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -119,7 +119,7 @@

    Default

    false
    -

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom +

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

    Default

    0
    @@ -225,7 +225,7 @@

    ReadonlyisShaderMaterial

    isShaderMaterial: true

    Read-only flag to check if a given object is of type ShaderMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false
+

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -266,7 +266,7 @@

    speed

    speed: number = -0.5

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -344,7 +344,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -353,9 +353,9 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      -

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      +

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -363,24 +363,24 @@

    opacity

    radius

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      -

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    radius

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      +

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 +

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 1の場合、幅1ヘックス 0.5の場合、幅2ヘックスになる

      -

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -391,11 +391,11 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

    Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -406,12 +406,12 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, HalftoneGridMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      +

      Returns void

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

        -

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/HexDissolveMaterial.html b/api/classes/HexDissolveMaterial.html index 3e2a216e..29167c87 100644 --- a/api/classes/HexDissolveMaterial.html +++ b/api/classes/HexDissolveMaterial.html @@ -1,5 +1,5 @@ HexDissolveMaterial | @masatomakino/threejs-shader-materials

    Class HexDissolveMaterial

    六角形グリッドマテリアル

    -

    Hierarchy

    • GridMaterial
      • HexDissolveMaterial

    Constructors

    constructor +

    Hierarchy

    • GridMaterial
      • HexDissolveMaterial

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -103,7 +103,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -335,7 +335,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -344,17 +344,17 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    delay

    delay

    • get delay(): number

    • ディゾルブの開始ずれを指定する。 最後にディゾルブが始まるグリッドが、progressのどの値で開始されるかを意味する。 ex) delay = 0.8の時、最後のグリッドはprogress = 0.8 ~ 1.0でディゾルブする。

      -

      Returns number

    • set delay(value: number): void

    • Parameters

      • value: number

      Returns void

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridEmissive

    gridEmissiveWeight

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridEmissive

    gridEmissiveWeight

    • get gridEmissiveWeight(): number

    • ディゾルブ中に表示されるグローラインの太さ 数値はグリッド線の太さの倍率、2.0ならグローアウトラインはディゾルブラインの倍の太さになる。

      注意 : isReversed = true かつgridEmissiveWeightが2.0以下の場合、グロー線が消えなくなる。 反転させる場合は、2.0以上を指定すること。

      -

      Returns number

    • set gridEmissiveWeight(value: number): void

    • Parameters

      • value: number

      Returns void

    gridWeight

    gridWeight

    isAscending

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    isAscending

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -362,17 +362,17 @@

    opacity

    progress

    progress

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -386,11 +386,11 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

    Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -401,13 +401,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, HexDissolveMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      +

      Returns void

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    • getBasicUniforms(): any

    • このMaterialに必要なuniformsを生成する。

      -

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/HexGridChunk.html b/api/classes/HexGridChunk.html index 7e577b1b..06f2bc54 100644 --- a/api/classes/HexGridChunk.html +++ b/api/classes/HexGridChunk.html @@ -1,16 +1,16 @@ HexGridChunk | @masatomakino/threejs-shader-materials

    Class HexGridChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/HexGridMaterial.html b/api/classes/HexGridMaterial.html index a8b4542b..32eff69a 100644 --- a/api/classes/HexGridMaterial.html +++ b/api/classes/HexGridMaterial.html @@ -1,5 +1,5 @@ HexGridMaterial | @masatomakino/threejs-shader-materials

    Class HexGridMaterial

    六角形グリッドマテリアル

    -

    Hierarchy

    • WavyGridMaterial
      • HexGridMaterial

    Constructors

    constructor +

    Hierarchy

    • WavyGridMaterial
      • HexGridMaterial

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -109,7 +109,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -119,7 +119,7 @@

    Default

    false
    -

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom +

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

    Default

    0
    @@ -225,7 +225,7 @@

    ReadonlyisShaderMaterial

    isShaderMaterial: true

    Read-only flag to check if a given object is of type ShaderMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false
+

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -266,7 +266,7 @@

    speed

    speed: number = -0.5

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -344,7 +344,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -353,11 +353,11 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      -

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns number

    • set gridWeight(value: number): void

    • Parameters

      • value: number

      Returns void

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      +

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -365,24 +365,24 @@

    opacity

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      -

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      +

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 +

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 1の場合、幅1ヘックス 0.5の場合、幅2ヘックスになる

      -

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -393,11 +393,11 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

    Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -408,12 +408,12 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, HexGridMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      +

      Returns void

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

        -

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/MapChunk.html b/api/classes/MapChunk.html index 7e8e9195..3a56ebed 100644 --- a/api/classes/MapChunk.html +++ b/api/classes/MapChunk.html @@ -1,6 +1,6 @@ MapChunk | @masatomakino/threejs-shader-materials

    Class MapChunk

    マスクテクスチャを利用するShaderMaterial用Chunk。 マスクテクスチャがどのように描画に反映されるかは、各Materialのシェーダー実装による。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines @@ -9,10 +9,10 @@ registerChunk setMap

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetMap

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetMap

    StaticgetUniform

    StaticregisterChunk

    StaticsetMap

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    StaticsetMap

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/MaskMapChunk.html b/api/classes/MaskMapChunk.html index 6c9e1c6a..0b1a4850 100644 --- a/api/classes/MaskMapChunk.html +++ b/api/classes/MaskMapChunk.html @@ -1,6 +1,6 @@ MaskMapChunk | @masatomakino/threejs-shader-materials

    Class MaskMapChunk

    マスクテクスチャを利用するShaderMaterial用Chunk。 マスクテクスチャがどのように描画に反映されるかは、各Materialのシェーダー実装による。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines @@ -9,10 +9,10 @@ registerChunk setMaskTexture

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetMaskTexture

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetMaskTexture

    StaticgetUniform

    StaticregisterChunk

    StaticsetMaskTexture

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    StaticsetMaskTexture

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/MeshPhongChunk.html b/api/classes/MeshPhongChunk.html index ca75ca4e..c279ce7d 100644 --- a/api/classes/MeshPhongChunk.html +++ b/api/classes/MeshPhongChunk.html @@ -1,15 +1,15 @@ MeshPhongChunk | @masatomakino/threejs-shader-materials

    Class MeshPhongChunk

    MeshPhongMaterialと同等の機能を備えたShaderMaterialを実装するために必要なGLSLコードを格納したクラス。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/OuterGlowMaterial.html b/api/classes/OuterGlowMaterial.html index 93c81c23..9eea48e7 100644 --- a/api/classes/OuterGlowMaterial.html +++ b/api/classes/OuterGlowMaterial.html @@ -1,6 +1,6 @@ OuterGlowMaterial | @masatomakino/threejs-shader-materials

    Class OuterGlowMaterial

    モデルの外周を発光させるマテリアル。 縁の発光と膨張を掛け合わせて、元のモデルの周辺を発光させる。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -101,7 +101,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -333,7 +333,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -342,7 +342,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    expansionStrength

    insideColor

    insidePow

    insideStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    expansionStrength

    insideColor

    insidePow

    insideStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -350,15 +350,15 @@

    opacity

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -373,11 +373,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -388,13 +388,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, OuterGlowMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/RepeatPatternChunk.html b/api/classes/RepeatPatternChunk.html index 2873e1e9..69c6bf8d 100644 --- a/api/classes/RepeatPatternChunk.html +++ b/api/classes/RepeatPatternChunk.html @@ -1,16 +1,16 @@ RepeatPatternChunk | @masatomakino/threejs-shader-materials

    Class RepeatPatternChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/ReversibleChunk.html b/api/classes/ReversibleChunk.html index 2ee7fe3a..39d24a8f 100644 --- a/api/classes/ReversibleChunk.html +++ b/api/classes/ReversibleChunk.html @@ -1,16 +1,16 @@ ReversibleChunk | @masatomakino/threejs-shader-materials

    Class ReversibleChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/RimBasicMaterial.html b/api/classes/RimBasicMaterial.html index 67c2d99a..7472f83f 100644 --- a/api/classes/RimBasicMaterial.html +++ b/api/classes/RimBasicMaterial.html @@ -1,5 +1,5 @@ RimBasicMaterial | @masatomakino/threejs-shader-materials

    Class RimBasicMaterial

    MeshBasicMaterialに準じたShaderMaterial

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -91,7 +91,7 @@ toJSON getBasicUniforms getRimUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -335,12 +335,12 @@

    Parameters

    • value: number

    Returns void

    Default

    0
    -

    color

    insideColor

    insidePow

    insideStrength

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    color

    insideColor

    insidePow

    insideStrength

    needsUpdate

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimBasicMaterial>,
      ): void

    • Adds a listener to an event type.

      +

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimBasicMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, RimBasicMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -354,7 +354,7 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimBasicMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, RimBasicMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    initDefines

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

    Returns boolean

    initDefines

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -373,4 +373,4 @@

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    StaticgetRimUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    StaticgetRimUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/RimEffectMaterial.html b/api/classes/RimEffectMaterial.html index fee1c07c..487f6ec4 100644 --- a/api/classes/RimEffectMaterial.html +++ b/api/classes/RimEffectMaterial.html @@ -1,6 +1,6 @@ RimEffectMaterial | @masatomakino/threejs-shader-materials

    Class RimEffectMaterial

    MeshPhongMaterialに準じるShaderMaterialクラス。

    See

    https://github.com/mrdoob/three.js/blob/76c64b23d422dcfb36a28353f45b1effa1f68c5a/src/renderers/shaders/ShaderLib.js#L53

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -100,7 +100,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -332,7 +332,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -341,7 +341,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    insideColor

    insidePow

    insideStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    insideColor

    insidePow

    insideStrength

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -349,15 +349,15 @@

    opacity

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    rimColor

    rimPow

    rimStrength

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -372,11 +372,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -387,13 +387,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, RimEffectMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ShaderBasicMaterial.html b/api/classes/ShaderBasicMaterial.html index 2ad66c0f..acbaa773 100644 --- a/api/classes/ShaderBasicMaterial.html +++ b/api/classes/ShaderBasicMaterial.html @@ -1,5 +1,5 @@ ShaderBasicMaterial | @masatomakino/threejs-shader-materials

    Class ShaderBasicMaterial

    MeshBasicMaterialに準じたShaderMaterial

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -84,7 +84,7 @@ setValues toJSON getBasicUniforms -

    Constructors

    constructor

    • new ShaderBasicMaterial(
          vertexShader: string,
          fragmentShader: string,
          parameters?: ShaderMaterialParameters,
      ): ShaderBasicMaterial

    • Parameters

      • vertexShader: string
      • fragmentShader: string
      • Optionalparameters: ShaderMaterialParameters

      Returns ShaderBasicMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    • new ShaderBasicMaterial(
          vertexShader: string,
          fragmentShader: string,
          parameters?: ShaderMaterialParameters,
      ): ShaderBasicMaterial

    • Parameters

      • vertexShader: string
      • fragmentShader: string
      • Optionalparameters: ShaderMaterialParameters

      Returns ShaderBasicMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -328,12 +328,12 @@

    Parameters

    • value: number

    Returns void

    Default

    0
    -

    color

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    color

    needsUpdate

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderBasicMaterial>,
      ): void

    • Adds a listener to an event type.

      +

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderBasicMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderBasicMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -347,7 +347,7 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderBasicMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderBasicMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    initDefines

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

    Returns boolean

    initDefines

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -366,4 +366,4 @@

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ShaderLineMaterial.html b/api/classes/ShaderLineMaterial.html index 2aa7fd2d..055c58b8 100644 --- a/api/classes/ShaderLineMaterial.html +++ b/api/classes/ShaderLineMaterial.html @@ -1,4 +1,4 @@ -ShaderLineMaterial | @masatomakino/threejs-shader-materials

    Class ShaderLineMaterial

    Hierarchy

    • ShaderMaterial
      • ShaderLineMaterial

    Constructors

    constructor +ShaderLineMaterial | @masatomakino/threejs-shader-materials

    Class ShaderLineMaterial

    Hierarchy

    • ShaderMaterial
      • ShaderLineMaterial

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -84,7 +84,7 @@ removeEventListener setValues toJSON -

    Constructors

    constructor

    • new ShaderLineMaterial(
          vertexShader: string,
          fragmentShader: string,
          parameters?: ShaderMaterialParameters,
      ): ShaderLineMaterial

    • Parameters

      • vertexShader: string
      • fragmentShader: string
      • Optionalparameters: ShaderMaterialParameters

      Returns ShaderLineMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    • new ShaderLineMaterial(
          vertexShader: string,
          fragmentShader: string,
          parameters?: ShaderMaterialParameters,
      ): ShaderLineMaterial

    • Parameters

      • vertexShader: string
      • fragmentShader: string
      • Optionalparameters: ShaderMaterialParameters

      Returns ShaderLineMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -328,12 +328,12 @@

    Parameters

    • value: number

    Returns void

    Default

    0
    -

    color

    dashSize

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    color

    dashSize

    needsUpdate

    scale

    totalSize

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderLineMaterial>,
      ): void

    • Adds a listener to an event type.

      +

    scale

    totalSize

    uniformOpacity

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderLineMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderLineMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -327,7 +327,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -336,7 +336,7 @@

    color

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -344,15 +344,15 @@

    opacity

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -367,11 +367,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

      Returns void

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -382,13 +382,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderPhongMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/ShaderSpriteMaterial.html b/api/classes/ShaderSpriteMaterial.html index 2eef4546..3565e004 100644 --- a/api/classes/ShaderSpriteMaterial.html +++ b/api/classes/ShaderSpriteMaterial.html @@ -1,4 +1,4 @@ -ShaderSpriteMaterial | @masatomakino/threejs-shader-materials

    Class ShaderSpriteMaterial

    Hierarchy (View Summary)

    Constructors

    constructor +ShaderSpriteMaterial | @masatomakino/threejs-shader-materials

    Class ShaderSpriteMaterial

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -93,7 +93,7 @@ setValues toJSON

    Constructors

    constructor

    • new ShaderSpriteMaterial(
          vertexShader: string,
          fragmentShader: string,
          parameters?: ShaderMaterialParameters,
      ): ShaderSpriteMaterial

    • コンストラクタ。

      -

      Parameters

      • vertexShader: string
      • fragmentShader: string
      • Optionalparameters: ShaderMaterialParameters

      Returns ShaderSpriteMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Parameters

    • vertexShader: string
    • fragmentShader: string
    • Optionalparameters: ShaderMaterialParameters

    Returns ShaderSpriteMaterial

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -212,7 +212,7 @@

    ReadonlyisSpriteMaterial

    isSpriteMaterial: true

    Read-only flag to check if a given object is of type SpriteMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    lights

    lights: boolean

    Default

    false
+

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -253,7 +253,7 @@

    sizeAttenuation

    sizeAttenuation: boolean = true

    Default

    true
    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -331,7 +331,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -339,8 +339,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    center

    color

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    center

    color

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -348,14 +348,14 @@

    opacity

    rotation

    uniformOpacity

    rotation

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    uvTransform

    Methods

    addEventListener

    uvTransform

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, ShaderSpriteMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderSpriteMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -370,11 +370,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, ShaderSpriteMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

      Returns void

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). diff --git a/api/classes/SkyCloudMaterial.html b/api/classes/SkyCloudMaterial.html index 04aab9e5..94dec7a3 100644 --- a/api/classes/SkyCloudMaterial.html +++ b/api/classes/SkyCloudMaterial.html @@ -4,7 +4,7 @@

    • アニメーション再生/停止フラグisAnimate

    のそれぞれの変数にアクセスできることを保証する。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -109,7 +109,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -266,7 +266,7 @@

    speed

    speed: number = -0.02

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -344,7 +344,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -352,8 +352,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    cloudBottomSaturation

    cloudBottomVolume

    cloudTransformSpeed

    cloudVolume

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    cloudBottomSaturation

    cloudBottomVolume

    cloudTransformSpeed

    cloudVolume

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -361,20 +361,20 @@

    opacity

    scale

    skyColor

    uniformOpacity

    scale

    skyColor

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -386,11 +386,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -401,13 +401,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, SkyCloudMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/SolidClippingMaterial.html b/api/classes/SolidClippingMaterial.html index b4767676..d54a3db4 100644 --- a/api/classes/SolidClippingMaterial.html +++ b/api/classes/SolidClippingMaterial.html @@ -1,6 +1,6 @@ SolidClippingMaterial | @masatomakino/threejs-shader-materials

    Class SolidClippingMaterial

    MeshPhongMaterialに準じるShaderMaterialクラス。

    See

    https://github.com/mrdoob/three.js/blob/76c64b23d422dcfb36a28353f45b1effa1f68c5a/src/renderers/shaders/ShaderLib.js#L53

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -95,7 +95,7 @@ startGlow toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -327,7 +327,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -336,7 +336,7 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    cutSectionColor

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    cutSectionColor

    emissive

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -344,15 +344,15 @@

    opacity

    uniformOpacity

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -367,11 +367,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -382,13 +382,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, SolidClippingMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    startGlow

    toJSON

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/SpriteChunk.html b/api/classes/SpriteChunk.html index 38adadc6..0f14e732 100644 --- a/api/classes/SpriteChunk.html +++ b/api/classes/SpriteChunk.html @@ -1,15 +1,15 @@ SpriteChunk | @masatomakino/threejs-shader-materials

    Class SpriteChunk

    SpriteMaterialと同等の機能を備えたShaderMaterialを実装するために必要なGLSLコードを格納したクラス。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/SpriteCloudMaterial.html b/api/classes/SpriteCloudMaterial.html index 92eed8ce..a09e5543 100644 --- a/api/classes/SpriteCloudMaterial.html +++ b/api/classes/SpriteCloudMaterial.html @@ -1,4 +1,4 @@ -SpriteCloudMaterial | @masatomakino/threejs-shader-materials

    Class SpriteCloudMaterial

    Hierarchy (View Summary)

    Constructors

    constructor +SpriteCloudMaterial | @masatomakino/threejs-shader-materials

    Class SpriteCloudMaterial

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -98,7 +98,7 @@ removeEventListener setValues toJSON -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -217,7 +217,7 @@

    ReadonlyisSpriteMaterial

    isSpriteMaterial: true

    Read-only flag to check if a given object is of type SpriteMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    lights

    lights: boolean

    Default

    false
+

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -258,7 +258,7 @@

    sizeAttenuation

    sizeAttenuation: boolean = true

    Default

    true
    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -336,7 +336,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -344,8 +344,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    bottomStrength

    center

    color

    • get color(): Color

    • Spriteマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    bottomStrength

    center

    color

    • get color(): Color

    • Spriteマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -353,14 +353,14 @@

    opacity

    rimCenter

    rimColor

    rimRange

    rimStrength

    rotation

    skyColor

    uniformOpacity

    rimCenter

    rimColor

    rimRange

    rimStrength

    rotation

    skyColor

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    uvTransform

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SpriteCloudMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    uvTransform

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SpriteCloudMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SpriteCloudMaterial>

        The function that gets called when the event is fired.

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      @@ -375,11 +375,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SpriteCloudMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). diff --git a/api/classes/SquareGridMaterial.html b/api/classes/SquareGridMaterial.html index 26ec5ea3..5e487a4d 100644 --- a/api/classes/SquareGridMaterial.html +++ b/api/classes/SquareGridMaterial.html @@ -1,5 +1,5 @@ SquareGridMaterial | @masatomakino/threejs-shader-materials

      Class SquareGridMaterial

      四角形グリッドマテリアル

      -

      Hierarchy

      • WavyGridMaterial
        • SquareGridMaterial

      Constructors

      constructor +

      Hierarchy

      • WavyGridMaterial
        • SquareGridMaterial

      Constructors

      constructor

      Properties

      _opacity alphaHash alphaToCoverage @@ -109,7 +109,7 @@ stopAnimation toJSON getBasicUniforms -

      Constructors

      constructor

      Properties

      Protected_opacity

      _opacity: number = 1.0

      alphaHash

      alphaHash: boolean

      Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

      Constructors

      constructor

      Properties

      Protected_opacity

      _opacity: number = 1.0

      alphaHash

      alphaHash: boolean

      Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

      @@ -119,7 +119,7 @@

      Default

      false
      -

      ProtectedanimationID

      animationID: number

      blendAlpha

      blendAlpha: number

      Represents the alpha value of the constant blend color. This property has only an effect when using custom +

    ProtectedanimationID

    animationID: number

    blendAlpha

    blendAlpha: number

    Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

    Default

    0
    @@ -225,7 +225,7 @@

    ReadonlyisShaderMaterial

    isShaderMaterial: true

    Read-only flag to check if a given object is of type ShaderMaterial.

    Remarks

    This is a constant value

    Default Value

    true

    -

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false
+

    ProtectedlastAnimatedTimestamp

    lastAnimatedTimestamp: number

    lights

    lights: boolean

    Default

    false

    linewidth

    linewidth: number

    Default

    1
@@ -266,7 +266,7 @@

    speed

    speed: number = -0.5

    波の速度 0.5にすると1の半分の速度になる。 マイナスを指定すると、波の進行方向が反転する。

    -

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -344,7 +344,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -353,11 +353,11 @@

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    direction

    division

    • get division(): number

    • Returns number

    • set division(value: number): void

    • Parameters

      • value: number

      Returns void

    divisionScaleX

    • get divisionScaleX(): number

    • Returns number

    • set divisionScaleX(value: number): void

    • Parameters

      • value: number

      Returns void

    emissive

    gridWeight

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      -

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    isAnimate

    • get isAnimate(): boolean

    • 波アニメーションを行うか否か。

      +

      Returns boolean

    • set isAnimate(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    isReversed

    • get isReversed(): boolean

    • Returns boolean

    • set isReversed(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    map

    maskTexture

    • get maskTexture(): Texture

    • Returns Texture

    • set maskTexture(val: Texture): void

    • Parameters

      • val: Texture

      Returns void

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -365,24 +365,24 @@

    opacity

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      -

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    raisedBottom

    • get raisedBottom(): number

    • 明るさの底上げ

      +

      Returns number

    • set raisedBottom(value: number): void

    • Parameters

      • value: number

      Returns void

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 +

      Parameters

      • value: number

      Returns void

    waveFrequency

    • get waveFrequency(): number

    • 波の振幅 1の場合、幅1ヘックス 0.5の場合、幅2ヘックスになる

      -

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Returns number

    • set waveFrequency(value: number): void

    • Parameters

      • value: number

      Returns void

    wavePow

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -393,11 +393,11 @@

      Returns void

    hasEventListener

    • hasEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>,
      ): boolean

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>

        The function that gets called when the event is fired.

        -

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 +

    Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -408,12 +408,12 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    • onSetAlphaMap(value: Texture): void

    • Parameters

      • value: Texture

      Returns void

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, SquareGridMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      +

      Returns void

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

        -

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/SurfaceNormalChunk.html b/api/classes/SurfaceNormalChunk.html index 2b43da6a..2019a077 100644 --- a/api/classes/SurfaceNormalChunk.html +++ b/api/classes/SurfaceNormalChunk.html @@ -1,16 +1,16 @@ SurfaceNormalChunk | @masatomakino/threejs-shader-materials

    Class SurfaceNormalChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/SurfaceNormalVaryingChunk.html b/api/classes/SurfaceNormalVaryingChunk.html index 9d9dde28..ac73351c 100644 --- a/api/classes/SurfaceNormalVaryingChunk.html +++ b/api/classes/SurfaceNormalVaryingChunk.html @@ -1,16 +1,16 @@ SurfaceNormalVaryingChunk | @masatomakino/threejs-shader-materials

    Class SurfaceNormalVaryingChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/SurfaceNormalVertexChunk.html b/api/classes/SurfaceNormalVertexChunk.html index 1e88a28d..448a583b 100644 --- a/api/classes/SurfaceNormalVertexChunk.html +++ b/api/classes/SurfaceNormalVertexChunk.html @@ -1,16 +1,16 @@ SurfaceNormalVertexChunk | @masatomakino/threejs-shader-materials

    Class SurfaceNormalVertexChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/SwirlMaterial.html b/api/classes/SwirlMaterial.html index d66fc43e..5485f4ff 100644 --- a/api/classes/SwirlMaterial.html +++ b/api/classes/SwirlMaterial.html @@ -4,7 +4,7 @@
  • アニメーション再生/停止フラグisAnimate

    • のそれぞれの変数にアクセスできることを保証する。

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor +

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    _opacity alphaHash alphaToCoverage @@ -107,7 +107,7 @@ stopAnimation toJSON getBasicUniforms -

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material +

    Constructors

    constructor

    Properties

    Protected_opacity

    _opacity: number = 1.0

    alphaHash

    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

    @@ -261,7 +261,7 @@

    side

    side: Side

    Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

    Default

    THREE.FrontSide

    -

    speed

    speed: number = -0.02

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    +

    speed

    speed: number = -0.02

    stencilFail

    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

    Default

    THREE.KeepStencilOp
    @@ -339,7 +339,7 @@

    wireframeLinewidth

    wireframeLinewidth: number

    Default

    1
    -

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      +

    Accessors

    alphaMap

    alphaTest

    • get alphaTest(): number

    • Gets the alpha value to be used when running an alpha test. Default is 0.

      Returns number

      Default

      0
      @@ -347,8 +347,8 @@

      Parameters

      • value: number

      Returns void

      Default

      0
      -

    center

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      -

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. +

    center

    color

    • get color(): Color

    • MeshPhongマテリアルと互換性を持つために、colorプロパティはdiffuseへ代入される。

      +

      Returns Color

    • set color(value: Color): void

    • Parameters

      • value: Color

      Returns void

    emissive

    isAnimate

    map

    needsUpdate

    • set needsUpdate(value: boolean): void

    • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

      Parameters

      • value: boolean

      Returns void

      Default

      false
      @@ -356,20 +356,20 @@

    opacity

    radius

    swirlRotation

    uniformOpacity

    radius

    swirlRotation

    uniformOpacity

    • get uniformOpacity(): number

    • 透明度

      +

      Returns number

    • set uniformOpacity(value: number): void

    • 透明度 opacityは基底クラスのMaterialのコンストラクタ内で明示的に1.0が代入される。 この段階でuniformsはundefinedなので、そのままでは初期化できない。 このsetterでは受け取った値をprivate変数に保存して、初期化後にuniformsに再代入する。

      -

      Parameters

      • value: number

      Returns void

    uvRotation

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>,
      ): void

    • Adds a listener to an event type.

      +

      Parameters

      • value: number

      Returns void

    uvRotation

    Methods

    addEventListener

    • addEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>,
      ): void

    • Adds a listener to an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>

        The function that gets called when the event is fired.

      Returns void

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      +

    Returns void

    clone

    • clone(): this

    • Return a new material with the same parameters as this material.

      Returns this

    copy

    • copy(material: Material): this

    • Copy the parameters from the passed material into this material.

      Parameters

      • material: Material

      Returns this

    customProgramCacheKey

    • customProgramCacheKey(): string

    • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

      Returns string

    dispatchEvent

    • dispatchEvent<T extends "dispose">(
          event: BaseEvent<T> & { dispose: {} }[T],
      ): void

    • Fire an event type.

      @@ -381,11 +381,11 @@

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>

        The function that gets called when the event is fired.

      Returns boolean

    ProtectedinitChunks

    ProtectedinitDefaultSetting

    ProtectedinitDefaultSetting

    • initDefaultSetting(parameters?: ShaderMaterialParameters): void

    • 1.オプションで指定されなかったパラメーター値を補完する。 2.uniformsに代入する必要のあるパラメーターを明示的に代入する。

      -

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. +

      Parameters

      • Optionalparameters: ShaderMaterialParameters

      Returns void

    ProtectedinitDefines

    ProtectedinitUniforms

    onBeforeCompile

    • onBeforeCompile(
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). @@ -396,13 +396,13 @@ Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry<NormalBufferAttributes>
      • object: Object3D<Object3DEventMap>
      • group: Group<Object3DEventMap>

      Returns void

    onBuild

    • onBuild(
          object: Object3D<Object3DEventMap>,
          parameters: WebGLProgramParametersWithUniforms,
          renderer: WebGLRenderer,
      ): void

    • Parameters

      • object: Object3D<Object3DEventMap>
      • parameters: WebGLProgramParametersWithUniforms
      • renderer: WebGLRenderer

      Returns void

      Deprecated

      onBuild() has been removed.

      -

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>,
      ): void

    • Removes a listener from an event type.

      +

    ProtectedonSetAlphaMap

    ProtectedonSetMap

    removeEventListener

    • removeEventListener<T extends "dispose">(
          type: T,
          listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>,
      ): void

    • Removes a listener from an event type.

      Type Parameters

      • T extends "dispose"

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{ dispose: {} }[T], T, SwirlMaterial>

        The listener function that gets removed.

      Returns void

    setValues

    • setValues(parameters: ShaderMaterialParameters): void

    • Sets the properties based on the values.

      -

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    • startGlow(): void

    • 発光状態のために、マテリアルの設定をまとめて変更する。 +

      Parameters

      • parameters: ShaderMaterialParameters

      Returns void

    ProtectedstartAnimation

    startGlow

    ProtectedstopAnimation

    toJSON

    ProtectedstopAnimation

    toJSON

    • toJSON(meta?: JSONMeta): ShaderMaterialJSON

    • Convert the material to three.js JSON format.

      Parameters

      • Optionalmeta: JSONMeta

        Object containing metadata such as textures or images for the material.

      Returns ShaderMaterialJSON

    StaticgetBasicUniforms

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/api/classes/TilingFBMChunk.html b/api/classes/TilingFBMChunk.html index 29247701..c774f4ca 100644 --- a/api/classes/TilingFBMChunk.html +++ b/api/classes/TilingFBMChunk.html @@ -1,16 +1,16 @@ TilingFBMChunk | @masatomakino/threejs-shader-materials

    Class TilingFBMChunk

    ShaderChunkに登録を行うGLSLのコード片を格納するクラス。 GLSLコードの共有化を目的とする。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    getChunk getChunkName getDefines getUniform registerChunk

    Constructors

    constructor

    Methods

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): any

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/classes/WavyAnimationChunk.html b/api/classes/WavyAnimationChunk.html index 4bc75cb3..e10ec877 100644 --- a/api/classes/WavyAnimationChunk.html +++ b/api/classes/WavyAnimationChunk.html @@ -1,18 +1,18 @@ WavyAnimationChunk | @masatomakino/threejs-shader-materials

    Class WavyAnimationChunk

    IWaveAnimatableインターフェースで定義されたアニメーションを実装するためのGLSLチャンク。 実行にはグリッドid値が必要。idはvec2。 結果はdiffuseColor.aに反映される。

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    addTime getChunk getChunkName getDefines getUniform registerChunk -

    Constructors

    constructor

    Methods

    StaticaddTime

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    • getDefines(): Object

    • Chunkに関連する定数Defineを格納したオブジェクトを取得する。

      +

    Constructors

    constructor

    Methods

    StaticaddTime

    Protected StaticgetChunk

    Protected StaticgetChunkName

    StaticgetDefines

    StaticgetUniform

    • getUniform(): {
          direction: { value: Directions };
          isAnimate: { value: boolean };
          raisedBottom: { value: number };
          time: { value: number };
          waveFrequency: { value: number };
          wavePow: { value: number };
      }

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      +

    StaticgetUniform

    • getUniform(): {
          direction: { value: Directions };
          isAnimate: { value: boolean };
          raisedBottom: { value: number };
          time: { value: number };
          waveFrequency: { value: number };
          wavePow: { value: number };
      }

    • Chunkに関連する共有変数Uniformsを格納したオブジェクトを取得する。

      Returns {
          direction: { value: Directions };
          isAnimate: { value: boolean };
          raisedBottom: { value: number };
          time: { value: number };
          waveFrequency: { value: number };
          wavePow: { value: number };
      }

      See

      https://threejs.org/docs/#api/en/materials/ShaderMaterial.uniforms

      -

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    StaticregisterChunk

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/api/enums/Directions.html b/api/enums/Directions.html index 620b6930..07bdc9ae 100644 --- a/api/enums/Directions.html +++ b/api/enums/Directions.html @@ -1,6 +1,6 @@ Directions | @masatomakino/threejs-shader-materials

    Enumeration Directions

    Wavyアニメーションの波及方向を示すenum。

    -

    Enumeration Members

    horizontal +

    Enumeration Members

    horizontal radial vertical -

    Enumeration Members

    horizontal

    horizontal: 3

    radial

    radial: 5

    id値(0,0)を中心に同心円状に波及する。

    -

    vertical

    vertical: 4

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    horizontal

    horizontal: 3

    radial

    radial: 5

    id値(0,0)を中心に同心円状に波及する。

    +

    vertical

    vertical: 4

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/api/interfaces/IAnimatable.html b/api/interfaces/IAnimatable.html index 645a62a5..254cf1b4 100644 --- a/api/interfaces/IAnimatable.html +++ b/api/interfaces/IAnimatable.html @@ -4,10 +4,10 @@
  • アニメーション再生/停止フラグisAnimate

    • のそれぞれの変数にアクセスできることを保証する。

    -
    interface IAnimatable {
        isAnimate: boolean;
        speed: number;
        uniforms: { [uniform: string]: IUniform<any> };
        addTime(delta: number): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Properties

    isAnimate +
    interface IAnimatable {
        isAnimate: boolean;
        speed: number;
        uniforms: { [uniform: string]: IUniform<any> };
        addTime(delta: number): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Properties

    isAnimate speed uniforms

    Methods

    addTime -

    Properties

    isAnimate

    isAnimate: boolean

    speed

    speed: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Methods

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      +

    Properties

    isAnimate

    isAnimate: boolean

    speed

    speed: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Methods

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/IExpandable.html b/api/interfaces/IExpandable.html index e5a8cd6f..d212289f 100644 --- a/api/interfaces/IExpandable.html +++ b/api/interfaces/IExpandable.html @@ -1,3 +1,3 @@ -IExpandable | @masatomakino/threejs-shader-materials

    Interface IExpandable

    interface IExpandable {
        expansionStrength: number;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Implemented by

    Properties

    expansionStrength +IExpandable | @masatomakino/threejs-shader-materials

    Interface IExpandable

    interface IExpandable {
        expansionStrength: number;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Implemented by

    Properties

    expansionStrength uniforms -

    Properties

    expansionStrength

    expansionStrength: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    expansionStrength

    expansionStrength: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IMap.html b/api/interfaces/IMap.html index 469a3a62..7a35813c 100644 --- a/api/interfaces/IMap.html +++ b/api/interfaces/IMap.html @@ -3,6 +3,6 @@
  • maskTexture変数

    • にアクセス可能なことを保証する。

    -
    interface IMap {
        map: Texture;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Implemented by

    Properties

    map +
    interface IMap {
        map: Texture;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Implemented by

    Properties

    map uniforms -

    Properties

    map

    map: Texture

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    map

    map: Texture

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IMaskable.html b/api/interfaces/IMaskable.html index b02b4da5..3b1862b1 100644 --- a/api/interfaces/IMaskable.html +++ b/api/interfaces/IMaskable.html @@ -3,8 +3,8 @@
  • maskTexture変数

    • にアクセス可能なことを保証する。

    -
    interface IMaskable {
        division: number;
        divisionScaleX: number;
        maskTexture: Texture;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Hierarchy (View Summary)

    Properties

    division +
    interface IMaskable {
        division: number;
        divisionScaleX: number;
        maskTexture: Texture;
        uniforms: { [uniform: string]: IUniform<any> };
    }

    Hierarchy (View Summary)

    Properties

    division divisionScaleX maskTexture uniforms -

    Properties

    division

    division: number

    divisionScaleX

    divisionScaleX: number

    maskTexture

    maskTexture: Texture

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    division

    division: number

    divisionScaleX

    divisionScaleX: number

    maskTexture

    maskTexture: Texture

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IRepeatablePattern.html b/api/interfaces/IRepeatablePattern.html index b0387b18..7f341e2d 100644 --- a/api/interfaces/IRepeatablePattern.html +++ b/api/interfaces/IRepeatablePattern.html @@ -3,6 +3,6 @@
  • グリッドの分割数

    • にアクセス可能なことを保証する。

    -
    interface IRepeatablePattern {
        division: number;
        divisionScaleX: number;
    }

    Hierarchy (View Summary)

    Properties

    division +
    interface IRepeatablePattern {
        division: number;
        divisionScaleX: number;
    }

    Hierarchy (View Summary)

    Properties

    division divisionScaleX -

    Properties

    division

    division: number

    divisionScaleX

    divisionScaleX: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    division

    division: number

    divisionScaleX

    divisionScaleX: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IReversible.html b/api/interfaces/IReversible.html index 094ef3e5..d24c4328 100644 --- a/api/interfaces/IReversible.html +++ b/api/interfaces/IReversible.html @@ -1,4 +1,4 @@ IReversible | @masatomakino/threejs-shader-materials

    Interface IReversible

    反転可能なマテリアル用のインターフェース。 反転フラグにアクセス可能なことを保証する。

    -
    interface IReversible {
        isReversed: boolean;
    }

    Properties

    isReversed -

    Properties

    isReversed

    isReversed: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface IReversible {
        isReversed: boolean;
    }

    Properties

    isReversed +

    Properties

    isReversed

    isReversed: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ITiledFBM.html b/api/interfaces/ITiledFBM.html index b8b409e3..4e2d2aba 100644 --- a/api/interfaces/ITiledFBM.html +++ b/api/interfaces/ITiledFBM.html @@ -1,4 +1,4 @@ -ITiledFBM | @masatomakino/threejs-shader-materials

    Interface ITiledFBM

    interface ITiledFBM {
        amp: number;
        hashLoop: number;
        tiles: number;
    }

    Implemented by

    Properties

    amp +ITiledFBM | @masatomakino/threejs-shader-materials

    Interface ITiledFBM

    interface ITiledFBM {
        amp: number;
        hashLoop: number;
        tiles: number;
    }

    Implemented by

    Properties

    amp hashLoop tiles -

    Properties

    amp

    amp: number

    hashLoop

    hashLoop: number

    tiles

    tiles: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    amp

    amp: number

    hashLoop

    hashLoop: number

    tiles

    tiles: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/IWavyAnimatable.html b/api/interfaces/IWavyAnimatable.html index 96b07103..77d833eb 100644 --- a/api/interfaces/IWavyAnimatable.html +++ b/api/interfaces/IWavyAnimatable.html @@ -5,7 +5,7 @@
  • 波及する方向

    • にアクセスできることを保証する。

    -
    interface IWavyAnimatable {
        direction: Directions;
        isAnimate: boolean;
        raisedBottom: number;
        speed: number;
        uniforms: { [uniform: string]: IUniform<any> };
        waveFrequency: number;
        wavePow: number;
        addTime(delta: number): void;
    }

    Hierarchy (View Summary)

    Properties

    direction +
    interface IWavyAnimatable {
        direction: Directions;
        isAnimate: boolean;
        raisedBottom: number;
        speed: number;
        uniforms: { [uniform: string]: IUniform<any> };
        waveFrequency: number;
        wavePow: number;
        addTime(delta: number): void;
    }

    Hierarchy (View Summary)

    Properties

    direction isAnimate raisedBottom speed @@ -13,6 +13,6 @@ waveFrequency wavePow

    Methods

    addTime -

    Properties

    direction

    direction: Directions

    isAnimate

    isAnimate: boolean

    raisedBottom

    raisedBottom: number

    speed

    speed: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    waveFrequency

    waveFrequency: number

    wavePow

    wavePow: number

    Methods

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      +

    Properties

    direction

    direction: Directions

    isAnimate

    isAnimate: boolean

    raisedBottom

    raisedBottom: number

    speed

    speed: number

    uniforms

    uniforms: { [uniform: string]: IUniform<any> }

    waveFrequency

    waveFrequency: number

    wavePow

    wavePow: number

    Methods

    addTime

    • addTime(delta: number): void

    • 経過時間を追加する。uniformのtimeにはdelta * speedの値が加算される。speedに負の値を設定すると、アニメーションの進行方向は反転する。

      Parameters

      • delta: number

        前回アニメーション実行時からの差分時間 単位 : 秒

        -

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods