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.Attenuation Struct Reference

Factors describing the attenuation of light intensity over distance. More...

Inheritance diagram for OmegaEngine.Values.Attenuation:

Public Member Functions

 Attenuation (float constant, float linear, float quadratic)
 Creates a new attenuation structure More...
 
override string ToString ()
 
bool Equals (Attenuation other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static operator Vector4 (Attenuation attenuation)
 Convert Attenuation into Vector4 More...
 
static operator Attenuation (Vector4 vector)
 Convert Vector4 into Attenuation More...
 
static bool operator== (Attenuation left, Attenuation right)
 
static bool operator!= (Attenuation left, Attenuation right)
 

Static Public Attributes

static readonly Attenuation None = new Attenuation(1, 0, 0)
 Value for no attenuation over distance. More...
 

Properties

float Constant [get]
 A constant factor multiplied with the color. More...
 
float Linear [get]
 A constant factor multiplied with the color and the inverse distance. More...
 
float Quadratic [get]
 A constant factor multiplied with the color and the inverse distance squared. More...
 

Detailed Description

Factors describing the attenuation of light intensity over distance.

Constructor & Destructor Documentation

OmegaEngine.Values.Attenuation.Attenuation ( float  constant,
float  linear,
float  quadratic 
)
inline

Creates a new attenuation structure

Parameters
constantA constant factor multiplied with the color.
linearA constant factor multiplied with the color and the inverse distance.
quadraticA constant factor multiplied with the color and the inverse distance squared.

Member Function Documentation

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

Convert Vector4 into Attenuation

static OmegaEngine.Values.Attenuation.operator Vector4 ( Attenuation  attenuation)
explicitstatic

Convert Attenuation into Vector4

Member Data Documentation

readonly Attenuation OmegaEngine.Values.Attenuation.None = new Attenuation(1, 0, 0)
static

Value for no attenuation over distance.

Property Documentation

float OmegaEngine.Values.Attenuation.Constant
get

A constant factor multiplied with the color.

float OmegaEngine.Values.Attenuation.Linear
get

A constant factor multiplied with the color and the inverse distance.

float OmegaEngine.Values.Attenuation.Quadratic
get

A constant factor multiplied with the color and the inverse distance squared.


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