Interface Pipeline

defaultPipeline

pipeline

pipelineData

getPipelineName

• getPipelineName(): string

  Gets the name of the WebGL Pipeline this Game Object is currently using.

  Returns string

initPipeline

• initPipeline(pipeline?: string | WebGLPipeline): boolean

  Sets the initial WebGL Pipeline of this Game Object.

  This should only be called during the instantiation of the Game Object. After that, use setPipeline.

  Parameters

  • Optionalpipeline: string | WebGLPipeline

    Either the string-based name of the pipeline, or a pipeline instance to set.

  Returns boolean

resetPipeline

• resetPipeline(resetData?: boolean): boolean

  Resets the WebGL Pipeline of this Game Object back to the default it was created with.

  Parameters

  • OptionalresetData: boolean

    Reset the pipelineData object to being an empty object? Default false.

  Returns boolean

setPipeline

• setPipeline(
      pipeline: string | WebGLPipeline,
      pipelineData?: object,
      copyData?: boolean,
  ): this

  Sets the main WebGL Pipeline of this Game Object.

  Also sets the pipelineData property, if the parameter is given.

  Parameters

  • pipeline: string | WebGLPipeline

    Either the string-based name of the pipeline, or a pipeline instance to set.

  • OptionalpipelineData: object

    Optional pipeline data object that is set in to the pipelineData property of this Game Object.

  • OptionalcopyData: boolean

    Should the pipeline data object be deep copied into the pipelineData property of this Game Object? If false it will be set by reference instead. Default true.

  Returns this

setPipelineData

• setPipelineData(key: string, value?: any): this

  Adds an entry to the pipelineData object belonging to this Game Object.

  If the 'key' already exists, its value is updated. If it doesn't exist, it is created.

  If value is undefined, and key exists, key is removed from the data object.

  Parameters

  • key: string

    The key of the pipeline data to set, update, or delete.

  • Optionalvalue: any

    The value to be set with the key. If undefined then key will be deleted from the object.

  Returns this