mode

 Add comments
 

Tag: mode
Parent tag: pass
Attributes:

  • value (enum) – {DONT_RUN, RUN_ALWAYS (default), SKIP_FIRST_FRAME, RUN_ONCE, RUN_EVEN, RUN_ODD}

Child tags (none)

Mode is used to test each pass to determine if the pass is to be executed. The meaning of each value is:

  • DONT_RUN – the pass is not executed. This is similar to “commenting” a pass inside a pipeline;
  • RUN_ALWAYS – the default value. The pass is executed in every frame;
  • SKIP_FIRST_FRAME – the pass is executed in all but the first frame;
  • RUN_ONCE – the pass is only executed in the first frame. This may be useful for a pre-processing pass.
  • RUN_EVEN – the pass is executed only in even frames;
  • RUN_ODD – the pass is executed only in odd frames.

RUN_EVEN and RUN_ODD, can be used for ping-pong rendering when used in different passes.

Example:

<mode value="RUN_EVEN"/>