Skip to content

Compositor

ts
type Compositor = Disposable & {
  render: (opts?: RenderOptions) => void;
  setSize: (size: { width: number; height: number }) => void;
  allPasses: (RenderPass<any, any> | EffectPass | CompositeEffectPass)[];
  onBeforeRender: (callback: () => void) => void;
  onAfterRender: (callback: () => void) => void;
};

Type Declaration

NameTypeDescription
render()(opts?: RenderOptions) => voidRenders the main pass and every post-processing effect in order.
setSize()(size: { width: number; height: number; }) => voidResizes every pass and render target managed by the compositor.
allPasses( | RenderPass<any, any> | EffectPass | CompositeEffectPass)[]Top-level passes supplied to the compositor.
onBeforeRender()(callback: () => void) => voidRegisters a callback called before the complete chain renders.
onAfterRender()(callback: () => void) => voidRegisters a callback called after the complete chain renders.

Released under the MIT License.