Unigine.ImageConverter Class

ImageConverter Class

Enums

MIPMAPS_MODE#

RESOLUTION_MODE#

COMPRESSION_QUALITY#

RESIZE_FILTER#

RANGE_MODE#

Properties

int Type#

int Format#

ImageConverter.RESOLUTION_MODE ResolutionMode#

ImageConverter.RESIZE_FILTER ResizeFilter#

int Width#

int Height#

int Depth#

Image.FILE_COMPRESSION FileCompression#

ImageConverter.COMPRESSION_QUALITY CompressionQuality#

bool GPUCompression#

ImageConverter.MIPMAPS_MODE MipmapsMode#

float MipmapsGamma#

float GGXMipmapsQuality#

ImageConverter.RANGE_MODE RangeMode#

bool FlipX#

bool FlipY#

int Blur#

int Rotate#

Members

ImageConverter ( ) #

ImageConverter ( ImageConverter imageconverter ) #

Arguments

• ImageConverter imageconverter - Source image converter.

void SetRange ( int channel, dvec4 value ) #

Arguments

• int channel - Number of the channel to be inverted, in the range from 0 to the total number of channels.
• dvec4 value - Range values: x and y coordinates of the value specify the original range, z and w specify the range to which the image will be converted.

dvec4 GetRange ( int channel ) #

Arguments

• int channel - Number of the channel to be inverted, in the range from 0 to the total number of channels.

Return value

bool GetInvertChannel ( int channel ) #

Arguments

• int channel - Number of the channel to be inverted, in the range from 0 to the total number of channels.

Return value

void SetInvertChannel ( int channel, bool value ) #

Arguments

• int channel - Number of the channel to be inverted, in the range from 0 to the total number of channels.
• bool value - true if the channel needs to be inverted; otherwise, false.

void Reset ( ) #

void Copy ( ImageConverter converter ) #

Arguments

• ImageConverter converter - Source converter.

ImageConverter Clone ( ) #

Return value

bool Load ( string path ) #

Arguments

• string path - Path to the file with the image converter settings.

Return value

void Load ( Json json ) #

Arguments

• Json json - Object with the image converter settings.

bool Save ( string path ) #

Arguments

• string path - Path to the file to store the image converter settings.

Return value

void Save ( Json json ) #

Arguments

• Json json - Object with the image converter settings.

void UpdateParameters ( Image image ) #

Arguments

• Image image - Image to be converted.

bool Run ( Image image ) #

Arguments

• Image image - Image to be converted.

Return value

IntPtr AddBeginCallback ( BeginDelegate func ) #

void begin_callback(ImageConverter converter, Image img);

You can set a callback function as follows:

AddBeginCallback((converter, img) 
						=> begin_callback(converter, img));

Example: Setting a begin image conversion callback function:

class AppWorldLogic : WorldLogic
{

	/*...*/

	// callback function implementing certain actions to be performed on beginning image conversion
	private void ConversionBegin(ImageConverter converter, Image img)
	{
		// insert your specific handling code here
	}

	/*...*/

	public override bool Init()
	{
		// setting the ConversionBegin() function to handle beginning of the image conversion
		MyImageConverter.AddBeginCallback((converter, img) 
						=> ConversionBegin(converter, img));

		return true;
		}
	/*...*/
}

Arguments

• BeginDelegate func - Callback function with the following signature:
  void BeginDelegate(ImageConverter converter, Image img)

Return value

bool RemoveBeginCallback ( IntPtr id ) #

Arguments

• IntPtr id - Begin callback ID obtained when adding it.

Return value

void ClearBeginCallback ( ) #

IntPtr AddEndCallback ( EndDelegate func ) #

void end_callback(ImageConverter converter, Image img);

You can set a callback function as follows:

AddEndCallback((converter, img) 
						=> end_callback(converter, img));

Example: Setting an image conversion completion callback function:

class AppWorldLogic : WorldLogic
{

	/*...*/

	// callback function implementing certain actions to be performed on completion of image conversion
	private void ConversionEnd(ImageConverter converter, Image img)
	{
		// insert your specific handling code here
	}

	/*...*/

	public override bool Init()
	{
		// setting the ConversionEnd() function to handle completion of image conversion
		MyImageConverter.AddEndCallback((converter, img) 
						=> ConversionEnd(converter, img));

		return true;
		}
	/*...*/
}

Arguments

• EndDelegate func - Callback function with the following signature:
  void EndDelegate(ImageConverter converter, Image img)

Return value

bool RemoveEndCallback ( IntPtr id ) #

Arguments

• IntPtr id - End callback ID obtained when adding it.

Return value

void ClearEndCallback ( ) #