API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ColorCurves

The color grading curves provide additional color adjustment that is applied after any color grading transform (3D LUT). They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects. These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image; corresponding to low luminance, medium luminance, and high luminance areas respectively.

Hierarchy

  • ColorCurves

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

globalDensity

  • get globalDensity(): number
  • set globalDensity(value: number): void

  • Gets the global Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Returns number

  • Sets the global Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Parameters

    • value: number

    Returns void

globalExposure

  • get globalExposure(): number
  • set globalExposure(value: number): void

  • Gets the global Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Returns number

  • Sets the global Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Parameters

    • value: number

    Returns void

globalHue

  • get globalHue(): number
  • set globalHue(value: number): void

  • Gets the global Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Returns number

  • Sets the global Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Parameters

    • value: number

    Returns void

globalSaturation

  • get globalSaturation(): number
  • set globalSaturation(value: number): void

  • Gets the global Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Returns number

  • Sets the global Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Parameters

    • value: number

    Returns void

highlightsDensity

  • get highlightsDensity(): number
  • set highlightsDensity(value: number): void

  • Gets the highlights Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Returns number

  • Sets the highlights Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Parameters

    • value: number

    Returns void

highlightsExposure

  • get highlightsExposure(): number
  • set highlightsExposure(value: number): void

  • Gets the highlights Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Returns number

  • Sets the highlights Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Parameters

    • value: number

    Returns void

highlightsHue

  • get highlightsHue(): number
  • set highlightsHue(value: number): void

  • Gets the highlights Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Returns number

  • Sets the highlights Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Parameters

    • value: number

    Returns void

highlightsSaturation

  • get highlightsSaturation(): number
  • set highlightsSaturation(value: number): void

  • Gets the highlights Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Returns number

  • Sets the highlights Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Parameters

    • value: number

    Returns void

midtonesDensity

  • get midtonesDensity(): number
  • set midtonesDensity(value: number): void

  • Gets the midtones Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Returns number

  • Sets the midtones Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Parameters

    • value: number

    Returns void

midtonesExposure

  • get midtonesExposure(): number
  • set midtonesExposure(value: number): void

  • Gets the midtones Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Returns number

  • Sets the midtones Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Parameters

    • value: number

    Returns void

midtonesHue

  • get midtonesHue(): number
  • set midtonesHue(value: number): void

  • Gets the midtones Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Returns number

  • Sets the midtones Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Parameters

    • value: number

    Returns void

midtonesSaturation

  • get midtonesSaturation(): number
  • set midtonesSaturation(value: number): void

  • Gets the midtones Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Returns number

  • Sets the midtones Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Parameters

    • value: number

    Returns void

shadowsDensity

  • get shadowsDensity(): number
  • set shadowsDensity(value: number): void

  • Gets the shadows Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Returns number

  • Sets the shadows Density value. The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect. Values less than zero provide a filter of opposite hue.

    Parameters

    • value: number

    Returns void

shadowsExposure

  • get shadowsExposure(): number
  • set shadowsExposure(value: number): void

  • Gets the shadows Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Returns number

  • Sets the shadows Exposure value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.

    Parameters

    • value: number

    Returns void

shadowsHue

  • get shadowsHue(): number
  • set shadowsHue(value: number): void

  • Gets the shadows Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Returns number

  • Sets the shadows Hue value. The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).

    Parameters

    • value: number

    Returns void

shadowsSaturation

  • get shadowsSaturation(): number
  • set shadowsSaturation(value: number): void

  • Gets the shadows Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Returns number

  • Sets the shadows Saturation value. This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.

    Parameters

    • value: number

    Returns void

Methods

cloneSearch playground for clone

  • Clones the current color curve instance.

    Returns ColorCurves

    The cloned curves

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Returns the class name

    Returns string

    The class name

serializeSearch playground for serialize

  • serialize(): any

  • Serializes the current color curve instance to a json representation.

    Returns any

    a JSON representation

Static BindSearch playground for Bind

  • Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void

  • Binds the color curves to the shader.

    Parameters

    • colorCurves: ColorCurves

      The color curve to bind

    • effect: Effect

      The effect to bind to

    • Optional positiveUniform: string

      The positive uniform shader parameter

    • Optional neutralUniform: string

      The neutral uniform shader parameter

    • Optional negativeUniform: string

      The negative uniform shader parameter

    Returns void

Static ParseSearch playground for Parse

  • Parses the color curve from a json representation.

    Parameters

    • source: any

      the JSON source to parse

    Returns ColorCurves

    The parsed curves

Static PrepareUniformsSearch playground for PrepareUniforms

  • PrepareUniforms(uniformsList: string[]): void

  • Prepare the list of uniforms associated with the ColorCurves effects.

    Parameters

    • uniformsList: string[]

      The list of uniforms used in the effect

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme