Skip to main content

Interface: Cornerstone3DConfig

Properties​

debug​

debug: object

statsOverlay?​

optional statsOverlay: boolean

Wether or not to show the stats overlay for debugging purposes, stats include:

  • FPS Frames rendered in the last second. The higher the number the better.
  • MS Milliseconds needed to render a frame. The lower the number the better.
  • MB MBytes of allocated memory. (Run Chrome with --enable-precise-memory-info)

Defined in​

packages/core/src/types/Cornerstone3DConfig.ts:60

gpuTier?​

optional gpuTier: object

tier?​

optional tier: number

Defined in​

packages/core/src/types/Cornerstone3DConfig.ts:4

isMobile?​

optional isMobile: boolean

Whether the device is mobile or not.

Defined in​

packages/core/src/types/Cornerstone3DConfig.ts:8

peerImport()?​

optional peerImport: (moduleId) => Promise<any>

This function returns an imported module for the given module id. It allows replacing broken packing system imports with external importers that perform lazy imports.

Parameters​

• moduleId: string

Returns​

Promise<any>

Defined in​

packages/core/src/types/Cornerstone3DConfig.ts:76

rendering?​

optional rendering: object

preferSizeOverAccuracy?​

optional preferSizeOverAccuracy: boolean

renderingEngineMode?​

optional renderingEngineMode: RenderingEngineModeType

The rendering engine mode to use. 'contextPool' is the a rendering engine that uses sequential rendering, pararllization and has enhanced support/performance for multi-monitor and high resolution displays. 'tiled' is a rendering engine that uses tiled rendering.

strictZSpacingForVolumeViewport?​

optional strictZSpacingForVolumeViewport: boolean

flag to control whether to use fallback behavior for z-spacing calculation in volume viewports when the necessary metadata is missing. If enabled, we will fall back to using slice thickness or a default value of 1 to render the volume viewport when z-spacing cannot be calculated from images This can help improve the usability and robustness of the visualization in scenarios where the metadata is incomplete or missing, but it might be wrong assumption in certain scenarios.

useCPURendering?​

optional useCPURendering: boolean

useLegacyCameraFOV?​

optional useLegacyCameraFOV: boolean

Use the legacy camera field of view calculation method which uses bounds to calculate the field of view. When false (default), uses the image dimensions directly for more accurate full-screen display.

volumeRendering?​

optional volumeRendering: object

volumeRendering.sampleDistanceMultiplier?​

optional sampleDistanceMultiplier: number

Multiplier for the calculated sample distance

webGlContextCount?​

optional webGlContextCount: number

The number of WebGL contexts to create. This is used for parallel rendering. The default value is 7, which is suitable for mobile/desktop.

Defined in​

packages/core/src/types/Cornerstone3DConfig.ts:10