Function mapGroups

  • mapGroups(maps?, to?): any

  • Groups the values of gpgpu data across draw passes and data textures.

    Parameters

    • Optionalmaps: {
          values: any;
          channelsMax: undefined | number;
          buffersMax: undefined | number | false;
          packed: any;
      } = {}

      Initial maps settings; new object if not given.

      • values: any

        An array where each number denotes how many value channels are grouped into one data-texture in one draw pass (where any value map logic isn't handled here); each separate number may be computed across one or more data-textures/passes.

        Each value denotes the number of dependent channels to compute together; separate values denote channels that are independent, and may be drawn in the same or separate passes, depending on settings/support.

        The order may affect the number of textures/passes needed; can maintain order as-is, or use a more efficient packed order. See packValues.

      • channelsMax: undefined | number

        Maximum channels per-texture.

      • buffersMax: undefined | number | false

        Maximum textures that may be bound as buffer outputs per-pass. Maps multiple passes per-step to output all values if they're spread across more textures than this number. Uses one pass and binds no output if given falsey; useful for side-effects with no state outputs, like rendering. See toData.

      • packed: any

        An array of indexes into values packed into an order that best fits into blocks of channelsMax to minimise resources; or falsey to use values in their given order; uses packValues if not given.

    • Optionalto: any = maps

      An object to contain the results; modifies maps if not given.

    Returns any

    to The given to object; how values are grouped per-texture per-pass per-step, meta information, and given parameters.

    See

    Example: ``` const x = 2; const y = 4; const z = 1; const maps = { values: [x, y, z], channelsMax: 4 }; // No optimisations - values not packed, single texture output per pass. mapGroups({ ...maps, buffersMax: 1, packed: false }); // => { ...maps, packed: false, textures: [[0], [1], [2]], // length === 3 passes: [[0], [1], [2]], // length === 3 valueToTexture: [0, 1, 2], valueToPass: [0, 1, 2], textureToPass: [0, 1, 2] }; // Automatically packed values - values across fewer textures/passes. mapGroups({ ...maps, buffersMax: 1 }); // => { ...maps, packed: [1, 0, 2], textures: [[1], [0, 2]], // length === 2 passes: [[0], [1]], // length === 2 valueToTexture: [1, 0, 1], valueToPass: [1, 0, 1], textureToPass: [0, 1] }; // Can bind more texture outputs per pass - values across fewer passes. mapGroups({ ...maps, buffersMax: 4 }); // => { ...maps, packed: [1, 0, 2], textures: [[1], [0, 2]], // length === 2 passes: [[0, 1]], // length === 1 valueToTexture: [1, 0, 1], valueToPass: [0, 0, 0], textureToPass: [0, 0] }; // Custom packed values - fuller control. mapGroups({ ...maps, buffersMax: 4, packed: [0, 2, 1] }); // => { ...maps, packed: [0, 2, 1], textures: [[0, 2], [1]], // length === 2 passes: [[0, 1]], // length === 1 valueToTexture: [0, 1, 0], valueToPass: [0, 0, 0], textureToPass: [0, 0] }; // Merge dependent values - fuller control, but no map for merged values. mapGroups({ ...maps, values: [x+z, y], buffersMax: 4 }); // => { ...maps, packed: [1, 0], textures: [[1], [0]], // length === 2 passes: [[0, 1]], // length === 1 valueToTexture: [1, 0], valueToPass: [0, 0], textureToPass: [0, 0] }; ```

Settings

Member Visibility