Function toData

  • toData(api, state?, to?): any

  • Set up the gpgpu resources and meta info for a state of a number data.

    Parameters

    • api: {
          texture: any;
          framebuffer: any;
      }

      The API for GL resources.

      • texture: any

        Function creating GL textures.

      • framebuffer: any

        Function creating GL framebuffers.

    • Optionalstate: {
          width: undefined | number;
          w: undefined | number;
          x: undefined | number;
          ʼ0ʼ: undefined | number;
          height: undefined | number;
          h: undefined | number;
          y: undefined | number;
          ʼ1ʼ: undefined | number;
          shape: undefined | number;
          size: undefined | number;
          side: undefined | number;
          scale: undefined | number;
          steps: undefined | number | any[];
          maps: undefined | {
              values: any;
              channelsMin: undefined | number;
          };
      } = {}

      The state parameters.

      • width: undefined | number

        Data width, aliases follow in order of precedence. See getWidth.

      • w: undefined | number

        Alias of state.width. See getWidth.

      • x: undefined | number

        Alias of state.width. See getWidth.

      • ʼ0ʼ: undefined | number

        Alias of state.width. See getWidth.

      • height: undefined | number

        Data height, aliases follow in order of precedence. See getHeight.

      • h: undefined | number

        Alias of state.height. See getHeight.

      • y: undefined | number

        Alias of state.height. See getHeight.

      • ʼ1ʼ: undefined | number

        Alias of state.height. See getHeight.

      • shape: undefined | number

        Data size. See getWidth and getHeight.

      • size: undefined | number

        Data size. See getWidth and getHeight.

      • side: undefined | number

        Data size of width/height. See getWidth and getHeight.

      • scale: undefined | number

        Data size of width/height as a square power-of-two size, 2 raised to this power. See toScaled.

      • steps: undefined | number | any[]

        How many steps of state to track, or the list of states if already set up.

      • maps: undefined | {
            values: any;
            channelsMin: undefined | number;
        }

        How state.maps.values are grouped per-texture per-pass per-step. See mapGroups.

    • Optionalto: any = state

      The state object to set up. Modifies the given state object by default.

    Returns any

    to The state object, set up with the data resources and meta information, for use with toStep and drawing:

    Example: ``` const api = { framebuffer: ({ depth, stencil, width, height, color }) => null, texture: ({ type, min, mag, wrap, width, height, channels }) => null }; // Example with `webgl_draw_buffers` extension support, for 4 buffers. let maps = mapGroups({ values: [1, 2, 3], buffersMax: 4, packed: 0 }); let state = { steps: 2, side: 10, maps }; const s0 = toData(api, state, {}); // => { ...state, size: { steps: 2, passes: 2, textures: 4, width: 10, height: 10, shape: [10, 10], entries: 100 }, steps: [[s0.passes[0][0].framebuffer], [s0.passes[1][0].framebuffer]], // This setup results in fewer passes, as more buffers can be bound. passes: [ [ { framebuffer: api.framebuffer(s0.passes[0][0]), color: [s0.textures[0][0].texture, s0.textures[0][1].texture], map: [0, 1], // maps.passes[0] entry: 0, index: 0, step: 0, depth: false, stencil: false, width: 10, height: 10 } ], [ { framebuffer: api.framebuffer(s0.passes[1][0]), color: [s0.textures[1][0].texture, s0.textures[1][1].texture], map: [0, 1], // maps.passes[0] entry: 1, index: 0, step: 1, depth: false, stencil: false, width: 10, height: 10 } ] ], textures: [ [ { texture: api.texture(s0.textures[0][0]), map: [0, 1], // maps.textures[0] entry: 0, index: 0, step: 0, pass: 0, type: 'float', width: 10, height: 10, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' }, { texture: api.texture(s0.textures[0][1]), map: [2], // maps.textures[1] entry: 1, index: 1, step: 0, pass: 0, type: 'float', width: 10, height: 10, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' } ], [ { texture: api.texture(s0.textures[1][0]), map: [0, 1], // maps.textures[0] entry: 2, index: 0, step: 1, pass: 0, type: 'float', width: 10, height: 10, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' }, { texture: api.texture(s0.textures[1][1]), map: [2], // maps.textures[1] entry: 3, index: 1, step: 1, pass: 0, type: 'float', width: 10, height: 10, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' } ] ] }; // Example with no `webgl_draw_buffers` extension support, only 1 buffer. maps = mapGroups({ values: [1, 2, 3], buffersMax: 1, packed: 0 }); state = { type: 'uint8', steps: 2, scale: 5, maps }; const s1 = toData(api, state, {}); // => { ...state, size: { steps: 2, passes: 4, textures: 4, width: 32, height: 32, shape: [32, 32], entries: 1024 }, steps: [ [s1.passes[0][0].framebuffer, s1.passes[0][1].framebuffer], [s1.passes[1][0].framebuffer, s1.passes[1][1].framebuffer] ], // This setup results in more passes, as fewer buffers can be bound. passes: [ [ { framebuffer: api.framebuffer(s1.passes[0][0]), color: [s1.textures[0][0].texture], map: [0], // maps.passes[0] entry: 0, index: 0, step: 0, depth: false, stencil: false, width: 32, height: 32 }, { framebuffer: api.framebuffer(s1.passes[0][1]), color: [s1.textures[0][1].texture], map: [1], // maps.passes[1] entry: 1, index: 1, step: 0, depth: false, stencil: false, width: 32, height: 32 } ], [ { framebuffer: api.framebuffer(s1.passes[1][0]), color: [s1.textures[1][0].texture], map: [0], // maps.passes[0] entry: 2, index: 0, step: 1, depth: false, stencil: false, width: 32, height: 32 }, { framebuffer: api.framebuffer(s1.passes[1][1]), color: [s1.textures[1][1].texture], map: [1], // maps.passes[1] entry: 3, index: 1, step: 1, depth: false, stencil: false, width: 32, height: 32 } ] ], textures: [ [ { texture: api.texture(s1.textures[0][0]), map: [0, 1], // maps.textures[0] entry: 0, index: 0, step: 0, pass: 0, type: 'uint8', width: 32, height: 32, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' }, { texture: api.texture(s1.textures[0][1]), map: [2], // maps.textures[1] entry: 1, index: 1, step: 0, pass: 1, type: 'uint8', width: 32, height: 32, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' } ], [ { texture: api.texture(s1.textures[1][0]), map: [0, 1], // maps.textures[0] entry: 2, index: 0, step: 1, pass: 0, type: 'uint8', width: 32, height: 32, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' }, { texture: api.texture(s1.textures[1][1]), map: [2], // maps.textures[1] entry: 3, index: 1, step: 1, pass: 1, type: 'uint8', width: 32, height: 32, channels: 4, min: 'nearest', mag: 'nearest', wrap: 'clamp' } ] ] }; ```

    Todo

    Example using merge.

    See

Settings

Member Visibility