---
sidebarDepth: 1
---
# 索引

---

- [渐晕](#渐晕)
- [模糊](#模糊)
- [色彩](#色彩)
- [镜头效果](#镜头效果)

### 渐晕

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CheckVignetteEnabled](渐晕.md#checkvignetteenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 检测是否开启了屏幕渐晕（Vignette）效果。 |
| [SetEnableVignette](渐晕.md#setenablevignette) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启屏幕渐晕（Vignette）效果，开启后玩家屏幕周围将出现渐晕，可通过Vignette其他接口设置效果参数。 |
| [SetVignetteCenter](渐晕.md#setvignettecenter) | <span style="display:inline;color:#7575f9">客户端</span> | 设置渐晕（Vignette）的渐晕中心位置，可改变屏幕渐晕的位置。 |
| [SetVignetteRGB](渐晕.md#setvignettergb) | <span style="display:inline;color:#7575f9">客户端</span> | 设置渐晕（Vignette）的渐晕颜色，可改变屏幕渐晕的颜色。 |
| [SetVignetteRadius](渐晕.md#setvignetteradius) | <span style="display:inline;color:#7575f9">客户端</span> | 设置渐晕（Vignette）的渐晕半径，半径越大，渐晕越小，玩家的视野范围越大。 |
| [SetVignetteSmoothness](渐晕.md#setvignettesmoothness) | <span style="display:inline;color:#7575f9">客户端</span> | 设置渐晕（Vignette）的渐晕模糊系数，模糊系数越大，则渐晕边缘越模糊，模糊的范围也越大 |

### 模糊

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CheckGaussianBlurEnabled](模糊.md#checkgaussianblurenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 检测是否开启了高斯模糊效果。 |
| [SetEnableGaussianBlur](模糊.md#setenablegaussianblur) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启高斯模糊效果，开启后玩家屏幕周围被模糊，可通过高斯模糊其他接口设置效果参数。 |
| [SetGaussianBlurRadius](模糊.md#setgaussianblurradius) | <span style="display:inline;color:#7575f9">客户端</span> | 设置高斯模糊效果的模糊半径，半径越大，模糊程度越大，反之则模糊程度越小。 |

### 色彩

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CheckColorAdjustmentEnabled](色彩.md#checkcoloradjustmentenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 检测是否开启了色彩校正效果。 |
| [SetColorAdjustmentBrightness](色彩.md#setcoloradjustmentbrightness) | <span style="display:inline;color:#7575f9">客户端</span> | 调整屏幕色彩亮度，亮度值越大，屏幕越亮，反之则越暗。 |
| [SetColorAdjustmentContrast](色彩.md#setcoloradjustmentcontrast) | <span style="display:inline;color:#7575f9">客户端</span> | 调整屏幕色彩对比度，屏幕对比度值越大，色彩差异则越明显，反之则色彩差异越小。 |
| [SetColorAdjustmentSaturation](色彩.md#setcoloradjustmentsaturation) | <span style="display:inline;color:#7575f9">客户端</span> | 调整屏幕色彩饱和度，屏幕饱和度值越大，色彩则越明显，反之则越灰暗。 |
| [SetColorAdjustmentTint](色彩.md#setcoloradjustmenttint) | <span style="display:inline;color:#7575f9">客户端</span> | 调整屏幕色彩的色调，根据输入的色调和强度来调整屏幕色彩，当强度越大时，屏幕整体颜色越偏向输入的色调。 |
| [SetEnableColorAdjustment](色彩.md#setenablecoloradjustment) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启色彩校正效果，开启后可进行屏幕色彩调整，可通过色彩校正效果其他接口设置效果参数。 |

### 镜头效果

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CheckDepthOfFieldEnabled](镜头效果.md#checkdepthoffieldenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 检测是否开启了景深效果。 |
| [CheckLensStainEnabled](镜头效果.md#checklensstainenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 检测是否开启了镜头污迹效果。 |
| [ResetLensStainTexture](镜头效果.md#resetlensstaintexture) | <span style="display:inline;color:#7575f9">客户端</span> | 重置污迹效果使用的贴图为系统默认贴图。 |
| [SetDepthOfFieldBlurRadius](镜头效果.md#setdepthoffieldblurradius) | <span style="display:inline;color:#7575f9">客户端</span> | 调整景深效果模糊半径，模糊半径越大，模糊程度越大，反之则越小。 |
| [SetDepthOfFieldFarBlurScale](镜头效果.md#setdepthoffieldfarblurscale) | <span style="display:inline;color:#7575f9">客户端</span> | 调整景深效果远景模糊大小，远景模糊大小越大，远景的模糊程度越大，反之则越小。注意，远景模糊程度的调节依赖于焦点距离，如果焦点处于较近的距离，那么此时远景处于较清晰的状态，模糊程度大小调节不会很明显。 |
| [SetDepthOfFieldFocusDistance](镜头效果.md#setdepthoffieldfocusdistance) | <span style="display:inline;color:#7575f9">客户端</span> | 调整景深效果焦点距离，距离越小，则远处模糊，近处清晰；距离越大，则远处清晰，近处模糊。该距离为实际距离，即以玩家相机为起点的世界坐标距离。 |
| [SetDepthOfFieldNearBlurScale](镜头效果.md#setdepthoffieldnearblurscale) | <span style="display:inline;color:#7575f9">客户端</span> | 调整景深效果近景模糊大小，近景模糊大小越大，近景的模糊程度越大，反之则越小。注意，近景模糊程度的调节依赖于焦点距离，如果焦点处于较近的距离，那么此时近景处于较清晰的状态，模糊程度大小调节不会很明显。 |
| [SetDepthOfFieldUseCenterFocus](镜头效果.md#setdepthoffieldusecenterfocus) | <span style="display:inline;color:#7575f9">客户端</span> | 设置景深效果是否开启屏幕中心聚焦模式，开启后聚焦距离将被自动设置为屏幕中心所对应的物体所在的距离。在第一人称视角下，聚焦距离将被自动设置为屏幕准心所对应的物体与相机的距离，即自动聚焦准心所对应的物体。在第三人称视角下，由于屏幕中心总是对应着玩家，因此聚焦距离将被自动设置为玩家与相机的距离，即自动聚焦在玩家自己。 |
| [SetEnableDepthOfField](镜头效果.md#setenabledepthoffield) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启景深效果，开启后屏幕出现景深效果，根据焦点距离呈现远处模糊近处清晰或者近处模糊远处清晰的效果。 |
| [SetEnableLensStain](镜头效果.md#setenablelensstain) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启镜头污迹效果，开启后镜头出现污迹效果，可改变使用的污迹贴图及污迹颜色。 |
| [SetLensStainColor](镜头效果.md#setlensstaincolor) | <span style="display:inline;color:#7575f9">客户端</span> | 调整镜头污迹颜色，根据输入的颜色和强度来调整污迹色彩，当强度越大时，污迹颜色越偏向输入的颜色。 |
| [SetLensStainIntensity](镜头效果.md#setlensstainintensity) | <span style="display:inline;color:#7575f9">客户端</span> | 调整镜头污迹强度，强度越大，污迹越明显，反之则越透明。 |
| [SetLensStainTexture](镜头效果.md#setlensstaintexture) | <span style="display:inline;color:#7575f9">客户端</span> | 开启镜头污迹效果后，污迹效果使用的为系统默认贴图。该接口可改变镜头污迹所使用的贴图。注意贴图最好使用透明背景，否则屏幕将被贴图覆盖。 |