VolumeMapper & OpenGLTexture: support updating image regions

[floryst]

Context

When updating a 3D texture, the entire texture is uploaded to the GPU. If a volume is incrementally updated (e.g. slice-by-slice), then there is a lot of unchanged data being uploaded at every update.

This changeset lets the VolumeMapper specify image regions that have updated. Internally, this tells vtkOpenGLTexture to only update those regions via texSubImage3D.

This change can also be applied to other mappers that use the 3D textures, e.g. the ImageResliceMapper.

Results

The volume mapper now has the following methods: setUpdatedExtents(extents) and getUpdatedExtents(). This property defines which extents need to be updated.

const extent = [20, 49, 20, 49, 20, 49];
volumeMapper.setUpdatedExtents([...volumeMapper.getUpdatedExtents(), extent]);

This property acts as a "request" to update a set of extents. It is cleared after every successful render call.

Changes

• Documentation and TypeScript definitions were updated to match those changes
• vtkVolumeMapper and vtkImageResliceMapper: setUpdatedExtents() and getUpdatedExtents()
• vtkOpenGLTexture: support updated extents in create3D* functions

PR and Code Checklist

• semantic-release commit messages
• Run npm run reformat to have correctly formatted code

Testing

• This change adds or fixes unit tests
• Tested environment:
  • vtk.js:
  • OS:
  • Browser:

[floryst]

@sankhesh @finetjul it would be good to do a review of the API, since this is an initial draft at a working API.Some initial thoughts:

• Maybe add a addRegionsToUpdate method
• Should the regions be user-cleared or cleared after every render call

[floryst]

I've pushed a new commit:

• rename "region" to "extent" and use the existing Extent type
• minor perf improvements to the extent handling (not measured)

[finetjul]

LGTM

[floryst]

This is now ready for any final reviews @sankhesh. All commits will be squashed prior to merging.

A summary of the recent commits:

• Add updatedExtents support for the vtkImageResliceMapper
• Add a test for vtkOpenGLVolumeMapper and fix an updatedExtents-related bug in vtkOpenGLTexture

[finetjul]

LGTM

[sankhesh]

LGTM

[floryst]

I'll merge this once #3221 goes in, since I need to rebase and handle conflicts anyways.

[sedghi]

@floryst Could we perhaps release a minor version with the installation fix before merging this larger change?

#3231
#3226

[floryst]

Oh I saw your comment a little too late, sorry. I'll get a fix out for that.

[github-actions]

🎉 This PR is included in version 32.12.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀