Class Frame

constructor

• new Frame(): Frame

• Creates a new Frame instance.

  Initializes an empty frame ready to accept expressions and manage their rendering dependencies.

  Returns Frame

Static ReadonlyFrameBuffer

Static ReadonlyResolveFrameBuffer

Static ReadonlyResolveFrameBuffer2

expressions

• get expressions(): Expression[]

• Gets a read-only array of all expressions currently registered in this frame.

  Returns Expression[]

  Array of Expression objects in the order they were added

  Example

  const allExpressions = frame.expressions;
  console.log(`Frame contains ${allExpressions.length} expressions`);
  Copy

addExpression

• addExpression(expression, options?): void

• Adds a rendering expression to this frame with optional input dependencies and output configurations.

  This method registers an expression within the frame and establishes its relationships with input render passes and output framebuffers. The expression will be executed in the order it was added to the frame.

  Parameters

  • expression: Expression

    The rendering expression to add to this frame
  • options: {
        inputRenderPasses?: RenderPass[];
        outputs?: {
            frameBuffer: FrameBuffer;
            renderPass: RequireOne<{
                index?: number;
                instance?: RenderPass;
                uniqueName?: string;
            }>;
        }[];
    } = ...

    Configuration object for input dependencies and outputs

    • OptionalinputRenderPasses?: RenderPass[]

      Array of render passes that this expression depends on

    • Optionaloutputs?: {
          frameBuffer: FrameBuffer;
          renderPass: RequireOne<{
              index?: number;
              instance?: RenderPass;
              uniqueName?: string;
          }>;
      }[]

      Array of output configurations specifying which render passes should render to which framebuffers

  Returns void

  Example

  frame.addExpression(lightingExpression, {
    inputRenderPasses: [geometryPass, shadowPass],
    outputs: [{
      renderPass: { index: 0 },
      frameBuffer: screenFrameBuffer
    }]
  });
  Copy

clearExpressions

• clearExpressions(): void

• Removes all expressions from this frame and clears associated caches.

  This method resets the frame to its initial empty state, removing all registered expressions and clearing internal caches. Any pending expression queries will also be implicitly cleared.

  Returns void

  Example

  frame.clearExpressions();
  // Frame is now empty and ready for new expressions
  Copy

getColorAttachmentFromInputOf

• getColorAttachmentFromInputOf(inputFrom, renderPassArg?): Promise<RenderTargetTexture>

• Retrieves a color attachment render target texture from an input render pass of the specified expression.

  This method creates a promise-based query system that allows expressions to access color attachment textures from their input render passes. The actual texture retrieval is deferred until the resolve() method is called, enabling proper dependency resolution.

  Parameters

  • inputFrom: Expression

    The expression from which to retrieve the color attachment
  • renderPassArg: {
        colorAttachmentIndex: number;
        framebufferType: "FrameBuffer" | "ResolveFrameBuffer" | "ResolveFrameBuffer2";
        renderPass: RequireOne<{
            index?: number;
            instance?: RenderPass;
            uniqueName?: string;
        }>;
    } = ...

    Configuration object specifying the render pass and attachment details

    • colorAttachmentIndex: number

      Index of the color attachment to retrieve (default: 0)

    • framebufferType: "FrameBuffer" | "ResolveFrameBuffer" | "ResolveFrameBuffer2"

      Type of framebuffer to query (default: 'FrameBuffer')

    • renderPass: RequireOne<{
          index?: number;
          instance?: RenderPass;
          uniqueName?: string;
      }>

      Identifier for the target render pass (by index, name, or instance)

  Returns Promise<RenderTargetTexture>

  Promise that resolves to the requested RenderTargetTexture

  Example

  const colorTexture = await frame.getColorAttachmentFromInputOf(geometryExpression, {
    renderPass: { index: 0 },
    colorAttachmentIndex: 0,
    framebufferType: Frame.FrameBuffer
  });
  Copy

resolve

• resolve(): void

• Resolves all pending expression queries and establishes texture dependencies.

  This method processes all queued color attachment queries created by getColorAttachmentFromInputOf() calls. It matches expressions with their corresponding render passes and retrieves the requested color attachment textures, fulfilling the associated promises.

  This method should be called after all expressions have been added and all color attachment queries have been registered, typically before beginning the actual rendering process.

  Returns void

  Example

  // Add all expressions and set up queries
  frame.addExpression(expr1);
  frame.addExpression(expr2);
  await frame.getColorAttachmentFromInputOf(expr1, {...});
  
  // Resolve all dependencies
  frame.resolve();
  Copy

setViewport

• setViewport(viewport): void

• Sets the viewport for all expressions in this frame.

  This method propagates the viewport settings to all registered expressions, ensuring consistent rendering dimensions across the entire frame.

  Parameters

  • viewport: IVector4

    4D vector defining the viewport (x, y, width, height)

  Returns void

  Example

  frame.setViewport(Vector4.fromCopyArray([0, 0, 1920, 1080]));
  Copy