Function toUniforms

  • toUniforms(state?, to?): {
        stepNow: ((c: any, state: {
            stepNow: number;
        }) => number);
        stateShape: ((c: any, state: {
            size: {
                number: any;
            };
        }) => [number, number, number, number]);
        viewShape: ((context: {
            drawingBufferWidth: number;
            drawingBufferHeight: number;
        }, s?: any) => [number, number]);
        states: (() => []);
    }

  • Sets up GL uniform inputs for gpgpu calls, such as in toStep.

    The uniforms are defined as callback hooks to be called on each render pass with global context and local state objects, allowing the use of different GL APIs or author-defined hooks.

    Handles inputs of states as arrays of data-textures, or merged into one data-texture; for arrays of textures, this arranges them on each step so GLSL can dynamically sample the flattened array of textures by a constant step index; otherwise the single merged texture is bound once, and GLSL can use a dynamic step index to sample states.

    Parameters

    • state: {
          steps: number | any[];
          maps: {
              textures?: number[][];
          };
          pre: undefined | string;
          merge: undefined | {
              all?: {
                  texture?: any;
              };
          };
          size: undefined | {
              shape?: number[];
              merge?: {
                  shape?: number[];
              };
          };
          bound: undefined | number;
          uniforms: any;
      } = {}

      The gpgpu state. See toData and mapGroups.

      • steps: number | any[]

        The array of steps, or number of steps. See toData.

      • maps: {
            textures?: number[][];
        }

        How values are grouped into data-textures (per-pass per-step). See mapGroups.

        • Optionaltextures?: number[][]
      • pre: undefined | string

        Namespace prefix; preDef if not given.

      • merge: undefined | {
            all?: {
                texture?: any;
            };
        }

        Any merged state texture; uses separate state data-textures if not given. See toData.

      • size: undefined | {
            shape?: number[];
            merge?: {
                shape?: number[];
            };
        }

        Any size of state data-textures (as vec2(width, height)); with:

        • shape: Any state shape.
        • merge.shape: Any merged states shape, otherwise state shape.

        See toData.

      • bound: undefined | number

        Number of steps bound for output, not used for input; for platforms preventing read/write of the same texture.

      • uniforms: any

        Any object to merge the new uniforms into. See to.

    • Optionalto: any = ...

      Any object to contain the uniform hooks; modifies any state.uniforms, or a new object if not given. See state.uniforms and uniforms.

    Returns {
        stepNow: ((c: any, state: {
            stepNow: number;
        }) => number);
        stateShape: ((c: any, state: {
            size: {
                number: any;
            };
        }) => [number, number, number, number]);
        viewShape: ((context: {
            drawingBufferWidth: number;
            drawingBufferHeight: number;
        }, s?: any) => [number, number]);
        states: (() => []);
    }

    • stepNow: ((c: any, state: {
          stepNow: number;
      }) => number)
        • (c, state): number

        • Parameters

          • c: any
          • state: {
                stepNow: number;
            }
            • stepNow: number

          Returns number

    • stateShape: ((c: any, state: {
          size: {
              number: any;
          };
      }) => [number, number, number, number])
        • (c, state): [number, number, number, number]

        • Parameters

          • c: any
          • state: {
                size: {
                    number: any;
                };
            }
            • size: {
                  number: any;
              }
              • number: any

          Returns [number, number, number, number]

    • viewShape: ((context: {
          drawingBufferWidth: number;
          drawingBufferHeight: number;
      }, s?: any) => [number, number])
        • (context, s?): [number, number]

        • Parameters

          • context: {
                drawingBufferWidth: number;
                drawingBufferHeight: number;
            }
            • drawingBufferWidth: number
            • drawingBufferHeight: number
          • Optionals: any

          Returns [number, number]

    • states: (() => [])
        • (): []

        • Returns []

    Example: ```javascript const state = { pre: '', steps: 2, maps: mapStep({ values: [1, 2, 3] }) }; const api = {}; toUniforms(toData(api, { ...state, merge: false }, {})); // => { stepNow: (context, state) => {}, stateShape: (context, state) => {}, viewShape: (context, state) => {}, // Separate state data-`texture`s in an `array` (e.g: `sampler2D[]`). // State data-`texture`s for the 1st step ago, not bound as outputs. 'states[0]': (context, state) => {}, 'states[1]': (context, state) => {}, // Merged `texture` not used. states: (context, state) => null }; toUniforms(toData(api, { ...state, steps: 3, merge: false }, {})); // => { stepNow: (context, state) => {}, stateShape: (context, state) => {}, viewShape: (context, state) => {}, // Separate state data-`texture`s in an `array` (e.g: `sampler2D[]`). // State data-`texture`s for the 1st step ago, not bound as outputs. 'states[0]': (context, state) => {}, 'states[1]': (context, state) => {} // State data-`texture`s for the 2nd step ago, not bound as outputs. 'states[2]': (context, state) => {}, 'states[3]': (context, state) => {}, // Merged `texture` not used. states: (context, state) => null }; toUniforms(toData(api, { ...state, merge: true }, {})); // => { stepNow: (context, state) => {}, stateShape: (context, state) => {}, viewShape: (context, state) => {}, // Merged states in one data-`texture` upon every pass (e.g: `sampler2D`, // or `sampler3D`/`sampler2DArray` where supported). states: (context, state) => {}, // Separate data-`texture`s not used. 'states[0]': (context, state) => null, 'states[1]': (context, state) => null }; ```

    See

Settings

Member Visibility