Function macroOutput

  • macroOutput(state, on?): string

  • Defines the outputs being drawn to per-pass, as GLSL preprocessor macros.

    These macros define mappings from values to their outputs, if bound. Caches the result if macros generation is enabled, to help reuse shaders.

    Parameters

    • state: any

      Properties for generating the macros. See toData:

    • Optionalon: string

      Any further macro hooks specifier; if given, both the hook key and this specifier are checked (e.g: key and key_on).

    Returns string

    GLSL preprocessor macros for the pass's bound outputs.

    See

    Example: ```javascript const maps = { values: [2, 4, 1], channelsMax: 4 }; // No optimisations - values not packed, single texture output per pass. const state = { pre: '', passNow: 0, maps: mapGroups({ ...maps, buffersMax: 1, packed: 0 }) }; macroOutput(state); // => '#define passNow 0\n'+ '\n'+ '#define bound_0 0\n'+ '#define attach_0 0\n'+ '#define output_0 gl_FragData[attach_0].rg\n'+ '\n'; // Automatically packed values - values across fewer textures/passes. state.maps = mapGroups({ ...maps, buffersMax: 1 }); macroOutput(state); // => '#define passNow 0\n'+ '\n'+ '#define bound_1 0\n'+ '#define attach_1 0\n'+ '#define output_1 gl_FragData[attach_1].rgba\n'+ '\n'; // Next pass in this step. ++state.passNow; macroOutput(state); // => '#define passNow 1\n'+ '\n'+ '#define bound_0 1\n'+ '#define attach_0 0\n'+ '#define output_0 gl_FragData[attach_0].rg\n'+ '\n'+ '#define bound_2 1\n'+ '#define attach_2 0\n'+ '#define output_2 gl_FragData[attach_2].b\n'+ '\n'; // Can bind more texture outputs per pass - values across fewer passes. state.maps = mapGroups({ ...maps, buffersMax: 4 }); state.passNow = 0; macroOutput(state); // => '#define passNow 0\n'+ '\n'+ '#define bound_1 0\n'+ '#define attach_1 0\n'+ '#define output_1 gl_FragData[attach_1].rgba\n'+ '\n'+ '#define bound_0 1\n'+ '#define attach_0 1\n'+ '#define output_0 gl_FragData[attach_0].rg\n'+ '\n'+ '#define bound_2 1\n'+ '#define attach_2 1\n'+ '#define output_2 gl_FragData[attach_2].b\n'+ '\n'; ```

Settings

Member Visibility