Interface RenderList

A list of render task. Every task consist of entites layer to draw, render target in which draw, and optional list of sub geomteries names. Cannot be changed after effect activation.

Hierarchy

RenderList

Index

Methods

addTask clear getName getTaskLayer getTaskTarget setName

Methods

addTask

addTask(layer, target, subGeoms?): number
add render task to layer.
Parameters
- layer: Layer
  
  entities layer.
- target: RenderTarget
  
  needed render target. Do not change if previous target was the same.
- Optional subGeoms: Vector<string>
  
  if specified: only sub geometries from this list will be rendered.
Returns number

clear

clear(): void
Remove all render tasks.

Returns void

getName

getName(): string
Returns string
name of the render list

getTaskLayer

getTaskLayer(taskIndex): Layer
return render rask layer, by render task index. Throw if index >= tasks size.
Parameters
- taskIndex: number
  
  render task index.
Returns Layer
task layer

getTaskTarget

getTaskTarget(taskIndex): RenderTarget
return render rask render target, by render task index. Throw if index >= tasks size.
Parameters
- taskIndex: number
  
  render task index.
Returns RenderTarget
task render target

setName

setName(name): void
Set name of the render list
Parameters
- name: string
  
  name
Returns void