Skip to content
On this page

composer

Composer

Kind: global class

new Composer(opts)

后期处理类

ParamTypeDescription
optsobject后处理参数
opts.ssrEnabledboolean是否开启环境反射
opts.ssrDistancenumber环境反射距离
opts.ssrThicknessnumber环境反射强度
opts.ssaoEnabledboolean全局阴影
opts.ssaoRadiusnumber全局投影半径
opts.ssaoMinDistancenumber全局投影最小距离
opts.ssaoMaxDistancenumber全局投影最大距离
opts.dofEnabledboolean是否开启景深模糊
opts.dofFocusnumber景深焦距
opts.dofAperturenumber景深孔径
opts.dofMaxblurnumber景深最大模糊程度
opts.unrealBloomEnabledboolean是否开启泛光
opts.bloomRadiusnumber泛光半径
opts.bloomStrengthnumber泛光强度
opts.bloomThresholdnumber泛光线性衰减程度
opts.lutEnabledboolean是否开启
opts.lutIntensitynumberlut 强度
opts.lutTypenumberlut 滤镜类型
opts.lutUrlstringlut 滤镜素材地址
opts.outlineEnabledboolean是否泛光
opts.gammaEnabledboolean是否开启颜色校正
opts.smaaEnabledboolean是否开启 smaa 抗锯齿
opts.distortEnabledboolean是否开启色差
opts.distortIntensitynumber色差强度
opts.fxaaEnabledboolean是否开启 fxaa 抗锯齿
opts.msaaEnabledboolean是否开启 msaa 抗锯齿
opts.samplesbooleanmsaa 的重采样次数

composer.enableComposer(enable)

是否开启后处理效果合成器

Kind: instance method of Composer

ParamTypeDescription
enableboolean是否开启

composer.enableGammaCorrect(enable)

是否开启颜色校正

Kind: instance method of Composer

ParamType
enable*

composer.enableSaoPass(enable)

sao 开关

Kind: instance method of Composer

ParamType
enableboolean

composer.enableOutlinePass(enable)

是否开启外轮廓高亮

Kind: instance method of Composer

ParamType
enableboolean

composer.enableSsrPass(enable, radius, position)

镜面反射开关

Kind: instance method of Composer

ParamTypeDescription
enableboolean是否开启镜面反射
radiusnumber反射直径
positionArray反射平面位置

composer.setSsrEnabled(enable)

设置全局镜面反射开关

Kind: instance method of Composer

ParamTypeDescription
enableboolean- 是否开启

composer.setSsrDistance(maxDistance)

镜面反射距离

Kind: instance method of Composer

ParamTypeDescription
maxDistancenumber距离

composer.setSsrThickness(thickness)

镜面反射强度

Kind: instance method of Composer

ParamTypeDescription
thicknessnumber强度

composer.enableUnrealBloomPass(unrealBloomEnabled, bloomRadius, bloomStrength, bloomThreshold)

开启泛光

Kind: instance method of Composer

ParamTypeDescription
unrealBloomEnabledboolean是否开启泛光
bloomRadiusnumber泛光半径
bloomStrengthnumber泛光强度
bloomThresholdnumber泛光线性衰减程度

composer.setBloomPassEnabled(unrealBloomEnabled)

是否开启泛光

Kind: instance method of Composer

ParamTypeDescription
unrealBloomEnabledboolean是否开启

composer.setBloomPassRadius(bloomRadius)

设置泛光半径

Kind: instance method of Composer

ParamTypeDescription
bloomRadiusnumber泛光半径

composer.setBloomPassThreshold(bloomThreshold)

设置泛光线性衰减程度

Kind: instance method of Composer

ParamTypeDescription
bloomThresholdnumber泛光线性衰减程度

composer.setBloomPassStrength(bloomStrength)

设置泛光强度

Kind: instance method of Composer

ParamTypeDescription
bloomStrengthnumber泛光强度

composer.enableSsaoPass(ssaoEnabled, ssaoRadius, ssaoMinDistance, ssaoMaxDistance)

全局投影是否开启

Kind: instance method of Composer

ParamTypeDefaultDescription
ssaoEnabledboolean全局投影开关
ssaoRadiusnumber12.32全局投影半径
ssaoMinDistancenumber0.001全局投影最小距离
ssaoMaxDistancenumber0.3全局投影最大距离

composer.setSSAOEnabled(ssaoEnabled)

设置全局阴影是否开启

Kind: instance method of Composer

ParamTypeDescription
ssaoEnabledboolean全局阴影是否开启

composer.setSSAORadius(ssaoRadius)

设置全局投影半径

Kind: instance method of Composer

ParamTypeDescription
ssaoRadiusnumber全局阴影半径

composer.setSsaoMaxDistance(ssaoMaxDistance)

设置全局投影最大距离

Kind: instance method of Composer

ParamTypeDescription
ssaoMaxDistancenumber全局投影最大距离

composer.setSsaoMinDistance(ssaoMinDistance)

设置全局投影最小距离

Kind: instance method of Composer

ParamTypeDescription
ssaoMinDistancenumber全局投影最小距离

composer.enableDofPass(dofEnabled, dofFocus, dofAperture, dofMaxblur)

是否开启景深模糊

Kind: instance method of Composer

ParamTypeDescription
dofEnabledboolean景深开关
dofFocusnumber景深焦距
dofAperturenumber景深孔径
dofMaxblurnumber景深最大模糊程度

composer.setDofEnabled(dofEnabled)

设置是否开启景深

Kind: instance method of Composer

ParamTypeDescription
dofEnabledboolean景深开关

composer.setDofFocus(dofFocus)

设置景深孔径

Kind: instance method of Composer

ParamTypeDescription
dofFocusnumber景深孔径

composer.setDofAperture(dofAperture)

设置景深焦距

Kind: instance method of Composer

ParamTypeDescription
dofAperturenumber景深焦距

composer.setDofMaxblur(dofMaxblur)

设置景深最大模糊程度

Kind: instance method of Composer

ParamTypeDescription
dofMaxblurnumber景深最大模糊程度

composer.enableSmaaPass(enable)

是否开启 smaa 抗锯齿

Kind: instance method of Composer

ParamType
enableboolean

composer.enableLUTPass(lutEnabled, lutIntensity, lutType, lutUrl)

lut 滤镜

Kind: instance method of Composer

ParamTypeDefaultDescription
lutEnabledboolean是否开启
lutIntensitynumber1lut 强度
lutTypenumberLenox 340lut 滤镜类型
lutUrlstringlut 滤镜素材地址

composer.setlutEnabled(lutEnabled)

是否开启 lut 滤镜

Kind: instance method of Composer

ParamTypeDescription
lutEnabledboolean是否开启

composer.setLutIntensity(lutIntensity)

设置 lut 滤镜

Kind: instance method of Composer

ParamTypeDescription
lutIntensitynumberlut 滤镜强度

composer.setLutType(lutType)

设置 lut 滤镜类型

Kind: instance method of Composer

ParamTypeDescription
lutTypestringlut 滤镜类型

composer.enableDistortPass(enabled, intensity)

设置色差

Kind: instance method of Composer

ParamType
enabledboolean
intensitynumber

composer.setDistortPassEnabled(enabled, lutEnabled)

是否开启色差

Kind: instance method of Composer

ParamTypeDescription
enabled
lutEnabledboolean是否开启

composer.seDistortPassIntensity(intensity, lutIntensity)

设置色差强度

Kind: instance method of Composer

ParamTypeDescription
intensity
lutIntensitynumber强度

composer.enableEdgeBlurPass(enabled, intensity, radius)

是否开启边角模糊

Kind: instance method of Composer

ParamTypeDescription
enabledboolean是否开启
intensitynumber强度
radiusnumber半径

composer.setEdgeBlurEnabled(enabled)

设置边角模糊是否开启

Kind: instance method of Composer

ParamTypeDescription
enabledboolean是否开启

composer.setEdgeBlurRadius(radius)

设置边角模糊半径

Kind: instance method of Composer

ParamTypeDescription
radiusnumber半径

composer.setEdgeBlurIntensity(intensity)

设置边角模糊强度

Kind: instance method of Composer

ParamTypeDescription
intensitynumber强度

composer.enableMsaa(msaaEnabled, samples)

是否开启 msaa 抗锯齿

Kind: instance method of Composer

ParamDefaultDescription
msaaEnabled是否开启
samples4重采样次数

composer.setPostProcessing(opts)

设置后处理参数

Kind: instance method of Composer

ParamTypeDescription
optsobject后处理参数
opts.ssrEnabledboolean是否开启镜面反射
opts.ssrPositionArray镜面坐标数组
opts.ssrRadiusnumber镜面反射范围
opts.ssrDistancenumber镜面反射距离
opts.ssrThicknessnumber镜面反射强度
opts.ssaoEnabledboolean全局阴影
opts.ssaoRadiusnumber全局投影半径
opts.ssaoMinDistancenumber全局投影最小距离
opts.ssaoMaxDistancenumber全局投影最大距离
opts.dofEnabledboolean是否开启景深模糊
opts.dofFocusnumber景深焦距
opts.dofAperturenumber景深孔径
opts.dofMaxblurnumber景深最大模糊程度
opts.unrealBloomEnabledboolean是否开启泛光
opts.bloomRadiusnumber泛光半径
opts.bloomStrengthnumber泛光强度
opts.bloomThresholdnumber泛光线性衰减程度
opts.lutEnabledboolean是否开启
opts.lutIntensitynumberlut 强度
opts.lutTypenumberlut 滤镜类型
opts.lutUrlstringlut 滤镜素材地址
opts.outlineEnabledboolean是否泛光
opts.gammaEnabledboolean是否开启颜色校正
opts.smaaEnabledboolean是否开启 smaa 抗锯齿
opts.distortIntensitynumber色差强度
opts.fxaaEnabledboolean是否开启 fxaa 抗锯齿
opts.msaaEnabledboolean是否开启 msaa 抗锯齿
opts.samplesbooleanmsaa 的重采样次数