@luma.gl/core 9.0.0-beta.3 → 9.0.0-beta.5

package/dist/adapter/attribute-utils/get-attribute-from-layouts.js

@@ -1,130 +1,161 @@
-import { log } from "../../utils/log.js";
-import { decodeShaderAttributeType } from "../type-utils/decode-attribute-type.js";
-import { decodeVertexFormat } from "../type-utils/decode-vertex-format.js";
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+import { log } from '../../utils/log';
+import { decodeShaderAttributeType } from '../type-utils/decode-attribute-type';
+import { decodeVertexFormat } from '../type-utils/decode-vertex-format';
+/**
+ * Map from "attribute names" to "resolved attribute infos"
+ * containing information about both buffer layouts and shader attribute declarations
+ */
 export function getAttributeInfosFromLayouts(shaderLayout, bufferLayout) {
-  const attributeInfos = {};
-  for (const attribute of shaderLayout.attributes) {
-    attributeInfos[attribute.name] = getAttributeInfoFromLayouts(shaderLayout, bufferLayout, attribute.name);
-  }
-  return attributeInfos;
+    const attributeInfos = {};
+    for (const attribute of shaderLayout.attributes) {
+        attributeInfos[attribute.name] = getAttributeInfoFromLayouts(shaderLayout, bufferLayout, attribute.name);
+    }
+    return attributeInfos;
 }
-export function getAttributeInfosByLocation(shaderLayout, bufferLayout) {
-  let maxVertexAttributes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 16;
-  const attributeInfos = getAttributeInfosFromLayouts(shaderLayout, bufferLayout);
-  const locationInfos = new Array(maxVertexAttributes).fill(null);
-  for (const attributeInfo of Object.values(attributeInfos)) {
-    locationInfos[attributeInfo.location] = attributeInfo;
-  }
-  return locationInfos;
+/**
+ * Array indexed by "location" holding "resolved attribute infos"
+ */
+export function getAttributeInfosByLocation(shaderLayout, bufferLayout, maxVertexAttributes = 16) {
+    const attributeInfos = getAttributeInfosFromLayouts(shaderLayout, bufferLayout);
+    const locationInfos = new Array(maxVertexAttributes).fill(null);
+    for (const attributeInfo of Object.values(attributeInfos)) {
+        locationInfos[attributeInfo.location] = attributeInfo;
+    }
+    return locationInfos;
 }
+/**
+ * Get the combined information from a shader layout and a buffer layout for a specific attribute
+ */
 function getAttributeInfoFromLayouts(shaderLayout, bufferLayout, name) {
-  const shaderDeclaration = getAttributeFromShaderLayout(shaderLayout, name);
-  const bufferMapping = getAttributeFromBufferLayout(bufferLayout, name);
-  if (!shaderDeclaration) {
-    return null;
-  }
-  const attributeTypeInfo = decodeShaderAttributeType(shaderDeclaration.type);
-  const vertexFormat = (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.vertexFormat) || attributeTypeInfo.defaultVertexFormat;
-  const vertexFormatInfo = decodeVertexFormat(vertexFormat);
-  return {
-    attributeName: (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.attributeName) || shaderDeclaration.name,
-    bufferName: (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.bufferName) || shaderDeclaration.name,
-    location: shaderDeclaration.location,
-    shaderType: shaderDeclaration.type,
-    shaderDataType: attributeTypeInfo.dataType,
-    shaderComponents: attributeTypeInfo.components,
-    vertexFormat,
-    bufferDataType: vertexFormatInfo.type,
-    bufferComponents: vertexFormatInfo.components,
-    normalized: vertexFormatInfo.normalized,
-    integer: attributeTypeInfo.integer,
-    stepMode: (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.stepMode) || shaderDeclaration.stepMode,
-    byteOffset: (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.byteOffset) || 0,
-    byteStride: (bufferMapping === null || bufferMapping === void 0 ? void 0 : bufferMapping.byteStride) || 0
-  };
+    const shaderDeclaration = getAttributeFromShaderLayout(shaderLayout, name);
+    const bufferMapping = getAttributeFromBufferLayout(bufferLayout, name);
+    // TODO should no longer happen
+    if (!shaderDeclaration) {
+        //  || !bufferMapping
+        return null;
+    }
+    const attributeTypeInfo = decodeShaderAttributeType(shaderDeclaration.type);
+    const vertexFormat = bufferMapping?.vertexFormat || attributeTypeInfo.defaultVertexFormat;
+    const vertexFormatInfo = decodeVertexFormat(vertexFormat);
+    return {
+        attributeName: bufferMapping?.attributeName || shaderDeclaration.name,
+        bufferName: bufferMapping?.bufferName || shaderDeclaration.name,
+        location: shaderDeclaration.location,
+        shaderType: shaderDeclaration.type,
+        shaderDataType: attributeTypeInfo.dataType,
+        shaderComponents: attributeTypeInfo.components,
+        vertexFormat,
+        bufferDataType: vertexFormatInfo.type,
+        bufferComponents: vertexFormatInfo.components,
+        // normalized is a property of the buffer's vertex format
+        normalized: vertexFormatInfo.normalized,
+        // integer is a property of the shader declaration
+        integer: attributeTypeInfo.integer,
+        stepMode: bufferMapping?.stepMode || shaderDeclaration.stepMode,
+        byteOffset: bufferMapping?.byteOffset || 0,
+        byteStride: bufferMapping?.byteStride || 0
+    };
 }
 function getAttributeFromShaderLayout(shaderLayout, name) {
-  const attribute = shaderLayout.attributes.find(attr => attr.name === name);
-  if (!attribute) {
-    log.warn(`shader layout attribute "${name}" not present in shader`);
-  }
-  return attribute || null;
+    const attribute = shaderLayout.attributes.find(attr => attr.name === name);
+    if (!attribute) {
+        log.warn(`shader layout attribute "${name}" not present in shader`);
+    }
+    return attribute || null;
 }
 function getAttributeFromBufferLayout(bufferLayouts, name) {
-  checkBufferLayouts(bufferLayouts);
-  let bufferLayoutInfo = getAttributeFromShortHand(bufferLayouts, name);
-  if (bufferLayoutInfo) {
-    return bufferLayoutInfo;
-  }
-  bufferLayoutInfo = getAttributeFromAttributesList(bufferLayouts, name);
-  if (bufferLayoutInfo) {
-    return bufferLayoutInfo;
-  }
-  log.warn(`layout for attribute "${name}" not present in buffer layout`);
-  return null;
+    // Check that bufferLayouts are valid (each either has format or attribute)
+    checkBufferLayouts(bufferLayouts);
+    let bufferLayoutInfo = getAttributeFromShortHand(bufferLayouts, name);
+    if (bufferLayoutInfo) {
+        return bufferLayoutInfo;
+    }
+    bufferLayoutInfo = getAttributeFromAttributesList(bufferLayouts, name);
+    if (bufferLayoutInfo) {
+        return bufferLayoutInfo;
+    }
+    // Didn't find...
+    log.warn(`layout for attribute "${name}" not present in buffer layout`);
+    return null;
 }
+/** Check that bufferLayouts are valid (each either has format or attribute) */
 function checkBufferLayouts(bufferLayouts) {
-  for (const bufferLayout of bufferLayouts) {
-    if (bufferLayout.attributes && bufferLayout.format || !bufferLayout.attributes && !bufferLayout.format) {
-      log.warn(`BufferLayout ${name} must have either 'attributes' or 'format' field`);
+    for (const bufferLayout of bufferLayouts) {
+        if ((bufferLayout.attributes && bufferLayout.format) ||
+            (!bufferLayout.attributes && !bufferLayout.format)) {
+            log.warn(`BufferLayout ${name} must have either 'attributes' or 'format' field`);
+        }
     }
-  }
 }
+/** Get attribute from format shorthand if specified */
 function getAttributeFromShortHand(bufferLayouts, name) {
-  for (const bufferLayout of bufferLayouts) {
-    if (bufferLayout.format && bufferLayout.name === name) {
-      return {
-        attributeName: bufferLayout.name,
-        bufferName: name,
-        stepMode: bufferLayout.stepMode,
-        vertexFormat: bufferLayout.format,
-        byteOffset: 0,
-        byteStride: bufferLayout.byteStride || 0
-      };
+    for (const bufferLayout of bufferLayouts) {
+        if (bufferLayout.format && bufferLayout.name === name) {
+            return {
+                attributeName: bufferLayout.name,
+                bufferName: name,
+                stepMode: bufferLayout.stepMode,
+                vertexFormat: bufferLayout.format,
+                // If offset is needed, use `attributes` field.
+                byteOffset: 0,
+                byteStride: bufferLayout.byteStride || 0
+            };
+        }
     }
-  }
-  return null;
+    return null;
 }
+/**
+ * Search attribute mappings (e.g. interleaved attributes) for buffer mapping.
+ * Not the name of the buffer might be the same as one of the interleaved attributes.
+ */
 function getAttributeFromAttributesList(bufferLayouts, name) {
-  for (const bufferLayout of bufferLayouts) {
-    var _bufferLayout$attribu;
-    let byteStride = bufferLayout.byteStride;
-    if (typeof bufferLayout.byteStride !== 'number') {
-      for (const attributeMapping of bufferLayout.attributes || []) {
-        const info = decodeVertexFormat(attributeMapping.format);
-        byteStride += info.byteLength;
-      }
+    for (const bufferLayout of bufferLayouts) {
+        let byteStride = bufferLayout.byteStride;
+        // Calculate a default byte stride if not provided
+        if (typeof bufferLayout.byteStride !== 'number') {
+            for (const attributeMapping of bufferLayout.attributes || []) {
+                const info = decodeVertexFormat(attributeMapping.format);
+                byteStride += info.byteLength;
+            }
+        }
+        const attributeMapping = bufferLayout.attributes?.find(mapping => mapping.attribute === name);
+        if (attributeMapping) {
+            return {
+                attributeName: attributeMapping.attribute,
+                bufferName: bufferLayout.name,
+                stepMode: bufferLayout.stepMode,
+                vertexFormat: attributeMapping.format,
+                byteOffset: attributeMapping.byteOffset,
+                byteStride
+            };
+        }
     }
-    const attributeMapping = (_bufferLayout$attribu = bufferLayout.attributes) === null || _bufferLayout$attribu === void 0 ? void 0 : _bufferLayout$attribu.find(mapping => mapping.attribute === name);
-    if (attributeMapping) {
-      return {
-        attributeName: attributeMapping.attribute,
-        bufferName: bufferLayout.name,
-        stepMode: bufferLayout.stepMode,
-        vertexFormat: attributeMapping.format,
-        byteOffset: attributeMapping.byteOffset,
-        byteStride
-      };
-    }
-  }
-  return null;
+    return null;
 }
+/**
+ * Merges an provided shader layout into a base shader layout
+ * In WebGL, this allows the auto generated shader layout to be overridden by the application
+ * Typically to change the format of the vertex attributes (from float32x4 to uint8x4 etc).
+ * @todo Drop this? Aren't all use cases covered by mergeBufferLayout()?
+ */
 export function mergeShaderLayout(baseLayout, overrideLayout) {
-  const mergedLayout = {
-    ...baseLayout,
-    attributes: baseLayout.attributes.map(attribute => ({
-      ...attribute
-    }))
-  };
-  for (const attribute of (overrideLayout === null || overrideLayout === void 0 ? void 0 : overrideLayout.attributes) || []) {
-    const baseAttribute = mergedLayout.attributes.find(attr => attr.name === attribute.name);
-    if (!baseAttribute) {
-      log.warn(`shader layout attribute ${attribute.name} not present in shader`);
-    } else {
-      baseAttribute.type = attribute.type || baseAttribute.type;
-      baseAttribute.stepMode = attribute.stepMode || baseAttribute.stepMode;
+    // Deep clone the base layout
+    const mergedLayout = {
+        ...baseLayout,
+        attributes: baseLayout.attributes.map(attribute => ({ ...attribute }))
+    };
+    // Merge the attributes
+    for (const attribute of overrideLayout?.attributes || []) {
+        const baseAttribute = mergedLayout.attributes.find(attr => attr.name === attribute.name);
+        if (!baseAttribute) {
+            log.warn(`shader layout attribute ${attribute.name} not present in shader`);
+        }
+        else {
+            baseAttribute.type = attribute.type || baseAttribute.type;
+            baseAttribute.stepMode = attribute.stepMode || baseAttribute.stepMode;
+        }
     }
-  }
-  return mergedLayout;
+    return mergedLayout;
 }
-//# sourceMappingURL=get-attribute-from-layouts.js.map