Skip to content

Compositor

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

Type Declaration

NameTypeDescription
render()(opts?: { clear?: boolean; }) => voidRenders the entire chain: the main pass followed by all effects.
setSize()(size: { width: number; height: number; }) => voidResizes all passes and their respective render targets.
allPasses( | RenderPass<any> | CompositeEffectPass<any>)[]Flat array of all passes managed by this compositor (main pass + all effects).
onBeforeRender()(callback: () => void) => voidRegisters a callback called before the whole rendering pipeline starts.
onAfterRender()(callback: () => void) => voidRegisters a callback called after the whole rendering pipeline finishes.

Released under the MIT License.