search

greggman / twgl.js

A Tiny WebGL helper Library
http://twgljs.org
MIT License
2.61k stars 258 forks source link

what is the parameter "arrayName" of createBufferFromArray for? could it be optional? #194

Open mizok opened 2 years ago

mizok commented 2 years ago

In the document the third parameter arrayName of createBufferFromArray is said to be string type, but is not mentioned why we are giving this parameter.

So I checked attribute.js and found that this parameter is used to definite another boolean isIndice.

function createBufferFromArray(gl, array, arrayName) {
  const type = arrayName === "indices" ? ELEMENT_ARRAY_BUFFER : ARRAY_BUFFER;
  const typedArray = makeTypedArray(array, arrayName);
  return createBufferFromTypedArray(gl, typedArray, type);
}

I am just wondering if this parameter will be better if we change it to boolean type and make it optional (to me it's easier to understand)?

greggman commented 2 years ago

I think it was probably my mistake to make that function public but if you want to make arrayName optional, or give it a default of "" that's fine with me.

mizok commented 2 years ago

@greggman sure, I will make a pull request for that soon.