@bigmistqke/view.gl 0.1.6 → 0.1.8

package/src/types.ts

@@ -1,72 +1,14 @@
-export type Merge<A, B> = {
-  [K in keyof A | keyof B]: K extends keyof A
-    ? K extends keyof B
-      ? A[K] | B[K]
-      : A[K]
-    : K extends keyof B
-      ? B[K]
-      : never
-}
-
-export type Prettify<T> = {
-  [K in keyof T]: T[K]
-} & {}
-
-export type RemoveSuffix<T, S extends string> = {
-  [K in keyof T as K extends `${infer Prefix}${S}` ? Prefix : K]: T[K]
-}
+import { DeepMerge, Prettify, ShallowMerge } from './type-utils'
 
 export type GL = WebGLRenderingContext | WebGL2RenderingContext
 
-export type DeepMerge<A extends readonly [...any]> = A extends [infer L, ...infer R]
-  ? DeepMergeTwo<L, DeepMerge<R>>
-  : unknown
-
-type DeepMergeTwo<TBase, TOverride> = {
-  [K in keyof TBase | keyof TOverride]: K extends keyof TOverride
-    ? K extends keyof TBase
-      ? ShallowMerge<[TBase[K], TOverride[K]]>
-      : TOverride[K]
-    : K extends keyof TBase
-      ? TBase[K]
-      : never
-}
-
-// see https://stackoverflow.com/a/49683575
-export type ShallowMerge<A extends readonly [...any]> = A extends [infer L, ...infer R]
-  ? ShallowMergeTwo<L, ShallowMerge<R>>
-  : unknown
-
-type OptionalPropertyNames<T> = {
-  [K in keyof T]-?: {} extends { [P in K]: T[K] } ? K : never
-}[keyof T]
-
-type SpreadProperties<L, R, K extends keyof L & keyof R> = {
-  [P in K]: L[P] | Exclude<R[P], undefined>
-}
-
-type Id<T> = T extends infer U ? { [K in keyof U]: U[K] } : never
-
-type ShallowMergeTwo<L, R> = Id<
-  Pick<L, Exclude<keyof L, keyof R>> &
-    Pick<R, Exclude<keyof R, OptionalPropertyNames<R>>> &
-    Pick<R, Exclude<OptionalPropertyNames<R>, keyof L>> &
-    SpreadProperties<L, R, OptionalPropertyNames<R> & keyof L>
->
-
-/**********************************************************************************/
-/*                                                                                */
-/*                                    Constants                                   */
-/*                                                                                */
-/**********************************************************************************/
-
-type GLTarget = 'ARRAY_BUFFER' | 'ELEMENT_ARRAY_BUFFER'
-type GLUsage = 'STATIC_DRAW' | 'DYNAMIC_DRAW' | 'STREAM_DRAW'
-type GLTextureTarget = 'TEXTURE_2D' | 'TEXTURE_CUBE_MAP'
-type GLTextureFormat = 'RGBA' | 'RGB' | 'RGBA32F' | 'RGB32F' | 'RGBA16F' | 'RGB16F'
-type GLTextureType = 'UNSIGNED_BYTE' | 'FLOAT' | 'HALF_FLOAT'
-type GLTextureFilter = 'NEAREST' | 'LINEAR'
-type GLTextureWrap = 'CLAMP_TO_EDGE' | 'REPEAT' | 'MIRRORED_REPEAT'
+export type GLTarget = 'ARRAY_BUFFER' | 'ELEMENT_ARRAY_BUFFER'
+export type GLUsage = 'STATIC_DRAW' | 'DYNAMIC_DRAW' | 'STREAM_DRAW'
+export type GLTextureTarget = 'TEXTURE_2D' | 'TEXTURE_CUBE_MAP'
+export type GLTextureFormat = 'RGBA' | 'RGB' | 'RGBA32F' | 'RGB32F' | 'RGBA16F' | 'RGB16F'
+export type GLTextureType = 'UNSIGNED_BYTE' | 'FLOAT' | 'HALF_FLOAT'
+export type GLTextureFilter = 'NEAREST' | 'LINEAR'
+export type GLTextureWrap = 'CLAMP_TO_EDGE' | 'REPEAT' | 'MIRRORED_REPEAT'
 
 export interface KIND_TO_UNIFORM_FN_NAME_MAP {
   // Floats (WebGL1 + WebGL2)
@@ -389,21 +331,22 @@ interface UniformKindMap {
   usampler2DArray: [number];
 }
 
-export interface UniformOptions {
+export interface UniformDefinition {
   kind: UniformKind
   size?: number
 }
 
-export type UniformSchema = Record<string | symbol, UniformOptions>
-export type UniformSchemaPartial = Record<string | symbol, Partial<UniformOptions>>
+export type UniformSchema = Record<string | symbol, UniformDefinition>
+export type UniformSchemaPartial = Record<string | symbol, Partial<UniformDefinition>>
 
-export type UniformMethods<TOptions extends UniformOptions> = TOptions['size'] extends number
-  ? {
-      set(arg: Float32Array): void
-    }
-  : {
-      set(...args: UniformKindMap[TOptions['kind']]): void
-    }
+export type UniformMethods<TDefinition extends UniformDefinition> =
+  TDefinition['size'] extends number
+    ? {
+        set(arg: Float32Array): void
+      }
+    : {
+        set(...args: UniformKindMap[TDefinition['kind']]): void
+      }
 
 export type UniformView<T extends UniformSchema> = {
   [K in keyof T]: UniformMethods<T[K]>
@@ -457,13 +400,13 @@ export type AttributeKind =
   | 'uvec3'
   | 'uvec4'
 
-export interface AttributeOptions {
+export interface AttributeDefinition {
   kind: AttributeKind
   instanced?: boolean
   buffer?: WebGLBuffer
 }
 
-export type AttributeSchema = Record<string | symbol, AttributeOptions>
+export type AttributeSchema = Record<string | symbol, AttributeDefinition>
 
 export interface AttributeMethods<T = AttributeKind> {
   buffer: WebGLBuffer
@@ -487,12 +430,12 @@ export interface InterleavedAttributeLayout {
   kind: AttributeKind
 }
 
-export interface InterleavedAttributeOptions {
+export interface InterleavedAttributeDefinition {
   layout: InterleavedAttributeLayout[]
   instanced?: boolean
 }
 
-export type InterleavedAttributeSchema = Record<string | symbol, InterleavedAttributeOptions>
+export type InterleavedAttributeSchema = Record<string | symbol, InterleavedAttributeDefinition>
 
 export interface InterleavedAttributeMethods<
   T extends InterleavedAttributeLayout[] = InterleavedAttributeLayout[],
@@ -513,12 +456,12 @@ export type InterleavedAttributeView<T extends InterleavedAttributeSchema> = {
 /*                                                                                */
 /**********************************************************************************/
 
-export interface BufferOptions {
+export interface BufferDefinition {
   target?: GLTarget
   usage?: GLUsage
 }
 
-export type BufferSchema = Record<string | symbol, BufferOptions>
+export type BufferSchema = Record<string | symbol, BufferDefinition>
 
 export interface BufferMethods {
   set(data: Float32Array | Uint16Array | Uint32Array): void
@@ -536,12 +479,12 @@ export type BufferView<T extends BufferSchema> = {
 /*                                                                                */
 /**********************************************************************************/
 
-export interface FramebufferOptions extends Omit<TextureOptions, 'data'> {
+export interface FramebufferDefinition extends Omit<TextureDefinition, 'data'> {
   attachment: 'color' | 'depth' | 'stencil' | 'depthStencil'
   texture?: WebGLTexture
 }
 
-export interface TextureOptions {
+export interface TextureDefinition {
   target?: GLTextureTarget
   width: number
   height: number
@@ -574,7 +517,7 @@ export type TextureTarget =
   | 'TEXTURE_3D' // WebGL2 only
   | 'TEXTURE_2D_ARRAY' // WebGL2 only
 
-export type TextureSchema = Record<string | symbol, TextureOptions>
+export type TextureSchema = Record<string | symbol, TextureDefinition>
 
 export interface TextureMethods {
   texture: WebGLTexture
@@ -683,19 +626,21 @@ export interface ViewSchema {
 }
 
 export interface ViewSchemaPartial {
-  uniforms?: Record<string | symbol, Partial<UniformOptions>>
-  attributes?: Record<string | symbol, Partial<AttributeOptions>>
-  interleavedAttributes?: Record<string | symbol, Partial<InterleavedAttributeOptions>>
-  buffers?: Record<string | symbol, Partial<BufferOptions>>
+  uniforms?: Record<string | symbol, Partial<UniformDefinition>>
+  attributes?: Record<string | symbol, Partial<AttributeDefinition>>
+  interleavedAttributes?: Record<string | symbol, Partial<InterleavedAttributeDefinition>>
+  buffers?: Record<string | symbol, Partial<BufferDefinition>>
 }
 
 export type View<T extends ViewSchema = ViewSchema> = {
-  attributes: T['attributes'] extends AttributeSchema ? AttributeView<T['attributes']> : undefined
+  attributes: T['attributes'] extends AttributeSchema
+    ? Prettify<AttributeView<T['attributes']>>
+    : never
   interleavedAttributes: T['interleavedAttributes'] extends InterleavedAttributeSchema
-    ? InterleavedAttributeView<T['interleavedAttributes']>
-    : undefined
-  buffers: T['buffers'] extends BufferSchema ? BufferView<T['buffers']> : undefined
-  uniforms: T['uniforms'] extends UniformSchema ? UniformView<T['uniforms']> : never
+    ? Prettify<InterleavedAttributeView<T['interleavedAttributes']>>
+    : never
+  buffers: T['buffers'] extends BufferSchema ? Prettify<BufferView<T['buffers']>> : never
+  uniforms: T['uniforms'] extends UniformSchema ? Prettify<UniformView<T['uniforms']>> : never
 }
 
 /**********************************************************************************/
@@ -709,21 +654,28 @@ export interface GLSLResult {
   schema: ViewSchema
 }
 
-type GLSLSlotItem = GLSLTag | UniformTag | AttributeTag | InterleaveTag | string | number | symbol
+type GLSLSlotItem =
+  | GLSL
+  | UniformToken
+  | AttributeToken
+  | InterleaveToken
+  | string
+  | number
+  | symbol
 
 export type GLSLSlot = GLSLSlotItem | Array<GLSLSlotItem>
 
-export interface GLSLTag<TSlots extends GLSLSlot[] = GLSLSlot[]> {
+export interface GLSL<TSlots extends GLSLSlot[] = GLSLSlot[]> {
   type: 'glsl'
   template: TemplateStringsArray
   slots: TSlots
 }
 
-export type UniformTag<
+export type UniformToken<
   TKey extends string | symbol = string | symbol,
   TKind extends UniformKind = UniformKind,
-  TOptions extends Partial<UniformOptions> = UniformOptions,
-> = TOptions extends { size: infer TSize }
+  TDefinition extends Partial<UniformDefinition> = UniformDefinition,
+> = TDefinition extends { size: infer TSize }
   ? {
       type: 'uniform'
       kind: TKind
@@ -736,15 +688,15 @@ export type UniformTag<
       key: TKey
     }
 
-export interface UniformTagFn<TKind extends UniformKind> {
-  <const TKey extends string | symbol, const TOptions extends Omit<UniformOptions, 'kind'>>(
+export interface UniformTokenFn<TKind extends UniformKind> {
+  <const TKey extends string | symbol, const TDefinition extends Omit<UniformDefinition, 'kind'>>(
     key: TKey,
-    TOptions: TOptions,
-  ): Prettify<UniformTag<TKey, TKind, TOptions>>
-  <const TName extends string | symbol>(key: TName): Prettify<UniformTag<TName, TKind>>
+    TDefinition: TDefinition,
+  ): Prettify<UniformToken<TKey, TKind, TDefinition>>
+  <const TName extends string | symbol>(key: TName): Prettify<UniformToken<TName, TKind>>
 }
 
-export interface AttributeTag<
+export interface AttributeToken<
   TKey extends string | symbol = string | symbol,
   TKind extends AttributeKind = AttributeKind,
   TInstanced extends boolean | undefined = boolean | undefined,
@@ -755,24 +707,98 @@ export interface AttributeTag<
   key: TKey
 }
 
-export interface AttributeTagFn<TKey extends AttributeKind> {
-  <TName extends string | symbol, TOptions extends Omit<AttributeOptions, 'kind'>>(
+export interface AttributeTokenFn<TKey extends AttributeKind> {
+  <TName extends string | symbol, TDefinition extends Omit<AttributeDefinition, 'kind'>>(
     key: TName,
-    options: TOptions,
-  ): Prettify<AttributeTag<TName, TKey, TOptions['instanced']>>
-  <TName extends string | symbol>(key: TName): Prettify<AttributeTag<TName, TKey, undefined>>
+    options: TDefinition,
+  ): Prettify<AttributeToken<TName, TKey, TDefinition['instanced']>>
+  <TName extends string | symbol>(key: TName): Prettify<AttributeToken<TName, TKey, undefined>>
 }
 
-export type InterleaveTag<
+export type InterleaveToken<
   TKey extends string | symbol = string | symbol,
-  TLayout extends Array<AttributeTag<string | symbol, AttributeKind, undefined>> = Array<
-    AttributeTag<string | symbol, AttributeKind, undefined>
+  TLayout extends Array<AttributeToken<string | symbol, AttributeKind, undefined>> = Array<
+    AttributeToken<string | symbol, AttributeKind, undefined>
   >,
-  TOptions extends Omit<AttributeOptions, 'kind'> = Omit<AttributeOptions, 'kind'>,
-> = TOptions & {
+  TDefinition extends Omit<AttributeDefinition, 'kind'> = Omit<AttributeDefinition, 'kind'>,
+> = TDefinition & {
   key: TKey
   type: 'interleavedAttribute'
   layout: {
     [TKey in keyof TLayout]: Prettify<Pick<TLayout[TKey], 'kind' | 'key'>>
   }
 }
+
+export type GLSLToSchema<T extends GLSL> =
+  FlattenSlots<T> extends infer TSlots
+    ? TSlots extends Array<any>
+      ? GLSLSlotsToSchema<TSlots>
+      : never
+    : never
+
+export type GLSLToView<T extends GLSL> = View<GLSLToSchema<T>>
+
+export type GLSLSlotsToSchema<TSlots extends Array<GLSLSlot>> = {
+  uniforms: {
+    [K in Extract<TSlots[number], UniformToken> as K['key']]: Prettify<Omit<K, 'name' | 'type'>>
+  }
+  attributes: {
+    [K in Extract<TSlots[number], AttributeToken> as K['key']]: Prettify<Omit<K, 'name' | 'type'>>
+  }
+  interleavedAttributes: {
+    [K in Extract<TSlots[number], InterleaveToken> as K['key']]: Prettify<Omit<K, 'name' | 'type'>>
+  }
+}
+
+type FlattenSlots<T> =
+  T extends GLSL<infer TSlots>
+    ? _FlattenSlots<TSlots>
+    : T extends Array<GLSLSlot>
+      ? _FlattenSlots<T>
+      : never
+
+type _FlattenSlots<T extends Array<GLSLSlot>> = T extends [infer First, ...infer Rest]
+  ? First extends GLSL
+    ? [...FlattenSlots<First>, ...FlattenSlots<Rest>]
+    : First extends unknown[]
+      ? [...FlattenSlots<First>, ...FlattenSlots<Rest>]
+      : [First, ...FlattenSlots<Rest>]
+  : []
+
+export type MergeGLSLSchema<
+  TVertex extends ViewSchema,
+  TFragment extends ViewSchema,
+  TOverrides extends ViewSchemaPartial = {},
+> = {
+  uniforms: DeepMerge<
+    [ShallowMerge<[TVertex['uniforms'], TFragment['uniforms']]>, TOverrides['uniforms']]
+  >
+  attributes: DeepMerge<
+    [ShallowMerge<[TVertex['attributes'], TFragment['attributes']]>, TOverrides['attributes']]
+  >
+  interleavedAttributes: DeepMerge<
+    [
+      ShallowMerge<[TVertex['interleavedAttributes'], TFragment['interleavedAttributes']]>,
+      TOverrides['interleavedAttributes'],
+    ]
+  >
+}
+
+export type CompileResult<
+  TVertex extends GLSL,
+  TFragment extends GLSL,
+  TOverrideSchema extends ViewSchemaPartial,
+> =
+  MergeGLSLSchema<
+    GLSLToSchema<TVertex>,
+    GLSLToSchema<TFragment>,
+    TOverrideSchema
+  > extends infer TSchema extends ViewSchema
+    ? {
+        program: WebGLProgram
+        schema: TSchema
+        view: Prettify<View<TSchema>>
+        vertex: string
+        fragment: string
+      }
+    : never

package/src/utils/index.ts

@@ -1,10 +1,10 @@
 import type {
   AttributeKind,
-  FramebufferOptions,
+  FramebufferDefinition,
   GL,
   KIND_TO_SIZE_MAP,
   KIND_TO_UNIFORM_FN_NAME_MAP,
-  TextureOptions,
+  TextureDefinition,
   UniformKind,
 } from '../types'
 
@@ -158,7 +158,7 @@ export function createTexture(
     wrapT = 'CLAMP_TO_EDGE',
     width,
     height,
-  }: TextureOptions,
+  }: TextureDefinition,
   data?: ArrayBufferView | null,
 ): WebGLTexture {
   const texture = gl.createTexture()
@@ -229,7 +229,10 @@ class FramebufferError extends Error {
   }
 }
 
-export function createFramebuffer(gl: GL, { attachment, texture, ...options }: FramebufferOptions) {
+export function createFramebuffer(
+  gl: GL,
+  { attachment, texture, ...options }: FramebufferDefinition,
+) {
   // Create texture for the framebuffer
   texture ??= createTexture(gl, options)