Class BlendMode

A blend mode.

Hierarchy

EventDispatcher<Event>
- BlendMode

Index

Constructors

Properties

Accessors

Methods

addEventListener dispatchEvent getBlendFunction getOpacity getShaderCode hasEventListener removeEventListener setBlendFunction setOpacity

Constructors

constructor

new BlendMode(blendFunction, opacity?): BlendMode
Constructs a new blend mode.
Parameters
- blendFunction: BlendFunction
  
  The blend function.
- Optional opacity: number
  
  The opacity of the color that will be blended with the base color.
Returns BlendMode

Overrides EventDispatcher<import("three").Event>.constructor

Properties

opacity

opacity: Uniform<any>

A uniform that controls the opacity of this blend mode.

TODO Add opacity accessors for uniform value.

Accessors

blendFunction

get blendFunction(): BlendFunction
The blend function.

Returns BlendFunction
set blendFunction(value): void
Parameters
- value: BlendFunction
Returns void

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, BlendMode>
  
  The function that gets called when the event is fired.
Returns void

Inherited from EventDispatcher.addEventListener

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- event: BaseEvent<T> & Event<string, unknown>[T]
  
  The event that gets fired.
Returns void

Inherited from EventDispatcher.dispatchEvent

getBlendFunction

getBlendFunction(): BlendFunction
Returns the blend function.

Returns BlendFunction
The blend function.

Deprecated
Use blendFunction instead.

getOpacity

getOpacity(): number
Returns the opacity.

Returns number
The opacity.

getShaderCode

getShaderCode(): string
Returns the blend function shader code.

Returns string
The blend function shader code.

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, BlendMode>
  
  The function that gets called when the event is fired.
Returns boolean

Inherited from EventDispatcher.hasEventListener

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event<string, unknown>[T], T, BlendMode>
  
  The listener function that gets removed.
Returns void

Inherited from EventDispatcher.removeEventListener

setBlendFunction

setBlendFunction(value): void
Sets the blend function.
Parameters
- value: BlendFunction
  
  The blend function.
Returns void

Deprecated
Use blendFunction instead.

setOpacity

setOpacity(value): void
Sets the opacity.
Parameters
- value: number
  
  The opacity.
Returns void