OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | List of all members
OmegaEngine.Values.ColorCorrection Struct Reference

Color correction values for use in post-processing. More...

Inheritance diagram for OmegaEngine.Values.ColorCorrection:

Public Member Functions

 ColorCorrection (float brightness=1, float contrast=1, float saturation=1, float hue=0)
 Creates a new color correction structure. More...
 
override string ToString ()
 
bool Equals (ColorCorrection other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static ColorCorrection SinusInterpolate (float factor, [NotNull] params ColorCorrection[] values)
 Performs smooth (sinus-based) interpolation between two or more value sets. More...
 
static operator Vector4 (ColorCorrection correction)
 Convert ColorCorrection into Vector4 More...
 
static operator ColorCorrection (Vector4 vector)
 Convert Vector4 into see ColorCorrection More...
 
static bool operator== (ColorCorrection left, ColorCorrection right)
 
static bool operator!= (ColorCorrection left, ColorCorrection right)
 

Static Public Attributes

static readonly ColorCorrection Default = new ColorCorrection(brightness: 1)
 No color change. More...
 

Properties

float Brightness [get, set]
 How bright the picture should be - values between 0 (black) and 5 (5x normal). More...
 
float Contrast [get, set]
 The contrast level of the picture - values between -5 and 5. More...
 
float Saturation [get, set]
 The color saturation level of the picture - values between -5 and 5. More...
 
float Hue [get, set]
 The color hue rotation of the picture - values between 0 and 360. More...
 

Detailed Description

Color correction values for use in post-processing.

Constructor & Destructor Documentation

OmegaEngine.Values.ColorCorrection.ColorCorrection ( float  brightness = 1,
float  contrast = 1,
float  saturation = 1,
float  hue = 0 
)
inline

Creates a new color correction structure.

Parameters
brightnessHow bright the picture should be - values between 0 (black) and 5 (5x normal).
contrastThe contrast level of the picture - values between -5 and 5.
saturationThe color saturation level of the picture - values between -5 and 5.
hueThe color hue rotation of the picture - values between 0 and 360.

Member Function Documentation

static OmegaEngine.Values.ColorCorrection.operator ColorCorrection ( Vector4  vector)
explicitstatic

Convert Vector4 into see ColorCorrection

static OmegaEngine.Values.ColorCorrection.operator Vector4 ( ColorCorrection  correction)
explicitstatic

Convert ColorCorrection into Vector4

static ColorCorrection OmegaEngine.Values.ColorCorrection.SinusInterpolate ( float  factor,
[NotNull] params ColorCorrection[]  values 
)
inlinestatic

Performs smooth (sinus-based) interpolation between two or more value sets.

Parameters
factorA factor between 0 and values .Length.
valuesThe value checkpoints.

Member Data Documentation

readonly ColorCorrection OmegaEngine.Values.ColorCorrection.Default = new ColorCorrection(brightness: 1)
static

No color change.

Property Documentation

float OmegaEngine.Values.ColorCorrection.Brightness
getset

How bright the picture should be - values between 0 (black) and 5 (5x normal).

float OmegaEngine.Values.ColorCorrection.Contrast
getset

The contrast level of the picture - values between -5 and 5.

float OmegaEngine.Values.ColorCorrection.Hue
getset

The color hue rotation of the picture - values between 0 and 360.

float OmegaEngine.Values.ColorCorrection.Saturation
getset

The color saturation level of the picture - values between -5 and 5.


The documentation for this struct was generated from the following file: