AttachmentOptions missed logic

[kdziamura]

During the investigation, I found that parameter AttachmentOptions['attach'] is never used, but fully documented and has typescript declaration:

twgl.js/src/framebuffers.js

Line 88 in 9ed6939

* @property {number} [attach] The attachment point. Defaults

twgl.js/npm/base/index.d.ts

Line 22 in 9ed6939

attach?: number;

An actual attachment point is being selected here:

twgl.js/src/framebuffers.js

Line 200 in 9ed6939

let attachmentPoint = getAttachmentPointForFormat(format);

I'll be glad to create a pull request, but I confused with the idea of this parameter. Is it redundant legacy code and should be removed, or is it an option, that should be used as an attachment point if defined?

[munrocket]

Yeah, looks like an outdated comment that become a property in typescript.

Here usage of attachments

twgl.js/examples/mulitple-render-targets-3d-texture.html

Line 169 in 9ed6939

{ attachment: tex, target: gl.TEXTURE_3D, layer: 0, },

[kdziamura]

So the order of attachments is important. Maybe it's better to have the option of using a specific attachment point? Or, at least, add attachment point into output object? It would be great to have the availability of reusing it in some cases. To use with gl.drawBuffers for example. Here is the manual definition of them, and it could be unclear at first glance:

twgl.js/examples/mulitple-render-targets-3d-texture.html

Line 175 in 9ed6939

gl.drawBuffers([

I mean that current logic isn’t transparent. The other option is to add some parameter/s, which will run gl.drawBuffers under the hood, but it’s unclear and not flexible solution as well

[greggman]

Good catch. I'm not sure off top of my head what the best solution is. twgl is not trying to cover all of WebGL. It's just trying to make some things less verbose.

I don't think generating an input for drawBuffers is real all that useful. It's a really tiny API. Just an array with 4-8 constants. Does that really need an helper?

The simplest thing would be to remove it. Clearly no one is using it if it never worked. .

Otherwise the intent was

let attachmentPoint = attachmentOptions.attach || getAttachmentPointForFormat(format);