Click or drag to resize

ColorUint Structure

Represents a 32-bit color (4 bytes) in the form of RGBA (in byte order: R, G, B, A). Seen as a 32 bit unsigned integer, each color is in the form AARRGGBB - so the most signifcant byte is Alpha and the least significatn byte is the blue channel

Namespace:  Fusee.Base.Common
Assembly:  Fusee.Base.Common (in Fusee.Base.Common.dll) Version: 0.7.0.0 (0.7.0.0)
Syntax
C#
public struct ColorUint : IEquatable<ColorUint>, 
	IFormattable

The ColorUint type exposes the following members.

Constructors
  NameDescription
Public methodColorUint(Byte)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Byte)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Int32)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Single)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Single)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(UInt32)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(float4)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(float3, Single)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Byte, Int32, Boolean)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Byte, Byte, Byte, Byte)
Initializes a new instance of the ColorUint struct.
Public methodColorUint(Single, Single, Single, Single)
Initializes a new instance of the ColorUint struct.
Top
Properties
  NameDescription
Public propertyItem
Gets or sets the component at the specified index.
Top
Methods
  NameDescription
Public methodStatic memberAdd(ColorUint, ColorUint)
Adds two colors.
Public methodStatic memberAdd(ColorUint, ColorUint, ColorUint)
Adds two colors.
Public methodStatic memberAdjustContrast(ColorUint, Single)
Adjusts the contrast of a color.
Public methodStatic memberAdjustContrast(ColorUint, Single, ColorUint)
Adjusts the contrast of a color.
Public methodStatic memberAdjustSaturation(ColorUint, Single)
Adjusts the saturation of a color.
Public methodStatic memberAdjustSaturation(ColorUint, Single, ColorUint)
Adjusts the saturation of a color.
Public methodStatic memberClamp(ColorUint, ColorUint, ColorUint)
Restricts a value to be within a specified range.
Public methodStatic memberClamp(ColorUint, ColorUint, ColorUint, ColorUint)
Restricts a value to be within a specified range.
Public methodEquals(Object)
Determines whether the specified Object is equal to this instance.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(ColorUint)
Determines whether the specified ColorUint is equal to this instance.
Public methodStatic memberFromBgra(Int32)
Converts the color from a packed BGRA integer.
Public methodStatic memberFromBgra(UInt32)
Converts the color from a packed BGRA integer.
Public methodStatic memberFromRgba(Int32)
Converts the color from a packed BGRA integer.
Public methodStatic memberFromRgba(UInt32)
Converts the color from a packed BGRA integer.
Public methodGetBrightness
Gets the brightness.
Public methodGetHashCode
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetHue
Gets the hue.
Public methodGetSaturation
Gets the saturation.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberLerp(ColorUint, ColorUint, Single)
Performs a linear interpolation between two colors.
Public methodStatic memberLerp(ColorUint, ColorUint, Single, ColorUint)
Performs a linear interpolation between two colors.
Public methodStatic memberMax(ColorUint, ColorUint)
Returns a color containing the largest components of the specified colorss.
Public methodStatic memberMax(ColorUint, ColorUint, ColorUint)
Returns a color containing the smallest components of the specified colorss.
Public methodStatic memberMin(ColorUint, ColorUint)
Returns a color containing the smallest components of the specified colors.
Public methodStatic memberMin(ColorUint, ColorUint, ColorUint)
Returns a color containing the smallest components of the specified colors.
Public methodStatic memberModulate(ColorUint, ColorUint)
Modulates two colors.
Public methodStatic memberModulate(ColorUint, ColorUint, ColorUint)
Modulates two colors.
Public methodStatic memberNegate(ColorUint)
Negates a color.
Public methodStatic memberNegate(ColorUint, ColorUint)
Negates a color.
Public methodStatic memberScale(ColorUint, Single)
Scales a color.
Public methodStatic memberScale(ColorUint, Single, ColorUint)
Scales a color.
Public methodStatic memberSmoothStep(ColorUint, ColorUint, Single)
Performs a cubic interpolation between two colors.
Public methodStatic memberSmoothStep(ColorUint, ColorUint, Single, ColorUint)
Performs a cubic interpolation between two colors.
Public methodStatic memberSubtract(ColorUint, ColorUint)
Subtracts two colors.
Public methodStatic memberSubtract(ColorUint, ColorUint, ColorUint)
Subtracts two colors.
Public methodToArray
Creates an array containing the elements of the color.
Public methodToBgra
Converts the color into a packed integer.
Public methodToCss
Converts the color to a string capbable of being used in html/css declarations, like #FF0000 for red or #0000FF for blue.
Public methodTofloat3 Obsolete.
Converts the color into a three component vector.
Public methodStatic memberTofloat3(ColorUint)
Converts the Uint color into a three component vector.
Public methodTofloat4 Obsolete.
Converts the color into a four component vector.
Public methodStatic memberTofloat4(ColorUint)
Converts the Uint color into a four component vector.
Public methodToRgba
Converts the color into a packed integer.
Public methodToString
Returns a String that represents this instance.
(Overrides ValueTypeToString.)
Public methodToString(IFormatProvider)
Returns a String that represents this instance.
Public methodToString(String)
Returns a String that represents this instance.
Public methodToString(String, IFormatProvider)
Returns a String that represents this instance.
Top
Operators
  NameDescription
Public operatorStatic memberAddition
Adds two colors.
Public operatorStatic memberEquality
Tests for equality between two objects.
Public operatorStatic member(Int32 to ColorUint)
Performs an explicit conversion from Int32 to ColorUint.
Public operatorStatic member(UInt32 to ColorUint)
Performs an explicit conversion from Int32 to ColorUint.
Public operatorStatic member(ColorUint to float3)
Performs an explicit conversion from ColorUint to float3.
Public operatorStatic member(ColorUint to float4)
Performs an explicit conversion from ColorUint to float4.
Public operatorStatic member(ColorUint to UInt32)
Performs an explicit conversion from Int32 to ColorUint.
Public operatorStatic member(ColorUint to Int32)
Performs an explicit conversion from Int32 to ColorUint.
Public operatorStatic member(float3 to ColorUint)
Performs an explicit conversion from float3 to ColorUint.
Public operatorStatic member(float4 to ColorUint)
Performs an explicit conversion from float4 to ColorUint.
Public operatorStatic memberInequality
Tests for inequality between two objects.
Public operatorStatic memberMultiply(Single, ColorUint)
Scales a color.
Public operatorStatic memberMultiply(ColorUint, ColorUint)
Modulates two colors.
Public operatorStatic memberMultiply(ColorUint, Single)
Scales a color.
Public operatorStatic memberSubtraction
Subtracts two colors.
Public operatorStatic memberUnaryNegation
Negates a color.
Public operatorStatic memberUnaryPlus
Assert a color (return it unchanged).
Top
Fields
See Also