@niivue/niivue 0.51.0 → 0.52.0

package/build/index.d.ts

@@ -397,7 +397,7 @@ declare class NVImage {
     readECAT(buffer: ArrayBuffer): ArrayBuffer;
     readV16(buffer: ArrayBuffer): ArrayBuffer;
     imageDataFromArrayBuffer(buffer: ArrayBuffer): Promise<ImageData>;
-    readBMP(buffer: ArrayBuffer): Promise<Uint8Array>;
+    readBMP(buffer: ArrayBuffer): Promise<ArrayBuffer>;
     readVMR(buffer: ArrayBuffer): ArrayBuffer;
     readMGH(buffer: ArrayBuffer): Promise<ArrayBuffer>;
     readFIB(buffer: ArrayBuffer): Promise<[ArrayBuffer, Float32Array]>;
@@ -437,7 +437,10 @@ declare class NVImage {
         name: string;
         data: ArrayBuffer;
     }>>;
-    static fetchPartial(url: string, bytesToLoad: number, headers?: Record<string, string>): Promise<Response>;
+    static readFirstDecompressedBytes(stream: ReadableStream<Uint8Array>, minBytes: number): Promise<Uint8Array>;
+    static extractFilenameFromUrl(url: string): string | null;
+    static loadInitialVolumesGz(url?: string, headers?: {}, limitFrames4D?: number): Promise<ArrayBuffer | null>;
+    static loadInitialVolumes(url?: string, headers?: {}, limitFrames4D?: number): Promise<ArrayBuffer | null>;
     /**
      * factory function to load and return a new NVImage instance from a given URL
      * @returns  NVImage instance
@@ -682,7 +685,7 @@ type NVConfigOptions = {
     sagittalNoseLeft: boolean;
     isSliceMM: boolean;
     isV1SliceShader: boolean;
-    isHighResolutionCapable: boolean;
+    forceDevicePixelRatio: number;
     logLevel: 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'silent';
     loadingText: string;
     isForceMouseClickToVoxelCenters: boolean;
@@ -726,6 +729,8 @@ type NVConfigOptions = {
     measureLineColor: number[];
     measureTextHeight: number;
     isAlphaClipDark: boolean;
+    gradientOrder: number;
+    gradientOpacity: number;
 };
 declare const DEFAULT_OPTIONS: NVConfigOptions;
 type SceneData = {
@@ -1549,6 +1554,7 @@ declare class Niivue {
     volumeTexture: WebGLTexture | null;
     gradientTexture: WebGLTexture | null;
     gradientTextureAmount: number;
+    renderGradientValues: boolean;
     drawTexture: WebGLTexture | null;
     drawUndoBitmaps: Uint8Array[];
     drawLut: LUT;
@@ -1575,6 +1581,7 @@ declare class Niivue {
     line3DShader?: Shader;
     passThroughShader?: Shader;
     renderGradientShader?: Shader;
+    renderGradientValuesShader?: Shader;
     renderSliceShader?: Shader;
     renderVolumeShader?: Shader;
     pickingMeshShader?: Shader;
@@ -1598,7 +1605,9 @@ declare class Niivue {
     orientShaderRGBU: Shader | null;
     surfaceShader: Shader | null;
     blurShader: Shader | null;
-    sobelShader: Shader | null;
+    sobelBlurShader: Shader | null;
+    sobelFirstOrderShader: Shader | null;
+    sobelSecondOrderShader: Shader | null;
     genericVAO: WebGLVertexArrayObject | null;
     unusedVAO: any;
     crosshairs3D: NiivueObject3D | null;
@@ -2107,11 +2116,11 @@ declare class Niivue {
     getRadiologicalConvention(): boolean;
     /**
      * Force WebGL canvas to use high resolution display, regardless of browser defaults.
-     * @param isHighResolutionCapable - allow high-DPI display
+     * @param forceDevicePixelRatio - -1: block high DPI; 0= allow high DPI: >0 use specified pixel ratio
      * @example niivue.setHighResolutionCapable(true);
      * @see {@link https://niivue.github.io/niivue/features/sync.mesh.html | live demo usage}
      */
-    setHighResolutionCapable(isHighResolutionCapable: boolean): void;
+    setHighResolutionCapable(forceDevicePixelRatio: number | boolean): void;
     /**
      * add a new volume to the canvas
      * @param volume - the new volume to add to the canvas
@@ -2280,7 +2289,7 @@ declare class Niivue {
      * @example
      * niivue = new Niivue()
      * niivue.removeMesh(this.meshes[3])
-     * @see {@link https://niivue.github.io/niivue/features/multiuser.meshes.html | live demo usage}
+     * @see {@link https://niivue.github.io/niivue/features/connectome.html | live demo usage}
      */
     removeMesh(mesh: NVMesh): void;
     /**
@@ -2444,12 +2453,21 @@ declare class Niivue {
     setClipVolume(low: number[], high: number[]): void;
     /**
      * set proportion of volume rendering influenced by selected matcap.
-     * @param gradientAmount - amount of matcap (0..1), default 0 (matte, surface normal does not influence color)
+     * @param gradientAmount - amount of matcap (NaN or 0..1), default 0 (matte, surface normal does not influence color). NaN renders the gradients.
      * @example
      * niivue.setVolumeRenderIllumination(0.6);
      * @see {@link https://niivue.github.io/niivue/features/shiny.volumes.html | live demo usage}
+     * @see {@link https://niivue.github.io/niivue/features/gradient.order.html | live demo usage}
      */
     setVolumeRenderIllumination(gradientAmount?: number): Promise<void>;
+    /**
+     * set volume rendering opacity influence of the gradient magnitude
+     * @param gradientOpacity - amount of gradient magnitude influence on opacity (0..1), default 0 (no-influence)
+     * @example
+     * niivue.setGradientOpacity(0.6);
+     * @see {@link https://niivue.github.io/niivue/features/gradient.opacity.html | live demo usage}
+     */
+    setGradientOpacity(gradientOpacity?: number): Promise<void>;
     overlayRGBA(volume: NVImage): Uint8ClampedArray;
     vox2mm(XYZ: number[], mtx: mat4): vec3;
     /**
@@ -2527,12 +2545,10 @@ declare class Niivue {
     loadVolumes(volumeList: ImageFromUrlOptions[]): Promise<this>;
     /**
      * Add mesh and notify subscribers
-     * @see {@link https://niivue.github.io/niivue/features/multiuser.meshes.html | live demo usage}
      */
     addMeshFromUrl(meshOptions: LoadFromUrlParams): Promise<NVMesh>;
     /**
      * Add mesh and notify subscribers
-     * @see {@link https://niivue.github.io/niivue/features/multiuser.meshes.html | live demo usage}
      */
     addMeshesFromUrl(meshOptions: LoadFromUrlParams[]): Promise<NVMesh[]>;
     /**
@@ -2620,6 +2636,7 @@ declare class Niivue {
     refreshDrawing(isForceRedraw?: boolean, useClickToSegmentBitmap?: boolean): void;
     r8Tex(texID: WebGLTexture | null, activeID: number, dims: number[], isInit?: boolean): WebGLTexture | null;
     rgbaTex(texID: WebGLTexture | null, activeID: number, dims: number[], isInit?: boolean): WebGLTexture | null;
+    rgba16Tex(texID: WebGLTexture | null, activeID: number, dims: number[], isInit?: boolean): WebGLTexture | null;
     requestCORSIfNotSameOrigin(img: HTMLImageElement, url: string): void;
     loadPngAsTexture(pngUrl: string, textureNum: number): Promise<WebGLTexture | null>;
     loadFontTexture(fontUrl: string): Promise<WebGLTexture | null>;