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

    Class TransitionData

    Library description of a reusable GPU transition.

    Transition data packages fragment shader source, editable parameters, and optional input textures so timeline transitions can instantiate a Pixi filter at runtime with the correct uniforms.

    Index

    Constructors

    constructor

    Methods

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

    Constructors

    Methods

    • Creates the runtime Pixi filter used to render this transition.

      Parameters

      • initPropertyMap: Map<string, any>

        Initial uniform/property values keyed by property name.

      • inputTextures: Record<string, Texture>

        Additional textures keyed by sampler/uniform name.

      Returns Pixi.Filter

      Configured Pixi filter ready for transition rendering.

    • Creates a Pixi texture from one of the loaded transition input bitmaps.

      Parameters

      • name: string

        Input texture name declared in the transition descriptor.

      Returns null | Texture<Resource>

      Pixi texture for the input image, or null when the texture is unavailable.

    • Returns ReadonlyMap<string, any>

    • Returns string

    • Returns boolean

    • Returns string

    • Returns string

    • Parameters

      • name: string

      Returns undefined | ImageBitmap

    • Loads external input textures declared by the transition definition.

      Returns Promise<void>

      A promise that resolves after all input texture fetches have completed.

    • Serializes the transition definition into project-safe data.

      Returns {
          id: string;
          inputTextures?: {
              mipmap?: OFF | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          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;
          transitionSrc: string;
      }

      Serialized transition definition payload.

    • Reconstructs a transition definition from serialized data.

      Parameters

      • data: object

        Serialized transition definition payload.

      Returns TransitionData

      Deserialized transition definition.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods