@luma.gl/engine 8.6.0-alpha.4 → 9.0.0-alpha.10

package/src/transform/transform-shader-utils.ts

@@ -1,169 +0,0 @@
-import {assert} from '@luma.gl/webgl';
-import {combineInjects, getQualifierDetails, typeToChannelSuffix} from '@luma.gl/shadertools';
-
-const SAMPLER_UNIFORM_PREFIX = 'transform_uSampler_';
-const SIZE_UNIFORM_PREFIX = 'transform_uSize_';
-const VS_POS_VARIABLE = 'transform_position';
-
-// Scan provided vertex shader
-// for each texture attribute, inject sampler instructions and build uniforms for sampler
-// for texture target, get varying type and inject position instruction
-export function updateForTextures(options: {
-  vs: any;
-  sourceTextureMap: any;
-  targetTextureVarying: any;
-  targetTexture: any;
-}): {
-  vs: any;
-  targetTextureType: any;
-  inject: {};
-  samplerTextureMap: {};
-} {
-  const {vs, sourceTextureMap, targetTextureVarying, targetTexture} = options;
-  const texAttributeNames = Object.keys(sourceTextureMap);
-  let sourceCount = texAttributeNames.length;
-  let targetTextureType = null;
-  const samplerTextureMap = {};
-  let updatedVs = vs;
-  let finalInject = {};
-
-  if (sourceCount > 0 || targetTextureVarying) {
-    const vsLines = updatedVs.split('\n');
-    const updateVsLines = vsLines.slice();
-    vsLines.forEach((line, index, lines) => {
-      // TODO add early exit
-      if (sourceCount > 0) {
-        const updated = processAttributeDefinition(line, sourceTextureMap);
-        if (updated) {
-          const {updatedLine, inject} = updated;
-          updateVsLines[index] = updatedLine;
-          // sampleInstructions.push(sampleInstruction);
-          finalInject = combineInjects([finalInject, inject]);
-          Object.assign(samplerTextureMap, updated.samplerTextureMap);
-          sourceCount--;
-        }
-      }
-      if (targetTextureVarying && !targetTextureType) {
-        targetTextureType = getVaryingType(line, targetTextureVarying);
-      }
-    });
-
-    if (targetTextureVarying) {
-      assert(targetTexture);
-      const sizeName = `${SIZE_UNIFORM_PREFIX}${targetTextureVarying}`;
-
-      const uniformDeclaration = `uniform vec2 ${sizeName};\n`;
-      const posInstructions = `\
-     vec2 ${VS_POS_VARIABLE} = transform_getPos(${sizeName});
-     gl_Position = vec4(${VS_POS_VARIABLE}, 0, 1.);\n`;
-      const inject = {
-        'vs:#decl': uniformDeclaration,
-        'vs:#main-start': posInstructions
-      };
-      finalInject = combineInjects([finalInject, inject]);
-    }
-    updatedVs = updateVsLines.join('\n');
-  }
-  return {
-    // updated vertex shader (commented texture attribute definition)
-    vs: updatedVs,
-    // type (float, vec2, vec3 of vec4) target texture varying
-    targetTextureType,
-    // required vertex and fragment shader injects
-    inject: finalInject,
-    // map of sampler name to texture name, can be used to set attributes
-    // usefull when swapping textures, as source and destination texture change when swap is called.
-    samplerTextureMap
-  };
-}
-
-// builds and returns an object contaning size uniform for each texture
-export function getSizeUniforms(options: {
-  sourceTextureMap: any;
-  targetTextureVarying: any;
-  targetTexture: any;
-}): {} {
-  const uniforms = {};
-  let width;
-  let height;
-  if (options.targetTextureVarying) {
-    ({width, height} = options.targetTexture);
-    uniforms[`${SIZE_UNIFORM_PREFIX}${options.targetTextureVarying}`] = [width, height];
-  }
-  for (const textureName in options.sourceTextureMap) {
-    ({width, height} = options.sourceTextureMap[textureName]);
-    uniforms[`${SIZE_UNIFORM_PREFIX}${textureName}`] = [width, height];
-  }
-  return uniforms;
-}
-
-// Return size (float, vec2 etc) of a given varying, null if doens't exist.
-
-export function getVaryingType(line: any, varying: any): any {
-  const qualiferDetails = getQualifierDetails(line, ['varying', 'out']);
-  if (!qualiferDetails) {
-    return null;
-  }
-  return qualiferDetails.name === varying ? qualiferDetails.type : null;
-}
-
-// build required definitions, sample instructions for each texture attribute
-export function processAttributeDefinition(
-  line: any,
-  textureMap: any
-): {
-  updatedLine: string;
-  inject: {
-    'vs:#decl': string;
-    'vs:#main-start': string;
-  };
-  samplerTextureMap: {};
-} {
-  const samplerTextureMap = {};
-  const attributeData = getAttributeDefinition(line);
-  if (!attributeData) {
-    return null;
-  }
-  const {type, name} = attributeData;
-  if (name && textureMap[name]) {
-    // eslint-disable-next-line no-useless-escape
-    const updatedLine = `\// ${line} => Replaced by Transform with a sampler`;
-    const {samplerName, sizeName, uniformDeclerations} = getSamplerDeclarations(name);
-
-    const channels = typeToChannelSuffix(type);
-    const sampleInstruction = `  ${type} ${name} = transform_getInput(${samplerName}, ${sizeName}).${channels};\n`;
-
-    samplerTextureMap[samplerName] = name;
-    const inject = {
-      'vs:#decl': uniformDeclerations,
-      'vs:#main-start': sampleInstruction
-    };
-
-    // samplerNameMap
-    return {
-      // update vertex shader line.
-      updatedLine,
-      // inject object with sampler instructions.
-      inject,
-      // sampler name to texture name map
-      samplerTextureMap
-    };
-  }
-  return null;
-}
-
-// HELPERS
-
-// Checks if provided line is defining an attribute, if so returns details otherwise null
-function getAttributeDefinition(line) {
-  return getQualifierDetails(line, ['attribute', 'in']);
-}
-
-function getSamplerDeclarations(textureName) {
-  const samplerName = `${SAMPLER_UNIFORM_PREFIX}${textureName}`;
-  const sizeName = `${SIZE_UNIFORM_PREFIX}${textureName}`;
-  const uniformDeclerations = `\
-  uniform sampler2D ${samplerName};
-  uniform vec2 ${sizeName};`;
-  return {samplerName, sizeName, uniformDeclerations};
-}

package/src/transform/transform-types.ts

@@ -1,42 +0,0 @@
-/** Properties for creating Transforms */
-export type TransformProps = {
-  id?: string;
-  vs?: string;
-  elementCount?: number;
-  sourceBuffers?: object;
-  feedbackBuffers?: object;
-  varyings?: string[];
-  feedbackMap?: object;
-  modules?: object[]; // TODO use ShaderModule type
-  attributes?: any;
-  uniforms?: any;
-  parameters?: any;
-  discard?: boolean;
-  isIndexed?: boolean;
-  _sourceTextures?: any;
-  _targetTexture?: any;
-  _targetTextureVarying?: string;
-  _swapTexture?: string;
-  _fs?: string;
-  fs?: string;
-  inject?: any;
-  drawMode?: number;
-};
-
-/** Options that can be provided when running a Transform */
-export type TransformRunOptions = {
-  clearRenderTarget?: boolean;
-  uniforms: Record<string, any>;
-};
-
-/** Options that control drawing a Transform. Used by subclasses to return draw parameters */
-export type TransformDrawOptions = {
-  attributes?: object;
-  framebuffer?: any;
-  uniforms?: object;
-  discard?: boolean;
-  parameters?: object;
-  transformFeedback?: any;
-};
-
-export type TransformBinding = {sourceBuffers, feedbackBuffers, transformFeedback};

package/src/transform/transform.ts

@@ -1,189 +0,0 @@
-import {Device, assert} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import {getShaderInfo, getPassthroughFS} from '@luma.gl/shadertools';
-import type {Framebuffer, Buffer} from '@luma.gl/webgl';
-import {WebGLDevice, isObjectEmpty} from '@luma.gl/webgl';
-
-import Model from '../lib/model';
-import BufferTransform from './buffer-transform';
-import TextureTransform from './texture-transform';
-import {TransformProps, TransformRunOptions, TransformDrawOptions} from './transform-types';
-
-/** 
- * Takes source and target buffers/textures and sets up the pipeline 
- */
-export default class Transform {
-  /** 
-   * Check if Transforms are supported (they are not under WebGL1)
-   * @todo differentiate writing to buffer vs not
-   */
-  static isSupported(device: Device | WebGL2RenderingContext): boolean {
-    try {
-      const webglDevice = WebGLDevice.attach(device);
-      return webglDevice.isWebGL2;
-    } catch {
-      return false;
-    }
-  }
-
-  readonly device: WebGLDevice;
-  readonly gl: WebGL2RenderingContext;
-  model: Model | null = null;
-  elementCount = 0;
-  bufferTransform = null;
-  textureTransform = null;
-  elementIDBuffer = null;
-
-  constructor(device: Device | WebGL2RenderingContext, props: TransformProps = {}) {
-    this.device = WebGLDevice.attach(device);
-    // TODO assert webgl2?
-    this.gl = this.device.gl2;
-    this._initialize(props);
-    Object.seal(this);
-  }
-
-  /** Delete owned resources. */
-  destroy(): void {
-    const {model, bufferTransform, textureTransform} = this;
-    if (model) {
-      model.delete();
-    }
-    if (bufferTransform) {
-      bufferTransform.delete();
-    }
-    if (textureTransform) {
-      textureTransform.delete();
-    }
-  }
-
-  /** @deprecated Use destroy*() */
-  delete(): void {
-    this.destroy();
-  }
-
-  /** Run one transform loop. */
-  run(options?: TransformRunOptions): void {
-    const {clearRenderTarget = true} = options || {};
-
-    const updatedOpts = this._updateDrawOptions(options);
-
-    if (clearRenderTarget && updatedOpts.framebuffer) {
-      updatedOpts.framebuffer.clear({color: true});
-    }
-
-    this.model.transform(updatedOpts);
-  }
-
-  /** swap resources if a map is provided */
-  swap(): void {
-    let swapped = false;
-    const resourceTransforms = [this.bufferTransform, this.textureTransform].filter(Boolean);
-    for (const resourceTransform of resourceTransforms) {
-      swapped = swapped || resourceTransform.swap();
-    }
-    assert(swapped, 'Nothing to swap');
-  }
-
-  /** Return Buffer object for given varying name. */
-  getBuffer(varyingName: string = null): Buffer {
-    return this.bufferTransform && this.bufferTransform.getBuffer(varyingName);
-  }
-
-  /** Return data either from Buffer or from Texture */
-  getData(options: {packed?: boolean; varyingName?: string} = {}) {
-    const resourceTransforms = [this.bufferTransform, this.textureTransform].filter(Boolean);
-    for (const resourceTransform of resourceTransforms) {
-      const data = resourceTransform.getData(options);
-      if (data) {
-        return data;
-      }
-    }
-    return null;
-  }
-
-  /** Return framebuffer object if rendering to textures */
-  getFramebuffer(): Framebuffer | null {
-    return this.textureTransform && this.textureTransform.getFramebuffer();
-  }
-
-  /** Update some or all buffer/texture bindings. */
-  update(props: TransformProps): void {
-    if ('elementCount' in props) {
-      this.model.setVertexCount(props.elementCount);
-    }
-    const resourceTransforms = [this.bufferTransform, this.textureTransform].filter(Boolean);
-    for (const resourceTransform of resourceTransforms) {
-      resourceTransform.update(props);
-    }
-  }
-
-  // Private
-
-  _initialize(props: TransformProps): void {
-    const {gl} = this;
-    this._buildResourceTransforms(gl, props);
-
-    props = this._updateModelProps(props);
-    this.model = new Model(
-      this.device,
-      Object.assign({}, props, {
-        fs: props.fs || getPassthroughFS({version: getShaderInfo(props.vs).version}),
-        id: props.id || 'transform-model',
-        drawMode: props.drawMode || GL.POINTS,
-        vertexCount: props.elementCount
-      })
-    );
-
-    if (this.bufferTransform) {
-      this.bufferTransform.setupResources({model: this.model});
-    }
-  }
-
-  _updateModelProps(props: TransformProps): TransformProps {
-    let updatedProps = {...props};
-    const resourceTransforms = [this.bufferTransform, this.textureTransform].filter(Boolean);
-    for (const resourceTransform of resourceTransforms) {
-      updatedProps = resourceTransform.updateModelProps(updatedProps);
-    }
-    return updatedProps;
-  }
-
-  _buildResourceTransforms(gl: WebGL2RenderingContext, props: TransformProps) {
-    if (canCreateBufferTransform(props)) {
-      this.bufferTransform = new BufferTransform(gl, props);
-    }
-    if (canCreateTextureTransform(props)) {
-      this.textureTransform = new TextureTransform(gl, props);
-    }
-    assert(
-      this.bufferTransform || this.textureTransform,
-      'must provide source/feedback buffers or source/target textures'
-    );
-  }
-
-  _updateDrawOptions(options: TransformRunOptions): TransformDrawOptions {
-    let updatedOpts = {...options};
-    const resourceTransforms = [this.bufferTransform, this.textureTransform].filter(Boolean);
-    for (const resourceTransform of resourceTransforms) {
-      updatedOpts = Object.assign(updatedOpts, resourceTransform.getDrawOptions(updatedOpts));
-    }
-    return updatedOpts;
-  }
-}
-
-// Helper Methods
-
-function canCreateBufferTransform(props: TransformProps): boolean {
-  const canCreate = !isObjectEmpty(props.feedbackBuffers) ||
-  !isObjectEmpty(props.feedbackMap) ||
-  (props.varyings && props.varyings.length > 0);
-  return Boolean(canCreate);
-}
-
-function canCreateTextureTransform(props: TransformProps): boolean {
-  const canCreate =
-    !isObjectEmpty(props._sourceTextures) ||
-    props._targetTexture ||
-    props._targetTextureVarying
-  return canCreate;
-}