FIRGBAF Structure

FreeImage.NET

previous page next page
FIRGBAF Structure
The FIRGBAF structure describes a color consisting of relative intensities of red, green, blue and alpha value. Each single color component consumes 32 bits and takes values in the range from 0 to 1.

Namespace: FreeImageAPI
Assembly: FreeImageNET (in FreeImageNET.dll) Version: 3.17.0.4 (3.17.0)
Syntax
C#
Copy
[SerializableAttribute]
public struct FIRGBAF : IComparable, IComparable<FIRGBAF>, 
	IEquatable<FIRGBAF>

The FIRGBAF type exposes the following members.

Constructors
  NameDescription
Public methodFIRGBAF
Initializes a new instance based on the specified Color.
Top
Properties
  NameDescription
Public propertyColor
Gets or sets the Color of the structure.
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares this instance with a specified Object.
Public methodCompareTo(FIRGBAF)
Compares this instance with a specified FIRGBAF object.
Public methodEquals(Object)
Tests whether the specified object is a FIRGBAF structure and is equivalent to this FIRGBAF structure.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(FIRGBAF)
Tests whether the specified FIRGBAF structure is equivalent to this FIRGBAF structure.
Public methodGetHashCode
Returns a hash code for this FIRGBAF structure.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Converts the numeric value of the FIRGBAF object to its equivalent string representation.
(Overrides ValueTypeToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Tests whether two specified FIRGBAF structures are equivalent.
Public operatorStatic member(Color to FIRGBAF)
Converts the value of a Color structure to a FIRGBAF structure.
Public operatorStatic member(FIRGBAF to Color)
Converts the value of a FIRGBAF structure to a Color structure.
Public operatorStatic memberInequality
Tests whether two specified FIRGBAF structures are different.
Top
Fields
  NameDescription
Public fieldalpha
The alpha color component.
Public fieldblue
The blue color component.
Public fieldgreen
The green color component.
Public fieldred
The red color component.
Top
Remarks

The FIRGBAF structure provides access to an underlying FreeImage FIRGBAF structure. To determine the alpha, red, green or blue component of a color, use the alpha, red, green or blue fields, respectively.

For easy integration of the underlying structure into the .NET framework, the FIRGBAF structure implements implicit conversion operators to convert the represented color to and from the Color type. This makes the Color type a real replacement for the FIRGBAF structure and my be used in all situations which require an FIRGBAF type.

Each color component alpha, red, green or blue of FIRGBAF is translated into it's corresponding color component A, R, G or B of Color by linearly mapping the values of one range into the other range and vice versa.

Conversion from System.Drawing.Color to FIRGBAF

FIRGBAF.component = (float)Color.component / 255f

Conversion from FIRGBAF to System.Drawing.Color

Color.component = (int)(FIRGBAF.component * 255f)

The same conversion is also applied when the Color property or the FIRGBAF(Color) constructor is invoked.

Examples
The following code example demonstrates the various conversions between the FIRGBAF structure and the Color structure.
Copy
FIRGBAF firgbaf;
// Initialize the structure using a native .NET Color structure.
firgbaf = new FIRGBAF(Color.Indigo);
// Initialize the structure using the implicit operator.
firgbaf = Color.DarkSeaGreen;
// Convert the FIRGBAF instance into a native .NET Color
// using its implicit operator.
Color color = firgbaf;
// Using the structure's Color property for converting it
// into a native .NET Color.
Color another = firgbaf.Color;
See Also
previous page start next page