WebGL API
Namespaces​
Enumerations​
Interfaces​
- AABB
- API
- APIOptions
- BoundingSphere
- Camera
- CameraController
- CameraProperties
- ColorHighlightParams
- DeviationColorGradientNode
- DeviceProfile
- DirectionalLight
- DynamicAsset
- DynamicObject
- ElevationColorGradientNode
- Environment
- EnvironmentDescription
- FlightControllerParams
- GeoLocation
- GrayscaleParams
- HSLAOptions
- HierarcicalObjectReference
- Highlight
- ImageEncodeOptions_
- IntensityColorGradientNode
- LinearTransform
- MeasureInfo
- NeutralHighlightParams
- ObjectDB
- ObjectData
- ObjectHighlighter
- ObjectReference
- OrbitControllerParams
- OrthoControllerParams
- OutlineParams
- PerformanceStatistics
- PickInfo
- RGBAOptions
- RenderChanges
- RenderOutput
- RenderSettings
- Scene
- ScreenSpaceAmbientOcclusionParams
- SearchOptions
- SearchPattern
- StaticControllerParams
- TemporalAntialiasingParams
- TransparentHighlightParams
- TurntableControllerParams
- View
Type Aliases​
AtLeastOne​
Ƭ AtLeastOne<T, U>: Partial<T> & U[keyof U]
Type parameters​
| Name | Type |
|---|---|
T | T |
U | { [K in keyof T]: Pick<T, K> } |
CameraControllerParams​
Ƭ CameraControllerParams: StaticControllerParams | TurntableControllerParams | OrbitControllerParams | FlightControllerParams | OrthoControllerParams
ColorRGB​
Ƭ ColorRGB: ReadonlyVec3
Color expressed as a 3D vector with ranges [0.0 - 1.0] for red, green and blue components respectively.
ColorRGBA​
Ƭ ColorRGBA: ReadonlyVec4
Color expressed as a 4D vector with ranges [0.0 - 1.0] for red, green, blue and alpha components respectively.
FixedSizeArray​
Ƭ FixedSizeArray<N, T>: N extends 0 ? never[] : { 0: T ; length: N } & ReadonlyArray<T>
Fixed size, read-only array type.
Type parameters​
| Name | Type |
|---|---|
N | extends number |
T | T |
HSLATransformHighlightParams​
Ƭ HSLATransformHighlightParams: { kind: "hsla" } & AtLeastOne<HSLAOptions>
Hue, saturation, lightness, alpha transform highlight parameters
HighlightParams​
Ƭ HighlightParams: NeutralHighlightParams | TransparentHighlightParams | ColorHighlightParams | RGBATransformHighlightParams | HSLATransformHighlightParams
ObjectId​
Ƭ ObjectId: number
Integer index/handle for identifying a single object
ObjectIdArray​
Ƭ ObjectIdArray: ReadonlyArray<ObjectId>
Read only array of integer indices/handles for identifying a set of objects
PathInfo​
Ƭ PathInfo: Object
Type declaration​
| Name | Type |
|---|---|
centerDepth | number |
originalIndex | number |
path | string |
PostEffectParams​
Ƭ PostEffectParams: GrayscaleParams | TemporalAntialiasingParams | ScreenSpaceAmbientOcclusionParams | OutlineParams
RGBATransformHighlightParams​
Ƭ RGBATransformHighlightParams: { kind: "rgba" } & AtLeastOne<RGBAOptions>
Red, green, blue, alpha transform highlight parameters
RecursivePartial​
Ƭ RecursivePartial<T>: { [P in keyof T]?: RecursivePartial<T[P]> }
Type parameters​
| Name |
|---|
T |
RecursiveReadonly​
Ƭ RecursiveReadonly<T>: { readonly [P in keyof T]: RecursiveReadonly<T[P]> }
Type parameters​
| Name |
|---|
T |
RenderSettingsParams​
Ƭ RenderSettingsParams: Partial<Readonly<RenderSettings>>
A partial, read only variant of render settings for initial settings and updates.
Functions​
createAPI​
â–¸ createAPI(options?): API
Create an instance of the NovoRender API.
Parameters​
| Name | Type | Description |
|---|---|---|
options? | APIOptions | Custom settings APIOptions to create API. |
Returns​
An initialized API object
Throws
Error if current browser and device has insufficient 3D rendering capabilities.
â–¸ createAPI(options?): API
Create an instance of the NovoRender API.
Parameters​
| Name | Type | Description |
|---|---|---|
options? | APIOptions | Custom settings APIOptions to create API. |
Returns​
An initialized API object
Throws
Error if current browser and device has insufficient 3D rendering capabilities.