deck.gl icon indicating copy to clipboard operation
deck.gl copied to clipboard

docs(core) replace `glOptions` with `deviceProps`

Open chrisgervang opened this issue 1 year ago • 5 comments

Closes #8896

Background

glOptions was removed in v9 and replaced by deviceProps.

Change List

  • removes glOptions (this has not been functional since v9)
  • docs for device and deviceProps
  • upgrade guide
  • [ ] type as deviceProps: WebGLDeviceProps | WebGPUDeviceProps (need to update luma)

chrisgervang avatar Jun 11 '24 21:06 chrisgervang

Coverage Status

coverage: 89.671% (-0.001%) from 89.672% when pulling c4c213989eac294eee4605f7cdfc4472705573ed on chr/device-props-docs into 93518480a5b2cd3bcd7e305e893e58238490dd51 on master.

coveralls avatar Jun 11 '24 21:06 coveralls

Coverage Status

coverage: 89.562% (-0.1%) from 89.672% when pulling cdd6454dcdd5505487dfd0729cd50f14890d4771 on chr/device-props-docs into 93518480a5b2cd3bcd7e305e893e58238490dd51 on master.

coveralls avatar Jun 15 '24 17:06 coveralls

Coverage Status

coverage: 89.562% (-0.1%) from 89.672% when pulling cdd6454dcdd5505487dfd0729cd50f14890d4771 on chr/device-props-docs into 93518480a5b2cd3bcd7e305e893e58238490dd51 on master.

coveralls avatar Jun 15 '24 17:06 coveralls

Coverage Status

coverage: 89.404%. remained the same when pulling 8d4d4b348f8259877515f1ad3f07c7e802a7f27f on chr/device-props-docs into 537f80ba29276b63251d93dbf1ff55b5defb045e on master.

coveralls avatar Jun 20 '24 17:06 coveralls

Coverage Status

coverage: 89.252% (-0.2%) from 89.404% when pulling 23a76b1ef28c62637cf359d2d647fc13fa9abb5d on chr/device-props-docs into 537f80ba29276b63251d93dbf1ff55b5defb045e on master.

coveralls avatar Jul 06 '24 21:07 coveralls

@ibgreen where did we land on this API in luma? I can update this to reflect the latest for 9.1

chrisgervang avatar Dec 17 '24 19:12 chrisgervang

@ibgreen where did we land on this API in luma? I can update this to reflect the latest for 9.1

Just updated the PR to reflect the latest.

Another noteworthy change that is coming is that luma,gl device now takes createCanvasContext prop with subprops that overlap deck.gl canvas, parent etc. There may need to be some testing to see if both paths work, and perhaps some alignment on the deck side.

While this fiddling with device creation props does take effort and may seem like bikeshedding, the exciting goal here is that on WebGPU we will eventually be able to make deck.gl work with multiple canvases using a single device! So these API changes are worthwhile (we are not just rearranging the deck chairs, so to speak).

ibgreen avatar Dec 21 '24 20:12 ibgreen