Class RenderEffect

Hierarchy

RenderEffect

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new RenderEffect(viewer: Viewer): RenderEffect

Parameters
- viewer: Viewer
Returns RenderEffect

Accessors

Cesium3DTileColorBlendMode

get Cesium3DTileColorBlendMode(): Cesium3DTileColorBlendMode
set Cesium3DTileColorBlendMode(val: Cesium3DTileColorBlendMode): void

Returns Cesium3DTileColorBlendMode
Parameters
- val: Cesium3DTileColorBlendMode
Returns void

ambientOcclusionState

get ambientOcclusionState(): AmbientOcclusionState

Returns AmbientOcclusionState

backgroundColor

get backgroundColor(): Color
set backgroundColor(clr: Color): void

Returns Color
Parameters
- clr: Color
Returns void

bloomState

get bloomState(): BloomState

Returns BloomState

directionalLight

get directionalLight(): DirectionalLight

Returns DirectionalLight

edgeColor

get edgeColor(): Color
set edgeColor(clr: Color): void

Returns Color
Parameters
- clr: Color
Returns void

enable2DPick

get enable2DPick(): boolean
set enable2DPick(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

enableACESFilmic

get enableACESFilmic(): boolean
set enableACESFilmic(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableDrawOnTop

get enableDrawOnTop(): boolean
set enableDrawOnTop(val: boolean): void

Returns boolean
Parameters
- val: boolean
Returns void

enableEdge

get enableEdge(): boolean
set enableEdge(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableEnvironmentMaps

get enableEnvironmentMaps(): boolean
set enableEnvironmentMaps(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableFXAA

get enableFXAA(): boolean
set enableFXAA(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableFsr

get enableFsr(): boolean
set enableFsr(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableFsrDebug

get enableFsrDebug(): boolean
set enableFsrDebug(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableMSAA

get enableMSAA(): boolean
set enableMSAA(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableSMAA

get enableSMAA(): boolean
set enableSMAA(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableSSAO

get enableSSAO(): boolean
set enableSSAO(val: boolean): void

Returns boolean
Parameters
- val: boolean
Returns void

enableShadow

get enableShadow(): boolean
set enableShadow(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableSharpen

get enableSharpen(): boolean
set enableSharpen(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableStaticRender

get enableStaticRender(): boolean
set enableStaticRender(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableTAA

get enableTAA(): boolean
set enableTAA(enable: boolean): void

Returns boolean
Parameters
- enable: boolean
Returns void

enableWeather

get enableWeather(): WeatherType
set enableWeather(weatherType: WeatherType): void

Returns WeatherType
Parameters
- weatherType: WeatherType
Returns void

fsrScale

get fsrScale(): number
set fsrScale(scale: number): void

Returns number
Parameters
- scale: number
Returns void

iblEnvmapUrl

get iblEnvmapUrl(): string
set iblEnvmapUrl(src: string): void

Returns string
Parameters
- src: string
Returns void

iblIntensity

get iblIntensity(): number
set iblIntensity(src: number): void

Returns number
Parameters
- src: number
Returns void

iblLimitFileSizeInBytes

get iblLimitFileSizeInBytes(): number
set iblLimitFileSizeInBytes(val: number): void

Returns number
Parameters
- val: number
Returns void

iblProcessResultCallback

set iblProcessResultCallback(fn: (responseInfo: { errMsg: string; msg: string; progress: number; resource: string; status: string; success: boolean }) => void): void

Parameters
- fn: (responseInfo: { errMsg: string; msg: string; progress: number; resource: string; status: string; success: boolean }) => void
  - - (responseInfo: { errMsg: string; msg: string; progress: number; resource: string; status: string; success: boolean }): void
    - Parameters
      - responseInfo: { errMsg: string; msg: string; progress: number; resource: string; status: string; success: boolean }
        
        errMsg: string
        
        msg: string
        
        progress: number
        
        resource: string
        
        status: string
        
        success: boolean
      Returns void
Returns void

iblRotation

get iblRotation(): number
set iblRotation(src: number): void

Returns number
Parameters
- src: number
Returns void

iblShowSkybox

get iblShowSkybox(): boolean
set iblShowSkybox(isShow: boolean): void

Returns boolean
Parameters
- isShow: boolean
Returns void

isProjectionBIM

get isProjectionBIM(): boolean
set isProjectionBIM(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

isRenderWireframe

get isRenderWireframe(): boolean
set isRenderWireframe(val: boolean): void

Returns boolean
Parameters
- val: boolean
Returns void

isUseOrthCamera

get isUseOrthCamera(): boolean
set isUseOrthCamera(isEnabled: boolean): void

Returns boolean
Parameters
- isEnabled: boolean
Returns void

limitGPUMem

get limitGPUMem(): number
set limitGPUMem(memInGB: number): void

Returns number
Parameters
- memInGB: number
Returns void

luminanceAtZenith

get luminanceAtZenith(): number
set luminanceAtZenith(luminanceAtZenith: number): void

Returns number
Parameters
- luminanceAtZenith: number
Returns void

maximumMemoryUsage

get maximumMemoryUsage(): number
set maximumMemoryUsage(val: number): void

Returns number
Parameters
- val: number
Returns void

maximumScreenSpaceError

get maximumScreenSpaceError(): number
set maximumScreenSpaceError(val: number): void

Returns number
Parameters
- val: number
Returns void

qualitySettings

get qualitySettings(): QualityType
set qualitySettings(qualityType: QualityType): void

Returns QualityType
Parameters
- qualityType: QualityType
Returns void

rootTileUnLoad

get rootTileUnLoad(): boolean
set rootTileUnLoad(val: boolean): void

Returns boolean
Parameters
- val: boolean
Returns void

skipLOD

get skipLOD(): boolean
set skipLOD(val: boolean): void

Returns boolean
Parameters
- val: boolean
Returns void

skyBox

get skyBox(): undefined | SkyBox
set skyBox(skyBox: undefined | SkyBox): void

Returns undefined | SkyBox
Parameters
- skyBox: undefined | SkyBox
Returns void

specularEnvironmentMaps

get specularEnvironmentMaps(): undefined | string

Returns undefined | string

sphericalHarmonicCoefficients

get sphericalHarmonicCoefficients(): undefined | Vector3[]

Returns undefined | Vector3[]

sunlightIntensity

get sunlightIntensity(): number
set sunlightIntensity(value: number): void

Returns number
Parameters
- value: number
Returns void

toneMappingFilmic

get toneMappingFilmic(): ToneMappingFilmic

Returns ToneMappingFilmic

useGradual

get useGradual(): boolean
set useGradual(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

Methods

colorBlendMode

colorBlendMode(value: boolean): void

Parameters
- value: boolean
Returns void

setEnvironmentMaps

setEnvironmentMaps(specularEnvironmentMaps: undefined | string, sphericalHarmonicCoefficients: undefined | Vector3[]): void

Parameters
- specularEnvironmentMaps: undefined | string
- sphericalHarmonicCoefficients: undefined | Vector3[]
Returns void