Skip to main content

Effect

Description:

  A class for managing multiple render pass objects. Effect objects allow you to combine multiple passes to create more complex shader effects.

Class Object: Effect Class.

Inherits from: Object.

add

Type: Function.

Description:

  A function that adds a Pass object to this Effect.

Signature:

add: function(self: Effect, pass: Pass)

Parameters:

ParameterTypeDescription
passPassThe Pass object to add.

get

Type: Function.

Description:

  A function that retrieves a Pass object from this Effect by index.

Signature:

get: function(self: Effect, index: integer): Pass

Parameters:

ParameterTypeDescription
indexintegerThe index of the Pass object to retrieve.

Returns:

Return TypeDescription
PassThe Pass object at the given index.

clear

Type: Function.

Description:

  A function that removes all Pass objects from this Effect.

Signature:

clear: function(self: Effect)