Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
FreeImageAPI.FITAG Struct Reference

The FITAG structure is a handle to a FreeImage metadata tag. More...

Inheritance diagram for FreeImageAPI.FITAG:
IComparable IComparable< FITAG > IEquatable< FITAG > IComparable IComparable< FITAG > IEquatable< FITAG >

Public Member Functions

void SetNull ()
 Sets the handle to null. More...
 
override string ToString ()
 Converts the numeric value of the FITAG object to its equivalent string representation. More...
 
override int GetHashCode ()
 Returns a hash code for this FITAG structure. More...
 
override bool Equals (object obj)
 Determines whether the specified Object is equal to the current Object. More...
 
bool Equals (FITAG other)
 Indicates whether the current object is equal to another object of the same type. More...
 
int CompareTo (object obj)
 Compares this instance with a specified Object. More...
 
int CompareTo (FITAG other)
 Compares this instance with a specified FITAG object. More...
 
void SetNull ()
 Sets the handle to null. More...
 
override string ToString ()
 Converts the numeric value of the FITAG object to its equivalent string representation. More...
 
override int GetHashCode ()
 Returns a hash code for this FITAG structure. More...
 
override bool Equals (object obj)
 Determines whether the specified Object is equal to the current Object. More...
 
bool Equals (FITAG other)
 Indicates whether the current object is equal to another object of the same type. More...
 
int CompareTo (object obj)
 Compares this instance with a specified Object. More...
 
int CompareTo (FITAG other)
 Compares this instance with a specified FITAG object. More...
 

Static Public Member Functions

static bool operator== (FITAG left, FITAG right)
 Tests whether two specified FITAG structures are equivalent. More...
 
static bool operator!= (FITAG left, FITAG right)
 Tests whether two specified FITAG structures are different. More...
 
static bool operator== (FITAG left, FITAG right)
 Tests whether two specified FITAG structures are equivalent. More...
 
static bool operator!= (FITAG left, FITAG right)
 Tests whether two specified FITAG structures are different. More...
 

Static Public Attributes

static readonly FITAG Zero
 A read-only field that represents a handle that has been initialized to zero. More...
 

Properties

bool IsNull [get]
 Gets whether the pointer is a null pointer or not. More...
 

Detailed Description

The FITAG structure is a handle to a FreeImage metadata tag.

Definition at line 45 of file FITAG.cs.

Member Function Documentation

int FreeImageAPI.FITAG.CompareTo ( object  obj)

Compares this instance with a specified Object.

Parameters
objAn object to compare with this instance.
Returns
A 32-bit signed integer indicating the lexical relationship between the two comparands.
Exceptions
ArgumentExceptionobj is not a FITAG.

Definition at line 146 of file FITAG.cs.

Referenced by FreeImageAPI.FITAG.CompareTo().

int FreeImageAPI.FITAG.CompareTo ( object  obj)

Compares this instance with a specified Object.

Parameters
objAn object to compare with this instance.
Returns
A 32-bit signed integer indicating the lexical relationship between the two comparands.
Exceptions
ArgumentExceptionobj is not a FITAG.

Definition at line 146 of file FITAG.cs.

References FreeImageAPI.FITAG.CompareTo().

int FreeImageAPI.FITAG.CompareTo ( FITAG  other)

Compares this instance with a specified FITAG object.

Parameters
otherA FITAG to compare.
Returns
A signed number indicating the relative values of this instance and other .

Definition at line 165 of file FITAG.cs.

References FreeImageAPI.FITAG.CompareTo().

int FreeImageAPI.FITAG.CompareTo ( FITAG  other)

Compares this instance with a specified FITAG object.

Parameters
otherA FITAG to compare.
Returns
A signed number indicating the relative values of this instance and other .

Definition at line 165 of file FITAG.cs.

References FreeImageAPI.FITAG.CompareTo().

override bool FreeImageAPI.FITAG.Equals ( object  obj)

Determines whether the specified Object is equal to the current Object.

Parameters
objThe Object to compare with the current Object.
Returns
true if the specified Object is equal to the current Object; otherwise, false.

Definition at line 125 of file FITAG.cs.

override bool FreeImageAPI.FITAG.Equals ( object  obj)

Determines whether the specified Object is equal to the current Object.

Parameters
objThe Object to compare with the current Object.
Returns
true if the specified Object is equal to the current Object; otherwise, false.

Definition at line 125 of file FITAG.cs.

bool FreeImageAPI.FITAG.Equals ( FITAG  other)

Indicates whether the current object is equal to another object of the same type.

Parameters
otherAn object to compare with this object.
Returns
true if the current object is equal to the other parameter; otherwise, false.

Definition at line 135 of file FITAG.cs.

bool FreeImageAPI.FITAG.Equals ( FITAG  other)

Indicates whether the current object is equal to another object of the same type.

Parameters
otherAn object to compare with this object.
Returns
true if the current object is equal to the other parameter; otherwise, false.

Definition at line 135 of file FITAG.cs.

override int FreeImageAPI.FITAG.GetHashCode ( )

Returns a hash code for this FITAG structure.

Returns
An integer value that specifies the hash code for this FITAG.

Definition at line 115 of file FITAG.cs.

override int FreeImageAPI.FITAG.GetHashCode ( )

Returns a hash code for this FITAG structure.

Returns
An integer value that specifies the hash code for this FITAG.

Definition at line 115 of file FITAG.cs.

static bool FreeImageAPI.FITAG.operator!= ( FITAG  left,
FITAG  right 
)
static

Tests whether two specified FITAG structures are different.

Parameters
leftThe FITAG that is to the left of the inequality operator.
rightThe FITAG that is to the right of the inequality operator.
Returns
true if the two FITAG structures are different; otherwise, false.

Definition at line 75 of file FITAG.cs.

static bool FreeImageAPI.FITAG.operator!= ( FITAG  left,
FITAG  right 
)
static

Tests whether two specified FITAG structures are different.

Parameters
leftThe FITAG that is to the left of the inequality operator.
rightThe FITAG that is to the right of the inequality operator.
Returns
true if the two FITAG structures are different; otherwise, false.

Definition at line 75 of file FITAG.cs.

static bool FreeImageAPI.FITAG.operator== ( FITAG  left,
FITAG  right 
)
static

Tests whether two specified FITAG structures are equivalent.

Parameters
leftThe FITAG that is to the left of the equality operator.
rightThe FITAG that is to the right of the equality operator.
Returns
true if the two FITAG structures are equal; otherwise, false.

Definition at line 62 of file FITAG.cs.

static bool FreeImageAPI.FITAG.operator== ( FITAG  left,
FITAG  right 
)
static

Tests whether two specified FITAG structures are equivalent.

Parameters
leftThe FITAG that is to the left of the equality operator.
rightThe FITAG that is to the right of the equality operator.
Returns
true if the two FITAG structures are equal; otherwise, false.

Definition at line 62 of file FITAG.cs.

void FreeImageAPI.FITAG.SetNull ( )

Sets the handle to null.

Definition at line 96 of file FITAG.cs.

void FreeImageAPI.FITAG.SetNull ( )

Sets the handle to null.

Definition at line 96 of file FITAG.cs.

override string FreeImageAPI.FITAG.ToString ( )

Converts the numeric value of the FITAG object to its equivalent string representation.

Returns
The string representation of the value of this instance.

Definition at line 106 of file FITAG.cs.

override string FreeImageAPI.FITAG.ToString ( )

Converts the numeric value of the FITAG object to its equivalent string representation.

Returns
The string representation of the value of this instance.

Definition at line 106 of file FITAG.cs.

Member Data Documentation

static readonly FITAG FreeImageAPI.FITAG.Zero
static

A read-only field that represents a handle that has been initialized to zero.

Definition at line 52 of file FITAG.cs.

Referenced by FreeImageAPI.Metadata.MetadataModel.DestoryModel(), FreeImageAPI.Metadata.MetadataTag.Dispose(), and FreeImageAPI.Metadata.MetadataModel.RemoveTag().

Property Documentation

bool FreeImageAPI.FITAG.IsNull
get

Gets whether the pointer is a null pointer or not.

true if this FITAG is a null pointer; otherwise, false.

Definition at line 86 of file FITAG.cs.

Referenced by FreeImageAPI.Metadata.MetadataTag.AddToImage(), and FreeImageAPI.Metadata.MetadataTag.MetadataTag().


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