@kitware/vtk.js 33.0.0-beta.3 → 33.0.0-beta.5

package/Rendering/OpenGL/Texture.d.ts

@@ -1,9 +1,9 @@
 import { Wrap, Filter } from './Texture/Constants';
 import vtkOpenGLRenderWindow from './RenderWindow';
-import { Nullable } from './../../types';
+import { Extent, Nullable } from './../../types';
 import { VtkDataTypes } from './../../Common/Core/DataArray';
 import { vtkViewNode } from './../SceneGraph/ViewNode';
-import { vtkObject } from './../../interfaces';
+import { vtkObject, vtkRange } from './../../interfaces';
 
 /**
  * Initial values for creating a new instance of vtkOpenGLTexture.
@@ -199,17 +199,24 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param numComps The number of components in the texture.
    * @param dataType The data type of the texture.
    * @param data The raw data for the texture.
-   * @param flip Whether to flip the texture vertically.
+   * @param flip Whether to flip the texture vertically. Defaults to false.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFromRaw(
-    width: number,
-    height: number,
-    numComps: number,
-    dataType: VtkDataTypes,
-    data: any,
-    flip: boolean
-  ): boolean;
+  create2DFromRaw({
+    width,
+    height,
+    numComps,
+    dataType,
+    data,
+    flip,
+  }: {
+    width: number;
+    height: number;
+    numComps: number;
+    dataType: VtkDataTypes;
+    data: any;
+    flip?: boolean;
+  }): boolean;
 
   /**
    * Creates a cube texture from raw data.
@@ -218,17 +225,21 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param numComps The number of components in the texture.
    * @param dataType The data type of the texture.
    * @param data The raw data for the texture.
-   * @param flip Whether to flip the texture vertically.
    * @returns {boolean} True if the cube texture was successfully created, false otherwise.
    */
-  createCubeFromRaw(
-    width: number,
-    height: number,
-    numComps: number,
-    dataType: VtkDataTypes,
-    data: any,
-    flip: boolean
-  ): boolean;
+  createCubeFromRaw({
+    width,
+    height,
+    numComps,
+    dataType,
+    data,
+  }: {
+    width: number;
+    height: number;
+    numComps: number;
+    dataType: VtkDataTypes;
+    data: any;
+  }): boolean;
 
   /**
    * Creates a 2D texture from an image.
@@ -244,17 +255,27 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param numComps The number of components in the texture.
    * @param dataType The data type of the texture.
    * @param data The raw data for the texture.
-   * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
+   * @param [preferSizeOverAccuracy=false] Whether to prefer texture size over accuracy. Defaults to false.
+   * @param [ranges] The precomputed ranges of the data (optional). Provided to prevent computation of the data ranges.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFilterableFromRaw(
-    width: number,
-    height: number,
-    numComps: number,
-    dataType: VtkDataTypes,
-    data: any,
-    preferSizeOverAccuracy: boolean
-  ): boolean;
+  create2DFilterableFromRaw({
+    width,
+    height,
+    numComps,
+    dataType,
+    data,
+    preferSizeOverAccuracy,
+    ranges,
+  }: {
+    width: number;
+    height: number;
+    numComps: number;
+    dataType: VtkDataTypes;
+    data: any;
+    preferSizeOverAccuracy?: boolean;
+    ranges?: vtkRange[];
+  }): boolean;
 
   /**
    * Creates a 2D filterable texture from a data array, with a preference for size over accuracy if necessary.
@@ -264,69 +285,117 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFilterableFromDataArray(
-    width: number,
-    height: number,
-    dataArray: any,
-    preferSizeOverAccuracy: boolean
-  ): boolean;
+  create2DFilterableFromDataArray({
+    width,
+    height,
+    dataArray,
+    preferSizeOverAccuracy,
+  }: {
+    width: number;
+    height: number;
+    dataArray: any;
+    preferSizeOverAccuracy?: boolean;
+  }): boolean;
 
   /**
    * Creates a 3D texture from raw data.
+   *
+   * updatedExtents is currently incompatible with webgl1, since there's no extent scaling.
+   *
    * @param width The width of the texture.
    * @param height The height of the texture.
    * @param depth The depth of the texture.
    * @param numComps The number of components in the texture.
    * @param dataType The data type of the texture.
    * @param data The raw data for the texture.
+   * @param updatedExtents Only update the specified extents (default: [])
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create3DFromRaw(
-    width: number,
-    height: number,
-    depth: number,
-    numComps: number,
-    dataType: VtkDataTypes,
-    data: any
-  ): boolean;
+  create3DFromRaw({
+    width,
+    height,
+    depth,
+    numComps,
+    dataType,
+    data,
+    updatedExtents,
+  }: {
+    width: number;
+    height: number;
+    depth: number;
+    numComps: number;
+    dataType: VtkDataTypes;
+    data: any;
+    updatedExtents?: Extent[];
+  }): boolean;
 
   /**
    * Creates a 3D filterable texture from raw data, with a preference for size over accuracy if necessary.
+   *
+   * updatedExtents is currently incompatible with webgl1, since there's no extent scaling.
+   *
    * @param width The width of the texture.
    * @param height The height of the texture.
    * @param depth The depth of the texture.
    * @param numComps The number of components in the texture.
    * @param dataType The data type of the texture.
-   * @param values The raw data for the texture.
+   * @param data The raw data for the texture.
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
-   * @returns {boolean} True if the texture was successfully created, false otherwise.
-   */
-  create3DFilterableFromRaw(
-    width: number,
-    height: number,
-    depth: number,
-    numComps: number,
-    dataType: VtkDataTypes,
-    values: any,
-    preferSizeOverAccuracy: boolean
-  ): boolean;
+   * @param [ranges] The precomputed ranges of the data (optional). Provided to
+   * @param updatedExtents Only update the specified extents (default: [])
+   * prevent computation of the data ranges.
+   * @returns {boolean} True if the texture was successfully created, false
+   * otherwise.
+   */
+  create3DFilterableFromRaw({
+    width,
+    height,
+    depth,
+    numComps,
+    dataType,
+    data,
+    preferSizeOverAccuracy,
+    ranges,
+    updatedExtents,
+  }: {
+    width: number;
+    height: number;
+    depth: number;
+    numComps: number;
+    dataType: VtkDataTypes;
+    data: any;
+    preferSizeOverAccuracy?: boolean;
+    ranges?: vtkRange[];
+    updatedExtents?: Extent[];
+  }): boolean;
 
   /**
    * Creates a 3D filterable texture from a data array, with a preference for size over accuracy if necessary.
+   *
+   * updatedExtents is currently incompatible with webgl1, since there's no extent scaling.
+   *
    * @param width The width of the texture.
    * @param height The height of the texture.
    * @param depth The depth of the texture.
    * @param dataArray The data array to use for the texture.
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
+   * @param updatedExtents Only update the specified extents (default: [])
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create3DFilterableFromDataArray(
-    width: number,
-    height: number,
-    depth: number,
-    dataArray: any,
-    preferSizeOverAccuracy: boolean
-  ): boolean;
+  create3DFilterableFromDataArray({
+    width,
+    height,
+    depth,
+    dataArray,
+    preferSizeOverAccuracy,
+  }: {
+    width: number;
+    height: number;
+    depth: number;
+    dataArray: any;
+    preferSizeOverAccuracy?: boolean;
+    updatedExtents?: Extent[];
+  }): boolean;
 
   /**
    * Sets the OpenGL render window in which the texture will be used.