API / geotoolkit3d / scene / reservoir / hexahedral / ReservoirGrid / ReservoirGrid
hexahedral.ReservoirGrid.ReservoirGrid
Type Aliases
Type Aliases
Ƭ CommonOptions: Object
| Name | Type | Description |
|---|---|---|
computecellsvolume | boolean | If set to true, compute cells volume. If false, will be computed when the volume is first queried. Volume can then be obtained using ReservoirData#getReservoirFullVolume(), or per cell through ReservoirData#getCellData(cellIndex).volume. |
enabletransparency | boolean | (Very GPU intensive) If enabled, the reservoir is allowed to render with transparency in case its opacity is set to < 1, or if a colorProvider with transparency is provided. Please be aware that to render the reservoir correctly with transparency, multiple optimizations need to be turned off, which will dramatically reduce the rendering performances. To ensure a correct render, the Plot depth peeling option must be enabled (is enabled by default). |
highlightmode | HighlightMode | The reservoir highlight mode. |
Ƭ MemoryCapabilitiesInfo: Object
| Name | Type | Description |
|---|---|---|
limitation | Limitation | Describe the current bottleneck for the provided estimation. Please note that if the VRAM argument is not provided, it is not possible to tell if the GPU memory is the current limitation. |
maxcells | number | The maximum number of cells that can be loaded safely, with the given memory information. For example, if the result is 1000,000 cells, one can imagine loading a ReservoirGrid of dimensions of 100100100 (or any combinations that leads to one million). Please keep in mind this is only an estimation, even if the VRAM option is provided, browsers and OSes handle RAM and VRAM memory very differently. |
Ƭ MemoryEstimationOptions: Object
| Name | Type | Description |
|---|---|---|
additionalproperties? | number | (Optional) Each additional properties (on top of the main property) use an extra 4 bytes per cell. Default value is 0. |
occlusion? | number | (Optional) Ratio of the cells that are occluded compared to total cells count. 0.2 means 20% occluded, and 1 means 100% occluded. Thanks to cell occlusion optimization, not all cells are rendered at all time, at most only 60% of cells are visible (40% occluded) at the same time (even with filters applied), and on average 20% only are visible (80% occluded), thus reducing the actual video memory usage. By setting this option the occlusion optimization will be taken into calculation. The total number of cells capable of loading can be larger. |
ram | number | The amount of estimated available RAM in bytes, that the ReservoirGrid visual can allocate. This accounts for the TypedArray passed as constructor parameters to ReservoirData, which are reused internally. On average, ReservoirGrid will use 112 bytes of RAM per cell, with an additional 4 bytes per additional cell property. Additional features such as intersections and transparency can create additional memory spikes. |
useintersection? | boolean | (Optional) Use an extra amount of RAM per cell if intersections are used. Default is false. |
vram? | number | (Optional) The amount of estimated available VRAM (Video Memory) in bytes, that the ReservoirGrid visual can allocate. ReservoirGrid will use 100 bytes of VRAM per cell. But for the purpose of estimating the maximum capabilities, this method will assume that all cells will be loaded in GPU memory. |
Ƭ Options: Merge<OptionsBase, { data: ReservoirData ; disableigpuwarning?: boolean }>
Ƭ OptionsBase: Partial<CommonOptions> & Options & Omit<OptionsBase, "skeleton"> & { skeleton?: SkeletonOptions } & Options
Ƭ OptionsBaseOut: CommonOptions & Required<Options> & OptionsBaseOut & Required<Options>