logWGSL¶

Overview¶

Provides the ability to log things to a buffer in storage, like console.log would.

@author Jonathan Olson <jonathan.olson@colorado.edu>

Type logWGSLOptions¶

import type { logWGSLOptions } from 'scenerystack/alpenglow';

• name: string | null
  - if null, we will mark it as a barrier BETWEEN shaders
• additionalIndex?: WGSLExpressionU32 | null
  if provided, will be used as an additional index for the log
• type?: ConcreteType<T> | null
• writeData?: ( ( write: ( tIndex: WGSLExpressionU32, tValue: WGSLExpressionT ) => WGSLStatements ) => WGSLStatements ) | null
• dataCount?: number | WGSLString | ( ( varName: WGSLVariableName ) => WGSLStatements )
  (of # elements) - write into pre-existing variable IF it is a function, it will be treated as a dynamic length, and will be written into the log.
• lineToLog?: ( ( line: ConsoleLoggedLine ) => unknown ) | null
  into whatever JS-like format we want to log
• workgroupId?: WGSLExpression
• localId?: WGSLExpression

Source Code¶

See the source for logWGSL.ts in the alpenglow repository.