---
title: "ColourShift"
description: "API documentation for ColourShift"
url: https://developer.disguise.one/python-api/docs/colourshift/
---

# ColourShift

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

## Properties

#### **RGB\_controlled** : _int_

If ‘Separate’, you can control min/max/gamma separately; otherwise, all work together

_Options: {0: ‘Separate’, 1: ‘Together’}  
UserName: RGB controlled_

#### **blue\_gamma** : _float_

Gamma curve setting. Higher numbers produce darker results; 1 means no change

_UserName: Blue gamma_

#### **blue\_max** : _float_

Levels higher than ‘max’ are scaled up to full

_UserName: Blue maximum_

#### **blue\_min** : _float_

Levels lower than ‘min’ are scaled down to black

_UserName: Blue minimum_

#### **brightness\_\_shift\_** : _float_

Adds a constant to RGB; 0 leaves the image unchanged.

_UserName: Brightness (shift)_

#### **contrast\_\_scale\_** : _float_

_UserName: Contrast (scale)_

#### **gain** : _float_

Multiplies RGB by a constant; 1 leaves the image unchanged.

_UserName: Gain_

#### **green\_gamma** : _float_

Gamma curve setting. Higher numbers produce darker results; 1 means no change

_UserName: Green gamma_

#### **green\_max** : _float_

Levels higher than ‘max’ are scaled up to full

_UserName: Green maximum_

#### **green\_min** : _float_

Levels lower than ‘min’ are scaled down to black

_UserName: Green minimum_

#### **hardness** : _float_

Lower numbers produce softer edges between transparent and opaque areas

_Category: Keying  
UserName: Hardness_

#### **hue\_shift** : _float_

Shifts hue; in degrees

_UserName: Hue shift_

#### **key\_colour** : _[Colour](/python-api/docs/colour#colour)_

The key colour becomes transparent

_Category: Keying  
UserName: Key colour_

#### **red\_gamma** : _float_

Gamma curve setting. Higher numbers produce darker results; 1 means no change

_UserName: Red gamma_

#### **red\_max** : _float_

Levels higher than ‘max’ are scaled up to full

_UserName: Red maximum_

#### **red\_min** : _float_

Levels lower than ‘min’ are scaled down to black

_UserName: Red minimum_

#### **saturation\_scale** : _float_

When less than 1, desaturates (0 is b/w); when greater than 1, enhances saturation

_UserName: Saturation scale_

#### **threshold** : _float_

Colours closer than ‘Threshold’ to the key colour become transparent

_Category: Keying  
UserName: Threshold_

## Constructors

#### **\_\_init\_\_**(self)