---
sidebarDepth: 1
---
# 色彩

## CheckColorAdjustmentEnabled

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    检测是否开启了色彩校正效果。

- 参数

    无

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | True为已开启，False为已关闭。 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
comp.CheckColorAdjustmentEnabled()
```



## SetColorAdjustmentBrightness

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    调整屏幕色彩亮度，亮度值越大，屏幕越亮，反之则越暗。

- 参数

    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- | :--- |
    | brightness | float | 亮度值大小，值的范围为[0,5]，小于或大于这个范围的值将被截取为边界值0或5 |

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | 设置是否成功 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整亮度值为3
comp.SetColorAdjustmentBrightness(3)
```



## SetColorAdjustmentContrast

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    调整屏幕色彩对比度，屏幕对比度值越大，色彩差异则越明显，反之则色彩差异越小。

- 参数

    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- | :--- |
    | contrast | float | 对比度值大小，值的范围为[0,5]，小于或大于这个范围的值将被截取为边界值0或5 |

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | 设置是否成功 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整对比度值为3
comp.SetColorAdjustmentContrast(3)
```



## SetColorAdjustmentSaturation

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    调整屏幕色彩饱和度，屏幕饱和度值越大，色彩则越明显，反之则越灰暗。

- 参数

    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- | :--- |
    | saturation | float | 饱和度值大小，值的范围为[0,5]，小于或大于这个范围的值将被截取为边界值0或5 |

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | 设置是否成功 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整饱和度值为3
comp.SetColorAdjustmentSaturation(3)
```



## SetColorAdjustmentTint

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    调整屏幕色彩的色调，根据输入的色调和强度来调整屏幕色彩，当强度越大时，屏幕整体颜色越偏向输入的色调。

- 参数

    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- | :--- |
    | intensity | float | 色调强度，值的范围为[0,1]，小于或大于这个范围的值将被截取为边界值0或1 |
    | color | tuple(float,float,float) | 色调值，按顺序分别为颜色的RGB值，值的范围为[0,255]，小于或大于这个范围的值将被截取为边界值0或255 |

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | 设置是否成功 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整屏幕色调为偏红色，强度为0.3
comp.SetColorAdjustmentTint(0.3, (255,0,0))
```



## SetEnableColorAdjustment

<span style="display:inline;color:#7575f9">客户端</span>

method in mod.client.component.postProcessControlComp.PostProcessComponent

- 描述

    设置是否开启色彩校正效果，开启后可进行屏幕色彩调整，可通过色彩校正效果其他接口设置效果参数。

- 参数

    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- | :--- |
    | enable | bool | 是否开启色彩校正效果，True为开启，False为关闭。 |

- 返回值

    | <div style="width: 4em">数据类型</div> | 说明 |
    | :--- | :--- |
    | bool | 设置是否成功 |

- 示例

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
comp.SetEnableColorAdjustment(True)
```