Struct GorgonImageCodecDescription

A name and description for an image codec within a GorgonImageCodecPlugIn.

Implements

IEquatable<GorgonImageCodecDescription>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Gorgon.Graphics.Imaging.Codecs

Assembly: Gorgon.Graphics.Imaging.dll

Syntax

public struct GorgonImageCodecDescription : IEquatable<GorgonImageCodecDescription>

Constructors

GorgonImageCodecDescription(Type)

Initializes a new instance of the GorgonImageCodecDescription struct.

Declaration

public GorgonImageCodecDescription(Type type)

Parameters

Type	Name	Description
Type	type	The type of codec object.

Fields

Description

A friendly description used for display.

Declaration

public string Description

Field Value

Type	Description
string

Name

The name of the codec. This will be the same as its fully qualified type name of the codec (e.g. Gorgon.Graphics.Imaging.Codecs.GorgonCodecPng).

Declaration

public readonly string Name

Field Value

Type	Description
string

Methods

Equals(GorgonImageCodecDescription)

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

Declaration

public readonly bool Equals(GorgonImageCodecDescription other)

Parameters

Type	Name	Description
GorgonImageCodecDescription	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Exceptions

Type	Condition
NotImplementedException

Equals(GorgonImageCodecDescription, GorgonImageCodecDescription)

Function to determine if two instances are equal.

Declaration

public static bool Equals(GorgonImageCodecDescription left, GorgonImageCodecDescription right)

Parameters

Type	Name	Description
GorgonImageCodecDescription	left	The left instance to compare.
GorgonImageCodecDescription	right	The right instance to compare.

Returns

Type	Description
bool	true if the two instances are equal, false if not.

Equals(object)

Indicates whether this instance and a specified object are equal.

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	A string containing a fully qualified type name.

Overrides

ValueType.ToString()

Operators

operator ==(GorgonImageCodecDescription, GorgonImageCodecDescription)

Operator to determine if two instances are equal or not.

Declaration

public static bool operator ==(GorgonImageCodecDescription left, GorgonImageCodecDescription right)

Parameters

Type	Name	Description
GorgonImageCodecDescription	left	The left instance to compare.
GorgonImageCodecDescription	right	The right instance to compare.

Returns

Type	Description
bool	true if the two instances are equal, false if not.

operator !=(GorgonImageCodecDescription, GorgonImageCodecDescription)

Operator to determine if two instances are not equal.

Declaration

public static bool operator !=(GorgonImageCodecDescription left, GorgonImageCodecDescription right)

Parameters

Type	Name	Description
GorgonImageCodecDescription	left	The left instance to compare.
GorgonImageCodecDescription	right	The right instance to compare.

Returns

Type	Description
bool	true if the two instances are not equal, false if they are.

Implements

IEquatable<T>

Extension Methods

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)