Class UniformsGroup<TEventMap>

Index

Constructors

constructor

Properties

id isUniformsGroup uniforms usage

Methods

add addEventListener clone copy dispatchEvent dispose hasEventListener remove removeEventListener setName setUsage

Constructors

constructor

new UniformsGroup<
TEventMap extends UniformsGroupEventMap = UniformsGroupEventMap,
>(): UniformsGroup<TEventMap>
Type Parameters
- TEventMap extends UniformsGroupEventMap = UniformsGroupEventMap
Returns UniformsGroup<TEventMap>
Overrides EventDispatcher.constructor
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:16

Properties

id

id: number

`Readonly`isUniformsGroup

isUniformsGroup: true

uniforms

uniforms: (Uniform<any> | Uniform<any>[])[]

usage

usage: Usage

Methods

add

add(uniform: Uniform<any> | Uniform<any>[]): this
Parameters
- uniform: Uniform<any> | Uniform<any>[]
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:26

addEventListener

addEventListener<T extends string>(
type: T,
listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>,
): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/EventDispatcher.d.ts:52

clone

clone(): UniformsGroup
Returns UniformsGroup
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:38

copy

copy(source: UniformsGroup): this
Parameters
- source: UniformsGroup
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:36

dispatchEvent

dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void
Fire an event type.
Type Parameters
- T extends string
Parameters
- event: BaseEvent<T> & TEventMap[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(): this
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:34

hasEventListener

hasEventListener<T extends string>(
type: T,
listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/EventDispatcher.d.ts:62

remove

remove(uniform: Uniform<any> | Uniform<any>[]): this
Parameters
- uniform: Uniform<any> | Uniform<any>[]
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:28

removeEventListener

removeEventListener<T extends string>(
type: T,
listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>,
): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<TEventMap[T], T, UniformsGroup<TEventMap>>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/EventDispatcher.d.ts:72

setName

setName(name: string): this
Parameters
- name: string
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:30

setUsage

setUsage(value: Usage): this
Parameters
- value: Usage
Returns this
- Defined in node_modules/.pnpm/@types+three@0.184.1/node_modules/@types/three/src/core/UniformsGroup.d.ts:32

Class UniformsGroup<TEventMap>

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns UniformsGroup<TEventMap>

Properties

id

ReadonlyisUniformsGroup

uniforms

usage

Methods

add

Parameters

Returns this

addEventListener

Type Parameters

Parameters

Returns void

clone

Returns UniformsGroup

copy

Parameters

Returns this

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns this

hasEventListener

Type Parameters

Parameters

Returns boolean

remove

Parameters

Returns this

removeEventListener

Type Parameters

Parameters

Returns void

setName

Parameters

Returns this

setUsage

Parameters

Returns this

Settings

On This Page

`Readonly`isUniformsGroup