Class handling metadata of a FreeImage bitmap. More...

Inheritance diagram for FreeImageAPI.Metadata.ImageMetadata:

Public Member Functions
	ImageMetadata (FIBITMAP dib)
	Initializes a new instance based on the specified FIBITMAP, showing all known models. More...

	ImageMetadata (FIBITMAP dib, bool hideEmptyModels)
	Initializes a new instance based on the specified FIBITMAP, showing or hiding empry models. More...

bool	AddTag (MetadataTag tag)
	Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

IEnumerator	GetEnumerator ()
	Retrieves an object that can iterate through the individual MetadataModels in this ImageMetadata. More...

int	CompareTo (object obj)
	Compares this instance with a specified Object. More...

int	CompareTo (ImageMetadata other)
	Compares this instance with a specified ImageMetadata object. More...

	ImageMetadata (FIBITMAP dib)
	Initializes a new instance based on the specified FIBITMAP, showing all known models. More...

	ImageMetadata (FIBITMAP dib, bool hideEmptyModels)
	Initializes a new instance based on the specified FIBITMAP, showing or hiding empry models. More...

bool	AddTag (MetadataTag tag)
	Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

IEnumerator	GetEnumerator ()
	Retrieves an object that can iterate through the individual MetadataModels in this ImageMetadata. More...

int	CompareTo (object obj)
	Compares this instance with a specified Object. More...

int	CompareTo (ImageMetadata other)
	Compares this instance with a specified ImageMetadata object. More...

Properties
MetadataModel	this[FREE_IMAGE_MDMODEL model] `[get]`
	Gets or sets the MetadataModel of the specified type. More...

MetadataModel	this[int index] `[get]`
	Gets or sets the FreeImageAPI.Metadata.MetadataModel at the specified index. More...

List< MetadataModel >	List `[get]`
	Returns a list of all visible MetadataModels. More...

int	Count `[get]`
	Returns the number of visible MetadataModels. More...

bool	HideEmptyModels `[get, set]`
	Gets or sets whether empty MetadataModels are hidden. More...

Detailed Description

Class handling metadata of a FreeImage bitmap.

Definition at line 47 of file ImageMetadata.cs.

Constructor & Destructor Documentation

FreeImageAPI.Metadata.ImageMetadata.ImageMetadata ( FIBITMAP dib )

Initializes a new instance based on the specified FIBITMAP, showing all known models.

Parameters

dib	Handle to a FreeImage bitmap.

Definition at line 61 of file ImageMetadata.cs.

FreeImageAPI.Metadata.ImageMetadata.ImageMetadata	(	FIBITMAP	dib,
		bool	hideEmptyModels
	)

Initializes a new instance based on the specified FIBITMAP, showing or hiding empry models.

Parameters

dib	Handle to a FreeImage bitmap.
hideEmptyModels	When true, empty metadata models will be hidden until a tag to this model is added.

Definition at line 70 of file ImageMetadata.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.Metadata.ImageMetadata.ImageMetadata ( FIBITMAP dib )

Initializes a new instance based on the specified FIBITMAP, showing all known models.

Parameters

dib	Handle to a FreeImage bitmap.

Definition at line 61 of file ImageMetadata.cs.

FreeImageAPI.Metadata.ImageMetadata.ImageMetadata	(	FIBITMAP	dib,
		bool	hideEmptyModels
	)

Initializes a new instance based on the specified FIBITMAP, showing or hiding empry models.

Parameters

dib	Handle to a FreeImage bitmap.
hideEmptyModels	When true, empty metadata models will be hidden until a tag to this model is added.

Definition at line 70 of file ImageMetadata.cs.

References FreeImageAPI.FIBITMAP.IsNull.

Member Function Documentation

bool FreeImageAPI.Metadata.ImageMetadata.AddTag ( MetadataTag tag )

Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

tag	The tag to add or update.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException tag is null.

Definition at line 175 of file ImageMetadata.cs.

References FreeImageAPI.Metadata.MetadataTag.Model.

bool FreeImageAPI.Metadata.ImageMetadata.AddTag ( MetadataTag tag )

Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

tag	The tag to add or update.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException tag is null.

Definition at line 175 of file ImageMetadata.cs.

References FreeImageAPI.Metadata.MetadataTag.Model.

int FreeImageAPI.Metadata.ImageMetadata.CompareTo ( object obj )

Compares this instance with a specified Object.

Parameters

obj	An object to compare with this instance.

Returns: A 32-bit signed integer indicating the lexical relationship between the two comparands.

Exceptions

ArgumentException obj is not a ImageMetadata.

Definition at line 262 of file ImageMetadata.cs.

int FreeImageAPI.Metadata.ImageMetadata.CompareTo ( object obj )

Compares this instance with a specified Object.

Parameters

obj	An object to compare with this instance.

Returns: A 32-bit signed integer indicating the lexical relationship between the two comparands.

Exceptions

ArgumentException obj is not a ImageMetadata.

Definition at line 262 of file ImageMetadata.cs.

int FreeImageAPI.Metadata.ImageMetadata.CompareTo ( ImageMetadata other )

Compares this instance with a specified ImageMetadata object.

Parameters

other A ImageMetadata to compare.

Returns: A signed number indicating the relative values of this instance and other .

Definition at line 281 of file ImageMetadata.cs.

int FreeImageAPI.Metadata.ImageMetadata.CompareTo ( ImageMetadata other )

Compares this instance with a specified ImageMetadata object.

Parameters

other A ImageMetadata to compare.

Returns: A signed number indicating the relative values of this instance and other .

Definition at line 281 of file ImageMetadata.cs.

IEnumerator FreeImageAPI.Metadata.ImageMetadata.GetEnumerator ( )

Retrieves an object that can iterate through the individual MetadataModels in this ImageMetadata.

Returns: An IEnumerator for this ImageMetadata.

Definition at line 236 of file ImageMetadata.cs.

IEnumerator FreeImageAPI.Metadata.ImageMetadata.GetEnumerator ( )

Retrieves an object that can iterate through the individual MetadataModels in this ImageMetadata.

Returns: An IEnumerator for this ImageMetadata.

Definition at line 236 of file ImageMetadata.cs.

Property Documentation

int FreeImageAPI.Metadata.ImageMetadata.Count

get

Returns the number of visible MetadataModels.

Definition at line 192 of file ImageMetadata.cs.

bool FreeImageAPI.Metadata.ImageMetadata.HideEmptyModels

getset

Gets or sets whether empty MetadataModels are hidden.

Definition at line 219 of file ImageMetadata.cs.

List< MetadataModel > FreeImageAPI.Metadata.ImageMetadata.List

get

Returns a list of all visible MetadataModels.

Definition at line 145 of file ImageMetadata.cs.

MetadataModel FreeImageAPI.Metadata.ImageMetadata.this[FREE_IMAGE_MDMODEL model]

get

Gets or sets the MetadataModel of the specified type.

In case the getter returns null the model is not contained by the list.

null can be used calling the setter to destroy the model.

Parameters

model Type of the model.

Returns: The FreeImageAPI.Metadata.MetadataModel object of the specified type.

Definition at line 100 of file ImageMetadata.cs.

MetadataModel FreeImageAPI.Metadata.ImageMetadata.this[int index]

get

Gets or sets the FreeImageAPI.Metadata.MetadataModel at the specified index.

In case the getter returns null the model is not contained by the list.

null can be used calling the setter to destroy the model.

Parameters

index Index of the FreeImageAPI.Metadata.MetadataModel within this instance.

Returns: The FreeImageAPI.Metadata.MetadataModel object at the specified index.

Definition at line 129 of file ImageMetadata.cs.

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.TextureConverter/Backend/Wrappers/FINetWrapper/Classes/ImageMetadata.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation