@luma.gl/core 9.3.0-alpha.4 → 9.3.0-alpha.8

package/src/shadertypes/data-types/shader-types.ts

@@ -1,94 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import type {PrimitiveDataType} from './data-types';
-
-/**
- * Describes the type of an attribute as defined in the shader source code.
- * @note This is a subset of shader variable types
- * @note Buffers with various `VertexFormat`s can be supplied for each type, GPU will convert them at runtime/
- */
-export type AttributeShaderType =
-  | PrimitiveDataType
-  | `vec2<${PrimitiveDataType}>`
-  | `vec3<${PrimitiveDataType}>`
-  | `vec4<${PrimitiveDataType}>`;
-
-/**
- * Describes the type of a variable that can declared in shader source code.
- * @note Uniforms can be declared using these types
- * @note Uniforms can be of a wider range of types than attributes.
- * @note to WebGL users: "bindings" (textures, samplers, and uniform buffers) are considered "bindings", not shader variables/uniforms
- */
-export type VariableShaderType =
-  | PrimitiveDataType
-  | `vec2<${PrimitiveDataType}>`
-  | `vec3<${PrimitiveDataType}>`
-  | `vec4<${PrimitiveDataType}>`
-  | `mat2x2<${PrimitiveDataType}>`
-  | `mat2x3<${PrimitiveDataType}>`
-  | `mat2x4<${PrimitiveDataType}>`
-  | `mat3x2<${PrimitiveDataType}>`
-  | `mat3x3<${PrimitiveDataType}>`
-  | `mat3x4<${PrimitiveDataType}>`
-  | `mat4x2<${PrimitiveDataType}>`
-  | `mat4x3<${PrimitiveDataType}>`
-  | `mat4x4<${PrimitiveDataType}>`;
-
-/* Suffixes used by WGSL alias types */
-type ShaderTypeAliasSuffix = 'f' | 'i' | 'u' | 'h';
-
-/** Shorthand type aliases recognized by WGSL */
-export type AttributeShaderTypeAlias =
-  | `vec2${ShaderTypeAliasSuffix}`
-  | `vec3${ShaderTypeAliasSuffix}`
-  | `vec4${ShaderTypeAliasSuffix}`;
-
-/** Shorthand type aliases recognized by WGSL */
-export type VariableShaderTypeAlias =
-  | AttributeShaderTypeAlias
-  | `mat2x2${ShaderTypeAliasSuffix}`
-  | `mat2x3${ShaderTypeAliasSuffix}`
-  | `mat2x4${ShaderTypeAliasSuffix}`
-  | `mat3x2${ShaderTypeAliasSuffix}`
-  | `mat3x3${ShaderTypeAliasSuffix}`
-  | `mat3x4${ShaderTypeAliasSuffix}`
-  | `mat4x2${ShaderTypeAliasSuffix}`
-  | `mat4x3${ShaderTypeAliasSuffix}`
-  | `mat4x4${ShaderTypeAliasSuffix}`;
-
-/** A composite shader type can include structs and arrays, recursively */
-export type CompositeShaderType = VariableShaderType | StructShaderType | ArrayShaderType;
-
-/** Represents a struct in WGSL */
-export type StructShaderType = Record<
-  string,
-  VariableShaderType | StructShaderType2 | ArrayShaderType
->;
-export type StructShaderType2 = Record<
-  string,
-  VariableShaderType | StructShaderType3 | ArrayShaderType
->;
-export type StructShaderType3 = Record<
-  string,
-  VariableShaderType | StructShaderType4 | ArrayShaderType
->;
-export type StructShaderType4 = Record<string, VariableShaderType>;
-
-/** Represents an array in WGSL */
-export type ArrayShaderType = [type: CompositeShaderType, length: number];
-
-/** Information extracted from a AttributeShaderType constant */
-export type AttributeShaderTypeInfo = {
-  /** WGSL-style primitive data type, f32, i32, u32 */
-  primitiveType: PrimitiveDataType;
-  /** Whether this is a normalized integer (that must be used as float) */
-  components: 1 | 2 | 3 | 4;
-  /** Length in bytes of the data for one vertex */
-  byteLength?: number;
-  /** Whether this is for integer or float vert */
-  integer: boolean;
-  /** Whether this data type is signed */
-  signed: boolean;
-};

package/src/shadertypes/vertex-arrays/decode-vertex-format.ts

@@ -1,124 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import type {TypedArray} from '../../types';
-import type {NormalizedDataType, PrimitiveDataType, SignedDataType} from '../data-types/data-types';
-import type {VertexFormat, VertexFormatInfo} from './vertex-formats';
-import {getDataTypeInfo, getDataType, getNormalizedDataType} from '../data-types/decode-data-types';
-
-/**
- * Decodes a vertex format, returning type, components, byte  length and flags (integer, signed, normalized)
- */
-export function getVertexFormatInfo(format: VertexFormat): VertexFormatInfo {
-  // Strip the -webgl ending if present
-  let webglOnly: boolean | undefined;
-  if (format.endsWith('-webgl')) {
-    format.replace('-webgl', '');
-    webglOnly = true;
-  }
-  // split components from type
-  const [type_, count] = format.split('x');
-  const type = type_ as NormalizedDataType;
-  const components = (count ? parseInt(count) : 1) as 1 | 2 | 3 | 4;
-  // decode the type
-  const decodedType = getDataTypeInfo(type);
-  const result: VertexFormatInfo = {
-    type,
-    components,
-    byteLength: decodedType.byteLength * components,
-    integer: decodedType.integer,
-    signed: decodedType.signed,
-    normalized: decodedType.normalized
-  };
-  if (webglOnly) {
-    result.webglOnly = true;
-  }
-  return result;
-}
-
-/** Build a vertex format from a signed data type and a component */
-export function makeVertexFormat(
-  signedDataType: SignedDataType,
-  components: 1 | 2 | 3 | 4,
-  normalized?: boolean
-): VertexFormat {
-  const dataType: NormalizedDataType = normalized
-    ? getNormalizedDataType(signedDataType)
-    : signedDataType;
-
-  switch (dataType) {
-    // TODO - Special cases for WebGL (not supported on WebGPU), overrides the check below
-    case 'unorm8':
-      if (components === 1) {
-        return 'unorm8';
-      }
-      if (components === 3) {
-        return 'unorm8x3-webgl';
-      }
-      return `${dataType}x${components}`;
-
-    case 'snorm8':
-    case 'uint8':
-    case 'sint8':
-    // WebGPU 8 bit formats must be aligned to 16 bit boundaries');
-    // fall through
-    case 'uint16':
-    case 'sint16':
-    case 'unorm16':
-    case 'snorm16':
-    case 'float16':
-      // WebGPU 16 bit formats must be aligned to 32 bit boundaries
-      if (components === 1 || components === 3) {
-        throw new Error(`size: ${components}`);
-      }
-      return `${dataType}x${components}`;
-
-    default:
-      return components === 1 ? dataType : `${dataType}x${components}`;
-  }
-}
-
-/** Get the vertex format for an attribute with TypedArray and size */
-export function getVertexFormatFromAttribute(
-  typedArray: TypedArray,
-  size: number,
-  normalized?: boolean
-): VertexFormat {
-  if (!size || size > 4) {
-    throw new Error(`size ${size}`);
-  }
-
-  const components = size as 1 | 2 | 3 | 4;
-  const signedDataType = getDataType(typedArray);
-  return makeVertexFormat(signedDataType, components, normalized);
-}
-
-/** Return a "default" vertex format for a certain shader data type
- The simplest vertex format that matches the shader attribute's data type */
-
-export function getCompatibleVertexFormat(opts: {
-  primitiveType: PrimitiveDataType;
-  components: 1 | 2 | 3 | 4;
-}): VertexFormat {
-  let vertexType: NormalizedDataType;
-  switch (opts.primitiveType) {
-    case 'f32':
-      vertexType = 'float32';
-      break;
-    case 'i32':
-      vertexType = 'sint32';
-      break;
-    case 'u32':
-      vertexType = 'uint32';
-      break;
-    case 'f16':
-      return opts.components <= 2 ? 'float16x2' : 'float16x4';
-  }
-
-  // TODO logic does not work for float16
-  if (opts.components === 1) {
-    return vertexType;
-  }
-  return `${vertexType}x${opts.components}`;
-}

package/src/shadertypes/vertex-arrays/vertex-formats.ts

@@ -1,91 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import {NormalizedDataType} from '../data-types/data-types';
-
-/*
- */
-/**
- * Describes the **memory format** and interpretation (normalization) of a buffer that will be supplied to vertex attributes
- * @note Must be compatible with the AttributeShaderType of the shaders, see documentation.
- * @note This is a superset of WebGPU vertex formats to allow for some flexibility for WebGL only applications
- * @todo Add device.isTextureFormatSupported() method?
- */
-export type VertexFormat =
-  // 8 bit integers, note that only 16 bit aligned formats are supported in WebGPU (x2 and x4)
-  | 'uint8' // Chrome 133+
-  | 'uint8x2'
-  | 'uint8x4'
-  | 'sint8' // Chrome 133+
-  | 'sint8x2'
-  | 'sint8x4'
-  | 'unorm8' // Chrome 133+
-  | 'unorm8x2'
-  | 'unorm8x3-webgl' // Not in WebGPU
-  | 'unorm8x4'
-  | 'unorm8x4-bgra' // Chrome 133+
-  | 'unorm10-10-10-2' // Chrome 119+
-  // | 'snorm-10-10-10-2' // Not in WebGPU, DXD12 doesn't support
-  | 'snorm8' // Chrome 133+
-  | 'snorm8x2'
-  | 'snorm8x3-webgl'
-  | 'snorm8x4'
-  // 16 bit integers, that only 32 bit aligned formats are supported in WebGPU (x2 and x4)
-  | 'uint16' // Chrome 133+
-  | 'sint16' // Chrome 133+
-  | 'unorm16' // Chrome 133+
-  | 'snorm16' // Chrome 133+
-  | 'uint16x2'
-  | 'uint16x4'
-  | 'sint16x2'
-  | 'sint16x4'
-  | 'unorm16x2'
-  | 'unorm16x4'
-  | 'snorm16x2'
-  | 'snorm16x4'
-  // 32 bit integers
-  | 'uint32'
-  | 'uint32x2'
-  | 'uint32x3'
-  | 'uint32x4'
-  | 'sint32'
-  | 'sint32x2'
-  | 'sint32x3'
-  | 'sint32x4'
-  // No normalized 32 bit integers in WebGPU...
-  // | 'unorm32'
-  // | 'unorm32x2'
-  // | 'unorm32x3'
-  // | 'unorm32x4'
-  // | 'snorm32'
-  // | 'snorm32x2'
-  // | 'snorm32x3'
-  // | 'snorm32x4'
-  // floats
-  | 'float16' // Chrome 133+
-  | 'float16x2'
-  | 'float16x4'
-  | 'float32'
-  | 'float32x2'
-  | 'float32x3'
-  | 'float32x4';
-
-export type VertexFormatInfo = {
-  /** Type of each component */
-  type: NormalizedDataType;
-  /** Length in bytes */
-  byteLength: number;
-  /** Number of components per vertex / row */
-  components: 1 | 2 | 3 | 4;
-  /** Is this an integer format (normalized integer formats are not integer) */
-  integer: boolean;
-  /** Is this a signed format? */
-  signed: boolean;
-  /** Is this a normalized format? */
-  normalized: boolean;
-  /** Is this a bgra format? */
-  bgra?: boolean;
-  /** Is this a webgl only format? */
-  webglOnly?: boolean;
-};