@rendley/sdk - v1.15.5
    Preparing search index...

    Class EffectData

    Library description of a reusable effect, including shader source, editable properties, and input textures.

    Effect data is the factory-level definition; clip-level Effect instances are created from it later with concrete property values and loaded Pixi textures.

    Index

    Constructors

    constructor

    Methods

    createEffectInstance createPixiTexture getDefaultPropertyMap getId getInputTextures getIsBuiltIn getIsSerializable getName getProperties getProvider getTextureImage init serialize deserialize

    Constructors

    Methods

    • Creates a runtime effect instance using the provided property map and resolved input textures.

      Built-in effects are dispatched through BuiltInFactory; custom shader effects fall back to a generic Pixi filter.

      Parameters

      • initPropertyMap: Map<string, any>

        Initial property values keyed by property name.

      • inputTextures: Record<string, Texture>

        Resolved Pixi textures keyed by uniform/input name.

      Returns null | EffectBase

      Runtime effect instance ready to attach to a clip.

    • Returns ReadonlyMap<string, any>

    • Returns string

    • Returns boolean

    • Returns boolean

    • Returns string

    • Returns string

    • Parameters

      • name: string

      Returns undefined | ImageBitmap

    • Loads any external input textures referenced by the effect definition.

      Returns Promise<void>

      A promise that resolves after all declared input textures are available.

    • Serializes the effect definition into project-safe data.

      Returns {
          autoFit?: boolean;
          blendMode?: NORMAL | ADD | SCREEN | MULTIPLY;
          fragmentSrc: string;
          id: string;
          inputTextures?: {
              mipmap?: OFF | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          noTransform?: boolean;
          padding?: number;
          properties: {
              defaultValue: Required<any>;
              description?: string;
              initOnly?: boolean;
              label?: string;
              max?: number | number[];
              min?: number | number[];
              name: string;
              step?: number | number[];
              type: PropertyDescriptionTypeEnum;
          }[];
          provider: string;
      }

      Serialized effect definition payload.

    • Reconstructs an effect definition from serialized data.

      Parameters

      • data: any

        Serialized effect definition payload.

      Returns EffectData

      Deserialized effect definition.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods