Unigine.Image Class

Interface for handling textures and other images.

This class supports the following formats:

*.texture — the engine's native format
*.tga
*.png
*.dds
*.psd
*.ppm
*.pgm
*.hdr
*.sgi
*.ies
*.exr (except for those using lossy compression types B44, B44A, PIX24)
tif
- *.tif
- *.tiff
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi
sgi
- *.bw
- *.la
- *.int
- *.inta
- *.rgb
- *.rgba

Textures are stored on CPU.

Properties:

Name	Description
int NumChannels	The number of image channels.
int Type	A numerical code of the image type.
string TypeName	An image type name.
int NumMipmaps	The number of mipmaps stored with the image.
int NumLayers	The number of layers in the image.
int NumFaces	The number of faces in the image.
bool IsLoaded	A value indicating whether the image is loaded.
int BlockSize	The compressed image block size.
int PixelSize	The uncompressed image pixel size.
bool IsCubeType	A value indicating if the image is cube image.
bool IsArrayType	A value indicating if the image is of an array type (see *_ARRAY variables).
bool Is3DType	A value indicating if the image is a 3d image.
bool Is2DType	A value indicating if the image is a 2d image.
int Format	A numerical code of the image format.
string FormatName	An image format name.
int Depth	The image depth, in pixels.
int Height	The image height, in pixels.
int Width	The image width, in pixels.
uint PixelsSize	The size of all pixels of the image.
uint NumPixels	Returns the number of Pixels in the image.
Image.FILE_COMPRESSION FileCompression	Returns the image file compression type.

Methods:

Name	Description View: Sort by:
Image	Default constructor.
AllocData	Allocates memory for the image data.
ClearData	Clears all image data.
Set	Sets a value for a given image channel.
get	Returns a value for a given image channel.
Get8F	Returns a set of 8-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.
Get16F	Returns a set of 16-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.
Get32F	Returns a set of 32-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.
Set2D	Sets a color for a given pixel of a 2D image.
Get2D	Returns a color of a given pixel of a 2D image.
Set2DArray	Sets a color of a given pixel.
Get2DArray	Returns a color of a given pixel.
Set3D	Sets a color of a given pixel of a 3D image.
Get3D	Returns a color of a given pixel of a 3D image.
Get3DSmooth	Returns a color of a given pixel obtained using linear interpolation.
IsCombinedFormat	Returns a value indicating if the image is stored in a combined format (RGB565, RGBA4, RGB5A1 or RGB10A2).
IsCompressedFormat	Returns a value indicating if the image is stored in a compressed format (DXT1, DXT3, DXT5, ATI1, ATI2).
SetCube	Sets a color of a given pixel.
GetCube	Returns a color of a given pixel.
SetCubeArray	Sets a color of a given pixel.
GetCubeArray	Returns the color of a given pixel of the cube array image.
GetDepth	Returns the image depth on a given mipmap level.
IsFloatFormat	Returns a value indicating if the image is stored in a float format (R32F, RG32F, RGB32F or RGBA32F).
GetFormat	Returns a numerical code of the image format for the specified format and number of channels.
GetFormatName	Returns the name of the image format by the given format ID.
IsHalfFormat	Returns a value indicating if the image is stored in a half-float format (R16F, RG16F, RGB16F or RGBA16F).
GetHeight	Returns image height on a given mipmap level.
SetChannelInt	Sets an integer value for a given image channel.
SetChannelFloat	Sets a float value for a given image channel.
SwapChannels	Swaps values of two channels with the specified numbers.
GetOffset	Returns the image offset on a given mipmap level.
GetNumPixels	Returns the number of Pixels in the image.
SetPixels	Sets image pixels to be taken from the specified source array.
GetPixels	Returns the pointer to the array of pixels.
GetPixels2D	Returns the pointer to the array of pixels with the given mipmap level for the 2D image.
GetPixels2DArray	Returns the pointer to the array of pixels with the given mipmap level and image layer for the 2D Array image.
GetPixels3D	Returns the pointer to the array of pixels with the given mipmap level for the 3D image.
GetPixelsCube	Returns the pointer to the array of pixels with the given mipmap level for the cube image.
GetPixelsCubeArray	Returns the pointer to the array of pixels with the given mipmap level and image layer for the Cube Array image.
GetPixelsSize	Returns the size of all pixels for the image of the specified format and size.
IsRawFormat	Returns a value indicating if the image is uncompressed (stored in R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F, RGB565, RGBA4, RGB5A1 or RGB10A2 format).
GetSize	Returns the current image size.
GetStride	Returns the image stride on a given mipmap level.
GetDepthStride	Returns the image depth stride on a given mipmap level.
GetTypeName	Returns the name of the image type by its identifier.
IsUCharFormat	Returns a value indicating if the image is stored in an unsigned char format (R8, RG8, RGB8, RGBA8, DXT1, DXT3, DXT5, ATI1 or ATI2).
IsUShortFormat	Returns a value indicating if the image is stored in an unsigned short format (R16, RG16, RGB16 or RGBA16).
GetWidth	Returns the image width on a given mipmap level.
Blend	Blends the specified image with the current one.
Blur	Filters the image using two-pass Gaussian blur.
Clear	Clears all data associated with the image and resets its type, format, size to default.
Combine	Converts the image to a combined format.
CombineMipmaps	Combines the loaded 2D image with the mipmap image.
Compare	Compares a region of a specified image with a specified region of the current image.
Compress	Converts the image to a compressed format.
ConvertToFormat	Converts the image to a specified format.
ConvertToType	Converts the image to a specified type.
AssignFrom	Copies the data from the specified source image.
ResizeFrom	Copies the data from the specified source image, resizing the source.
Copy	Copies data from the specified source image according to the specified layer parameter.
CopyFast	Copies a data fragment with specified width, height, and coordinates from the source image.
Create2D	Creates an empty 2D image filled with black color.
Create2DArray	Creates an empty 2D texture array filled with black color.
Create3D	Creates an empty 3D image filled with black color.
Create3DTurbulence	Creates a 3D turbulence image (RGBA8).
CreateCube	Creates the empty cube image filled with black color.
CreateCubeArray	Creates the empty cube array image filled with black color.
CreateMipmaps	Generates mipmaps for the image.
RemoveMipmaps	Removes mipmaps generated for the image.
Decombine	Automatically converts the image from the combined format to a correct one.
DecombineMipmaps	Decombines the loaded 2D-image and the mipmap images.
Decompress	Decompresses the image from the compressed format to a correct one.
Extrude	Extrudes contour of the image in the alpha=0 region on the given number of pixels.
FlipX	Flips the 2D image horizontally.
FlipY	Flips the 2D image vertically.
HasMipmaps	Returns a value indicating if the source image has mipmaps.
Info	Returns information about the given image.
Invert	Inverts values of all the image channels.
Load	Loads an image from a specified file.
Normalize	Creates a three-component normal map out of the image.
Resize	Resizes the image.
Rotate	Rotates the image by a given angle (with the step of 90 degrees).
Save	Saves the image to a file with the specified name.
Sign	Converts the image from unsigned type to signed char.
Swap	Swaps the data of the current image with the source image.
ToPixel	Converts a vec4 color vector (R, G, B, A) to Pixel color.
ToVec4	Converts Pixel color to a vec4 color vector (R, G, B, A).
GetNumChannels	Returns the number of channels for the specified image format.
GetPixelSize	Returns the pixel size for the specified image format.
GetBlockSize	Returns the block size for the specified image format.
InvertChannel	Inverts the values stored in the specified channel.
SaveDDS	Saves the DDS image to a specified stream.
LoadDDS	Loads a DDS image from a specified stream.
GetRawFormat	Returns the closest RAW format of the uncompressed image.
SetFileCompression	File compression type to be used for the image.
GetFileCompression	Returns the image file compression type.
CalcRange	Calculates the image range for all available channels in total.
ChangeRange	Changes the image range.
NormalizeRange	Normalizes the image range either per channel or for all channels altogether.
FlipCubemapX	Flips the cubemap image along the X axis.
FlipCubemapY	Flips the cubemap image along the Y axis.
FlipCubemapZ	Flips the cubemap image along the Z axis.

Variables:

Name	Description
AUTO_FORMAT = -1	Format is set automatically.
FORMAT_R8 = 0	Non-compressed unsigned format. Stores data in one 8-bit channel (red).
FORMAT_RG8 = 1	Non-compressed unsigned format. Stores data in two 8-bit channels (red, green).
FORMAT_RGB8 = 2	Non-compressed unsigned format. Stores data in three 8-bit channels (red, green, blue).
FORMAT_RGBA8 = 3	Non-compressed unsigned format. Stores data in four 8-bit channels (red, green, blue, alpha).
FORMAT_R16 = 4	Non-compressed unsigned format. Stores data in one 16-bit channel (red).
FORMAT_RG16 = 5	Non-compressed unsigned format. Stores data in two 16-bit channels (red, green).
FORMAT_RGB16 = 6	Non-compressed unsigned format. Stores data in three 16-bit channels (red, green, blue).
FORMAT_RGBA16 = 7	Non-compressed unsigned format. Stores data in four 16-bit channels (red, green, blue, alpha).
FORMAT_R16F = 8	Non-compressed float format. Stores data in one 16-bit channel (red).
FORMAT_RG16F = 9	Non-compressed float format. Stores data in two 16-bit channels (red, green).
FORMAT_RGB16F = 10	Non-compressed float format. Stores data in three 16-bit channels (red, green, blue).
FORMAT_RGBA16F = 11	Non-compressed float format. Stores data in four 16-bit channels (red, green, blue, alpha).
FORMAT_R32F = 12	Non-compressed float format. Stores data in one 32-bit channel (red).
FORMAT_RG32F = 13	Non-compressed float format. Stores data in two 32-bit channels (red, green).
FORMAT_RGB32F = 14	Non-compressed float format. Stores data in three 32-bit channels (red, green, blue).
FORMAT_RGBA32F = 15	Non-compressed float format. Stores data in four 32-bit channels (red, green, blue, alpha).
FORMAT_RGB565 = 16	Combined unsigned format. Stores 16 bit color values without alpha.
FORMAT_RGBA4 = 17	Combined unsigned format. Stores data in four 4-bit channels (red, green, blue, alpha).
FORMAT_RGB5A1 = 18	Combined unsigned format. Stores data in three 5-bit channels (red, green, blue) and one 1-bit channel (alpha).
FORMAT_RGB10A2 = 19	Combined unsigned format. Stores data in three 10-bit channels (red, green, blue) and one 2-bit channel (alpha).
FORMAT_RG11B10F = 20	Combined unsigned float format. Stores data in two 11-bit channels (red, green) and one 10-bit channel (blue).
FORMAT_DXT1 = 21	A DXT1 compressed image file format. Compresses RGB images by a factor of 6:1 compared to RGB8. Uses 4×4 blocks for color interpolation and stores color values in 16 bits per pixel (R5:G6:B5). Can also store 1-bit alpha data; in this case, compresses images by a factor of 8:1 compared to RGBA8. This format is not recommended for storing normal maps.
FORMAT_DXT3 = 22	A DXT3 compressed image file format. Compresses RGBA images by a factor of 4:1 compared to RGBA8. Stores RGB color values as the DXT1 format and uses four more bits for alpha data. Color values are interpreted as not having been pre-multiplied by alpha. Alpha values are not interpolated. Recommended for images with sharp alpha transitions.
FORMAT_DXT5 = 23	A DXT5 compressed image file format. Compresses RGBA images by a factor of 4:1 compared to RGBA8. Stores RGB color values as the DXT1 format and uses four more bits for alpha data. Color values are interpreted as not having been pre-multiplied by alpha. Alpha values are interpolated. Recommended for images with smooth alpha transitions.
FORMAT_ATI1 = 24	An ATI1 compressed image file format. Compresses single-channel images by a factor of 2:1 compared to R8. Compression is the same as the one used for alpha data in the DXT5 format. Supported by all graphics cards compatible with DirectX 10; additionally, all ATI graphics cards since X800.
FORMAT_ATI2 = 25	An ATI2 compressed image file format. Compresses two-channel images by a factor of 2:1 compared to RG8. Compression for each channel is the same as the one used for alpha data in the DXT5 format. Supported by all graphics cards compatible with DirectX 10; additionally, all ATI graphics cards since X800.
AUTO_IMAGE_TYPE = -1	Image type is set automatically.
IMAGE_2D = 0	A 2D texture.
IMAGE_3D = 1	A 3D texture.
IMAGE_CUBE = 2	A cube texture.
IMAGE_2D_ARRAY = 3	A 2D texture array. Each texture of the array has its own mipmap levels, which is the difference between it and a 3D image.
IMAGE_CUBE_ARRAY = 4	A cube texture array.

The color of each pixel of an image is represented by the Pixel structure. Pixel format is determined by the image file format (see the table below).

Image type	Pixel format
8-bit unsigned formats: R8, RG8, RGB8, RGBA8	Pixel color components are in range from 0 to 255. E.g. Pixel(10, 10, 255, 255) for RGBA8 Color components are accessed via *Pixel.i*
16-bit unsigned formats: R16, RG16, RGB16, RGBA16	Pixel color components are in range from 0 to 65535. Color components are accessed via *Pixel.i*
16-bit float formats: R16F, RG16F, RGB16F, RGBA16F	Pixel color components are in range from 0.0f to 1.0f. Color components are accessed via *Pixel.i*
32-bit float formats: R32F, RG32F, RGB32F, RGBA32F	Pixel color components are in range from 0.0f to 1.0f. Color components are accessed via *Pixel.f*

Usage example#

Source code (C#)

// AppWorldLogic.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
		/* .. */

		public override bool Init()
		{
            // image size parameters
            const int ASPECT_RATIO = 1;
            const int width = 256;
            const int height = width / ASPECT_RATIO;
	        Image image = new Image();

	        // creating an image of the specified size
	        image.create2D(width, height, Image.FORMAT_RGBA8);

	        // declaring a pixel to store color information
	        Image.Pixel pixel = new Image.Pixel();

	        for (int x = 0; x < width; x++)
		        for (int y = 0; y < height; y++)
		        {
			        // setting pixel components
			        pixel.i.r = x;
			        pixel.i.g = 0;
			        pixel.i.b = 0;
			        pixel.i.a = 195;
			
			        // setting the color of the image pixel at (x,y)
			        image.set2D(x, y, pixel);
		        }

	        // setting our image as an albedo texture of the ground_grid material		
	        Material material = Materials.findMaterial("ground_grid");
	        material.setTextureImage(material.findTexture("albedo"), image);

	        // saving our image to a *.DDS file
	        image.save("myimage.dds");

	        // printing current image format to the console
	        Log.Message("\nImage format: {0}", image.getFormatName());

	        // converting our image to the 32-bit float format
	        image.convertToFormat(Image.FORMAT_RGBA32F);

	        // printing image format after conversion to the console
	        Log.Message("\nImage format after conversion: {0}", image.getFormatName());

	        // getting the first pixel for each row of the image and printing its color value to the console
	        for (int x = 0; x < width; x++)
	        {
		        pixel = image.get2D(x, 0);
		        Log.Message("\nPixel ({0}, 0) color = ({1}, {2}, {3}, {4})", x, pixel.f.r, pixel.f.g, pixel.f.b, pixel.f.a);
	        }

	        // clearing the image
	        image.clear();

			return 1;
		}
		
		/* .. */
	}
}

Image Class

Enums

FILE_COMPRESSION#

Name	Description
DISABLE = 0	Image data is uncompressed.
ZLC_LOW = 1	Fast compression used for images stored in the system memory (based on zlib library).
ZLC_HIGH = 2	Compression used for images stored in the system memory (based on zlib library). It is used when a smaller file size is required, compared to ZLC LOW (compression is slower).
LZ4_LOW = 3	LZ4 lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes (greater file size, faster comression).
LZ4_HIGH = 4	LZ4 lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes (smaller file size, slower comression).

FILTER#

Name	Description
POINT = 0	A point mipmap filter.
LINEAR = 1	A linear mipmap filter.
MIN = 2	A minimum mipmap filter.

Properties

int NumChannels#

The number of image channels.

int Type#

A numerical code of the image type.

string TypeName#

An image type name.

int NumMipmaps#

The number of mipmaps stored with the image.

int NumLayers#

The number of layers in the image.

int NumFaces#

The number of faces in the image.

bool IsLoaded#

A value indicating whether the image is loaded.

int BlockSize#

The compressed image block size.

int PixelSize#

The uncompressed image pixel size.

bool IsCubeType#

A value indicating if the image is cube image.

bool IsArrayType#

A value indicating if the image is of an array type (see *_ARRAY variables).

bool Is3DType#

A value indicating if the image is a 3d image.

bool Is2DType#

A value indicating if the image is a 2d image.

int Format#

A numerical code of the image format.

string FormatName#

An image format name.

int Depth#

The image depth, in pixels.

int Height#

The image height, in pixels.

int Width#

The image width, in pixels.

uint PixelsSize#

The size of all pixels of the image.

uint NumPixels#

Returns the number of Pixels in the image.

Image.FILE_COMPRESSION FileCompression#

Returns the image file compression type. Compression is applied only when saving the image into the *.texture format.

set

File compression type to be used for the image. Compression is applied only when saving the image into the *.texture format.

set value - File compression type to be used for the image. One of the FILE_COMPRESSION_* values.

Members

Image ( ) #

Default constructor. An empty instance with default parameters is created.

Image ( string name ) #

Constructor. Creates an image loading data from the specified file.

Arguments

string name - Image file name.

Image ( Image image ) #

Constructor. Creates an image by copying a given source image.

Arguments

Image image - Source image.

bool AllocData ( bool clear = true ) #

Allocates memory for the image data.

Arguments

bool clear - Clear flag: set true to fill allocated memory with zero-values; otherwise, set false.

Return value

true if memory for the image data is allocated successfully; otherwise, false.

void ClearData ( ) #

Clears all image data.

void Set ( int id, dvec4 value ) #

Sets a value for a given image channel. Compressed and combined image formats are not supported.

Arguments

int id
dvec4 value

void get ( int id, out dvec4 value ) #

Returns a value for a given image channel.

Arguments

int id
out dvec4 value

vec4 get ( ivec2 coord, int offset ) #

Returns image data for the specified pixel coordinates and mipmap offset as a four-component vector.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in range [0; width], Y in range [0; height].
int offset - Mipmap offset value.

Return value

A vec4 vector (R, G, B, A) containing image data for the specified pixel coordinates, with components normalized in the [0.0f; 1.0f] range.

void get ( ivec2 coord, int offset, out vec4 p00, out vec4 p01, out vec4 p10, out vec4 p11 ) #

Returns image data for the specified pixel coordinates and mipmap offset (along with neighboring pixels) as a set of four-component vectors.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in range [0; width], Y in range [0; height].
int offset - Mipmap offset value.
out vec4 p00 - A vec4 vector (R, G, B, A) containing image data for the specified pixel coordinates (X, Y), with components normalized in the [0.0f; 1.0f] range.
out vec4 p01 - A vec4 vector (R, G, B, A) containing image data for the neighboring pixel coordinates (X, Y+1), with components normalized in the [0.0f; 1.0f] range.
out vec4 p10 - A vec4 vector (R, G, B, A) containing image data for the neighboring pixel coordinates (X+1, Y), with components normalized in the [0.0f; 1.0f] range.
out vec4 p11 - A vec4 vector (R, G, B, A) containing image data for the neighboring pixel coordinates (X+1, Y+1), with components normalized in the [0.0f; 1.0f] range.

void Get8F ( ivec2 coord, out vec4 p ) #

Returns a set of 8-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
out vec4 p - Output vec4 vector (P00, P01, P10, P11) to receive 8-bit float values stored in the specified image pixel and neighboring ones:
- P00 - (X, Y)
- P01 - (X, Y+1)
- P10 - (X+1, Y)
- P11 - (X+1, Y+1)
Notice
Values are normalized in the [0.0f; 1.0f] range.

float Get8F ( ivec2 coord ) #

Returns an 8-bit float value stored in the specified pixel of the image.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.

Return value

An 8-bit float value stored in the specified pixel of the image normalized in the [0.0f; 1.0f] range.

void Get16F ( ivec2 coord, out vec4 p ) #

Returns a set of 16-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
out vec4 p - Output vec4 vector (P00, P01, P10, P11) to receive 16-bit float values stored in the specified image pixel and neighboring ones:
- P00 - (X, Y)
- P01 - (X, Y+1)
- P10 - (X+1, Y)
- P11 - (X+1, Y+1)
Notice
Values are normalized in the [0.0f; 1.0f] range.

float Get16F ( ivec2 coord ) #

Returns a 16-bit float value stored in the specified pixel of the image.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.

Return value

A 16-bit float value stored in the specified pixel of the image normalized in the [0.0f; 1.0f] range.

void Get32F ( ivec2 coord, out vec4 p ) #

Returns a set of 32-bit float values stored in the specified image pixel and neighboring ones and puts them to the output vector.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
out vec4 p - Output vec4 vector (P00, P01, P10, P11) to receive 32-bit float values stored in the specified image pixel and neighboring ones:
- P00 - (X, Y)
- P01 - (X, Y+1)
- P10 - (X+1, Y)
- P11 - (X+1, Y+1)
Notice
Values are normalized in the [0.0f; 1.0f] range.

float Get32F ( ivec2 coord ) #

Returns a 32-bit float value stored in the specified pixel of the image.

Arguments

ivec2 coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.

Return value

A 32-bit float value stored in the specified pixel of the image normalized in the [0.0f; 1.0f] range.

void Set2D ( int x, int y, Pixel p ) #

Sets a color for a given pixel of a 2D image. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
Pixel p

void Set2D ( ivec2 coord, Pixel p ) #

Sets a color for a given pixel of a 2D image. Compressed formats are not supported.

Arguments

ivec2 coord - Integer coordinates of a pixel in the following ranges: X - [0; width], Y - [0; height].
Pixel p - Pixel color represented by a Pixel structure.

Pixel Get2D ( int x, int y ) #

Returns a color of a given pixel of a 2D image. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].

Return value

Pixel color represented by a Pixel structure.

Pixel Get2D ( float x, float y ) #

Returns a color of a given pixel of a 2D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure.

Pixel Get2D ( float x, float y, Pixel skip_pixel ) #

Returns a color of a given pixel of a 2D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

NoticeIf at least one of four interpolated pixels is equal to skip_pixel, the method will return skip_pixel.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].
Pixel skip_pixel - Skip pixel color represented by a Pixel structure.

Return value

Pixel color represented by a Pixel structure.

Pixel Get2D ( ivec2 coord ) #

Returns a color of a given pixel of a 2D image. Compressed formats are not supported.

Arguments

ivec2 coord - Integer coordinates of a pixel in the following ranges: X - [0; width], Y - [0; height].

Return value

Pixel color represented by a Pixel structure.

Pixel Get2D ( vec2 uv ) #

Returns a color of a given pixel of a 2D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

Arguments

vec2 uv - Float coordinates of a pixel in range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure.

Pixel Get2D ( vec2 uv, Pixel skip_pixel ) #

Returns a color of a given pixel of a 2D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

NoticeIf at least one of four interpolated pixels is equal to skip_pixel, the method will return skip_pixel.

Arguments

vec2 uv - Float coordinates of a pixel in range [0.0f; 1.0f].
Pixel skip_pixel - Skip pixel color represented by a Pixel structure.

Return value

Pixel color represented by a Pixel structure.

void Set2DArray ( int x, int y, int layer, Pixel p ) #

Sets a color of a given pixel. The image must be a 2D image array. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int layer - Image layer number.
Pixel p - Pixel color represented by a Pixel structure.

void Set2DArray ( ivec2 coord, int layer, Pixel p ) #

Sets a color of a given pixel. The image must be a 2D texture array. Compressed formats are not supported.

Arguments

ivec2 coord - Coordinates of a pixel.
int layer - Image layer number.
Pixel p - Pixel color represented by a Pixel structure.

Pixel Get2DArray ( int x, int y, int layer ) #

Returns a color of a given pixel. The image must be a 2D texture array. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel Get2DArray ( float x, float y, int layer ) #

Returns a color of a given pixel. The image must be a 2D image array. Compressed formats are not supported. Linear interpolation is used to get a color sample.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel Get2DArray ( ivec2 coord, int layer ) #

Returns a color of a given pixel. The image must be a 2D texture array. Compressed formats are not supported.

Arguments

ivec2 coord - Coordinates of a pixel.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel Get2DArray ( vec2 uv, int layer ) #

Returns a color of a given pixel. The image must be a 2D texture array. Compressed formats are not supported.

Arguments

vec2 uv - UV coordinates of a pixel.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

void Set3D ( int x, int y, int z, Pixel p ) #

Sets a color of a given pixel of a 3D image. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int z - Z integer coordinate of a pixel in range [0; depth].
Pixel p - Pixel color represented by a Pixel structure.

void Set3D ( ivec3 coord, Pixel p ) #

Sets a color of a given pixel of a 3D image. Compressed formats are not supported.

Arguments

ivec3 coord - Integer coordinates of a pixel in the following ranges: X - [0; width], Y - [0; height], Z - [0; depth].
Pixel p - Pixel color represented by a Pixel structure.

Pixel Get3D ( float x, float y, float z ) #

Returns a color of a given pixel of a 3D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].
float z - Z float coordinate of a pixel in range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure.

Pixel Get3D ( int x, int y, int z ) #

Returns a color of a given pixel of a 3D image. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int z - Z integer coordinate of a pixel in range [0; depth].

Return value

Pixel color represented by a Pixel structure.

Pixel Get3D ( ivec3 coord ) #

Returns a color of a given pixel of a 3D image. Compressed formats are not supported.

Arguments

ivec3 coord - Integer coordinates of a pixel in the following ranges: X - [0; width], Y - [0; height], Z - [0; depth].

Return value

Pixel color represented by a Pixel structure.

Pixel Get3D ( vec3 uvw ) #

Returns a color of a given pixel of a 3D image. Linear interpolation is used to get a color sample. Compressed formats are not supported.

Arguments

vec3 uvw - Float coordinates of a pixel in range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure.

Pixel Get3DSmooth ( float x, float y, float z ) #

Returns a color of a given pixel obtained using linear interpolation. Compressed formats are not supported.

NoticeThis method returns pixel color with float components in the range [0.0f, 1.0f] regardless of the image format.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].
float z - Z float coordinate of a pixel in range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure with float components in the range [0.0f, 1.0f].

Pixel Get3DSmooth ( vec3 uvw ) #

Returns a color of a given pixel obtained using linear interpolation. Compressed formats are not supported.

NoticeThis method returns pixel color with float components in the range [0.0f, 1.0f] regardless of the image format.

Arguments

vec3 uvw - Float coordinates of a pixel in the range [0.0f; 1.0f].

Return value

Pixel color represented by a Pixel structure with float components in the range [0.0f, 1.0f].

bool IsCombinedFormat ( ) #

Returns a value indicating if the image is stored in a combined format (RGB565, RGBA4, RGB5A1 or RGB10A2).

Return value

1 if the image is in combined format; otherwise, 0.

bool IsCombinedFormat ( int format ) #

Returns a value indicating if a given format is a combined format (RGB565, RGBA4, RGB5A1 or RGB10A2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is a combined format; otherwise, 0.

bool IsCompressedFormat ( ) #

Returns a value indicating if the image is stored in a compressed format (DXT1, DXT3, DXT5, ATI1, ATI2).

Return value

1 if the image is in a compressed format; otherwise, 0.

bool IsCompressedFormat ( int format ) #

Returns a value indicating if a given format is a compressed format (DXT1, DXT3, DXT5, ATI1, ATI2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is a compressed format; otherwise, 0.

void SetCube ( int x, int y, int face, Pixel p ) #

Sets a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; depth].
int y - Y integer coordinate of a pixel in range [0; height].
int face - Face number in range from 0 to 5.
Pixel p - Pixel color represented by a Pixel structure.

Pixel GetCube ( vec3 direction ) #

Returns a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

vec3 direction - Cube direction vector used for color sampling.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCube ( float x, float y, int face ) #

Returns a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

float x - X float coordinate of a pixel in range [0.0f; 1.0f].
float y - Y float coordinate of a pixel in range [0.0f; 1.0f].
int face - Face number in range from 0 to 5.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCube ( int x, int y, int face ) #

Returns a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int face - Face number in range from 0 to 5.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCube ( ivec2 coord, int face ) #

Returns a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

ivec2 coord - Coordinates of a pixel.
int face - Face number in range from 0 to 5.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCube ( vec2 uv, int face ) #

Returns a color of a given pixel. The image must be of the Cube type. Compressed formats are not supported.

Arguments

vec2 uv - UV coordinates of a pixel.
int face - Face number in range from 0 to 5.

Return value

Pixel color represented by a Pixel structure.

void SetCubeArray ( int x, int y, int face, int layer, Pixel p ) #

Sets a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

int x - X integer coordinate of a pixel in range [0; width].
int y - Y integer coordinate of a pixel in range [0; height].
int face - Face number in range from 0 to 5.
int layer - Image layer number.
Pixel p - Pixel color represented by a Pixel structure.

void SetCubeArray ( ivec2 coord, int face, int layer, Pixel p ) #

Sets a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

ivec2 coord - Coordinates of a pixel.
int face - Face number in range from 0 to 5.
int layer - Image layer number.
Pixel p - Pixel color represented by a Pixel structure.

Pixel GetCubeArray ( vec3 direction, int layer ) #

Returns the color of a given pixel of the cube array image.

Notice

Compressed formats are not supported.

Arguments

vec3 direction - Cube direction vector used for color sampling.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCubeArray ( int v1, int v2, int face, int layer ) #

Returns a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

int v1 - X integer coordinate of a pixel in range [0;width].
int v2 - Y integer coordinate of a pixel in range [0; height].
int face - Face number in range from 0 to 5.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCubeArray ( float v1, float v2, int face, int layer ) #

Returns a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

float v1 - X integer coordinate of a pixel in range [0;width].
float v2 - Y integer coordinate of a pixel in range [0;height].
int face - Face number in range from 0 to 5.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCubeArray ( ivec2 coord, int face, int layer ) #

Returns a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

ivec2 coord - Coordinates of a pixel.
int face - Face number in range from 0 to 5.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

Pixel GetCubeArray ( vec2 uv, int face, int layer ) #

Returns a color of a given pixel. The image must be of the Cube Array type. Compressed formats are not supported.

Arguments

vec2 uv - UV coordinates of a pixel.
int face - Face number in range from 0 to 5.
int layer - Image layer number.

Return value

Pixel color represented by a Pixel structure.

int GetDepth ( int level = 0 ) #

Returns the image depth on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Image depth if the image exists (its depth is larger than 0); otherwise, 1.

bool IsFloatFormat ( ) #

Returns a value indicating if the image is stored in a float format (R32F, RG32F, RGB32F or RGBA32F).

Return value

1 if the image is in float format; otherwise, 0 is returned.

bool IsFloatFormat ( int format ) #

Returns a value indicating if a given format is a float format (R32F, RG32F, RGB32F or RGBA32F).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is a float format; otherwise, 0.

int GetFormat ( int num_channels, int format ) #

Returns a numerical code of the image format for the specified format and number of channels.

Arguments

int num_channels - Number of channels in the [1; 4] range.
int format - Numerical code of the image format. See the FORMAT_* variables.

Return value

Numerical code of the image format for the specified number of channels.

string GetFormatName ( int format ) #

Returns the name of the image format by the given format ID.

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

Image format name. The following values can be returned: R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F, RGB565, RGBA4, RGB5A1, RGB10A2, DXT1, DXT3, DXT5, ATI1, ATI2.

bool IsHalfFormat ( ) #

Returns a value indicating if the image is stored in a half-float format (R16F, RG16F, RGB16F or RGBA16F).

Return value

1 if the image is in half-float format; otherwise, 0.

bool IsHalfFormat ( int format ) #

Returns a value indicating if a given format is a half-float format (R16F, RG16F, RGB16F or RGBA16F).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is a half-float format; otherwise, 0.

int GetHeight ( int level = 0 ) #

Returns image height on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Image height if the image exists (its height is larger than 0); otherwise, 1.

bool SetChannelInt ( int channel, int value ) #

Sets an integer value for a given image channel. Compressed and combined image formats are not supported.

Arguments

int channel - Channel number in range from 0 to number of channels - 1.
int value - Value in range from 0 to 255 (8-bit formats) or from 0 to 65535 (16-bit formats).

Return value

true if the value is set successfully; otherwise, false.

bool SetChannelFloat ( int channel, float value ) #

Sets a float value for a given image channel. Compressed and combined image formats are not supported.

Arguments

int channel - Channel number in range from 0 to number of channels - 1.
float value - Value in range from 0.0f to 1.0f.

Return value

true if the value is set successfully; otherwise, false.

bool SwapChannels ( int channel_0, int channel_1 ) #

Swaps values of two channels with the specified numbers. Compressed formats are not supported.

Arguments

int channel_0 - Number of the first channel in range from 0 to number of channels - 1.
int channel_1 - Number of the second channel in range from 0 to number of channels - 1.

Return value

true if the two specified channels were swapped successfully; otherwise, false.

uint GetOffset ( int level ) #

Returns the image offset on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps.

Return value

Image offset, in bytes.

uint GetNumPixels ( ) #

Returns the number of Pixels in the image.

Return value

Number of pixels.

void SetPixels ( byte[] pixels ) #

Sets image pixels to be taken from the specified source array.

NoticeThis method simply performs pointer assignment (without copying data), therefore, it is fast. But make sure the source is not accidentally modified or deleted when its lifetime expires or otherwise.

Arguments

byte[] pixels - Source array.

int SetPixels ( Blob blob ) #

Sets image pixels by copying data (not just a pointer assignment) from a given source blob.

Arguments

Blob blob - Source blob containing image data to be copied.

Return value

1 if image data is set successfully; otherwise, 0.

IntPtr GetPixels ( ) #

Returns the pointer to the array of pixels.

Return value

Pointer to the array of pixels.

void GetPixels ( Blob blob ) #

Copies the image data to a given target blob.

Arguments

Blob blob - Target blob.

IntPtr GetPixels2D ( int level = 0 ) #

Returns the pointer to the array of pixels with the given mipmap level for the 2D image.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Pointer to the array of pixels.

IntPtr GetPixels2DArray ( int layer, int level = 0 ) #

Returns the pointer to the array of pixels with the given mipmap level and image layer for the 2D Array image.

Arguments

int layer - Number of the image layer.
int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Pointer to the array of pixels.

IntPtr GetPixels3D ( int level = 0 ) #

Returns the pointer to the array of pixels with the given mipmap level for the 3D image.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Pointer to the array of pixels.

IntPtr GetPixelsCube ( int face, int level = 0 ) #

Returns the pointer to the array of pixels with the given mipmap level for the cube image.

Arguments

int face - Face number in range from 0 to 5.
int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Pointer to the array of pixels.

IntPtr GetPixelsCubeArray ( int face, int layer, int level = 0 ) #

Returns the pointer to the array of pixels with the given mipmap level and image layer for the Cube Array image.

Arguments

int face - Face number in range from 0 to 5.
int layer - Number of the image layer.
int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Pointer to the array of pixels.

uint GetPixelsSize ( int format, int w, int h ) #

Returns the size of all pixels for the image of the specified format and size.

Arguments

int format - Image format identifier. See the FORMAT_* variables.
int w - Image width, in pixels.
int h - Image width, in pixels.

Return value

Size of all pixels of the specified image, in bytes.

bool IsRawFormat ( ) #

Returns a value indicating if the image is uncompressed (stored in R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F, RGB565, RGBA4, RGB5A1 or RGB10A2 format).

Return value

1 if the image is uncompressed; otherwise, 0.

bool IsRawFormat ( int format ) #

Returns a value indicating if a given format is an uncompressed format (R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F, RGB565, RGBA4, RGB5A1 or RGB10A2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is an uncompressed format; otherwise, 0.

uint GetSize ( ) #

Returns the current image size.

Return value

Image size, in bytes.

uint GetSize ( int level ) #

Returns the current image size.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps.

Return value

Image size in bytes.

uint GetStride ( int level = 0 ) #

Returns the image stride on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps.

Return value

Image stride in bytes.

uint GetDepthStride ( int level = 0 ) #

Returns the image depth stride on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps.

Return value

Image depth stride in bytes.

string GetTypeName ( int type ) #

Returns the name of the image type by its identifier.

Arguments

int type - Image type. One of the IMAGE_* types.

Return value

Image type name: 2D for a 2D image, 3D for a 3D image, Cube for a cube image, 2D_Array for a 2D Array.

bool IsUCharFormat ( ) #

Returns a value indicating if the image is stored in an unsigned char format (R8, RG8, RGB8, RGBA8, DXT1, DXT3, DXT5, ATI1 or ATI2).

Return value

1 if the image is in unsigned char format; otherwise, 0.

bool IsUCharFormat ( int format ) #

Returns a value indicating if a given format is an unsigned char format (R8, RG8, RGB8, RGBA8, DXT1, DXT3, DXT5, ATI1 or ATI2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is an unsigned char format; otherwise, 0.

bool IsUShortFormat ( ) #

Returns a value indicating if the image is stored in an unsigned short format (R16, RG16, RGB16 or RGBA16).

Return value

1 if the image is in unsigned short format; otherwise, 0.

bool IsUShortFormat ( int format ) #

Returns a value indicating if a given format is an unsigned short format (R16, RG16, RGB16 or RGBA16).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

1 if the specified format is an unsigned short format; otherwise, 0.

int GetWidth ( int level = 0 ) #

Returns the image width on a given mipmap level.

Arguments

int level - Mipmap level in range from 0 to the total number of mipmaps. This is an optional argument.

Return value

Image width if the image exists (its width is larger than 0); otherwise, 1.

bool Blend ( Image image, int x0, int y0, int x1, int y1, int width, int height, float scale = 1.0f, bool safe = 0 ) #

Blends the specified image with the current one. Blending takes place within a specified region. If the safe flag is set to 1, rendering of the blended images won't be performed outside the destination image boundaries. Compressed, combined, half-float and float formats are not supported. Images of different formats can be blended as follows:

R8 with R8, RG8;
RG8 with RG8, RGB8;
RGB8 with RGB8, RGBA8;
RGBA8 with RGBA8 only;
R16 with R16, RG16;
RG16 with RG16, RGB16;
RGB16 with RGB16, RGBA16;
RGBA16 with RGBA16 only;

Arguments

Image image - Source image to be blended with the current image.
int x0 - X coordinate of a position in the current image.
int y0 - Y coordinate of a position in the current image.
int x1 - X coordinate of a position in a source image, which is blended with the current image.
int y1 - Y coordinate of a position in a source image, which is blended with the current image.
int width - Width of the blending region.
int height - Height of the blending region.
float scale - Scale of blending:
- If blended images are of the same format, the blended image is multiplied by scale value and is added to the destination image.
- If a source image has one more channel compared to the current one, it will serve as alpha value. This channel value is multiplied by scale and is used to alpha blend the images.
- The default scale value is 1.0f.
bool safe - 1 for safe blending with respect to destination image boundaries; otherwise, 0.

Return value

Returns 1 if blending is successful; otherwise, 0.

bool Blur ( int size ) #

Filters the image using two-pass Gaussian blur. Only the 2D or cube image can be resized. Compressed and combined image formats are not supported.

Arguments

int size - Blur filter size. It is the number of neighbouring source pixels (from all sides) that are averaged for each blurred destination pixel. For example, if blur = 2, two pixels from each side are taken and the blurring kernel is 5 x 5 pixels.

Return value

1 if the image was successfully blurred or the size of blur filter is 0; otherwise, 0.

void Clear ( ) #

Clears all data associated with the image and resets its type, format, size to default. Also the number of image layers and mipmaps is set to 1.

bool Combine ( int new_format = -1 ) #

Converts the image to a combined format. The following conversions are available:

RGB8 to RGB565
RGBA8 to RGBA4 if the format is specified as RGBA4; otherwise, RGBA8 is converted to RGB5A1 by default
RGBA16 to RGB10A2

Arguments

int new_format - Combined format to convert the image into. This is an optional argument. If no format is specified, default conversion will be performed.

Return value

1 if the conversion into the combined format is successful; otherwise, 0.

bool CombineMipmaps ( ) #

Combines the loaded 2D image with the mipmap image. Only one mipmap image can be combined. Compressed image formats cannot be combined.

Return value

1 if the image and a mipmap are successfully combined; otherwise, 0.

bool Compare ( Image image, int x0, int y0, int x1, int y1, int width, int height, int threshold = 0 ) #

Compares a region of a specified image with a specified region of the current image. Compressed, combined, half-float and float formats are not supported.

Arguments

Image image - Source image to compare the loaded image with.
int x0 - X coordinate on the loaded image.
int y0 - Y coordinate on the loaded image.
int x1 - X coordinate on the source image.
int y1 - Y coordinate on the source image.
int width - Width of a region to compare.
int height - Height of a region to compare.
int threshold - A threshold to compare.

Return value

1 if the regions match; otherwise, 0.

bool Compress ( int new_format = -1 ) #

Converts the image to a compressed format. The following conversions are available:

R8 to ATI1
RG8 to ATI2
RGB8 to DXT1
RGBA8 to DXT3, DXT5(by default)
ZLC1 to ZLC1
ZLC2 to ZLC2

Arguments

int new_format - Format to compress the image into. This is an optional argument. If no format is specified, default conversion will be performed.

Return value

1 if the image is compressed successfully; otherwise, 0.

int ConvertToFormat ( int new_format ) #

Converts the image to a specified format. Compressed and combined images are automatically decompressed/decombined.

Arguments

int new_format - Target format to convert the image into. See the IMAGE_FORMAT_* variables.

Return value

1 if the conversion is successful; otherwise, 0.

int ConvertToType ( int type ) #

Converts the image to a specified type. The following conversions are possible:

Source type	Target type	Target dimensions
2D (height should be proportional to width)	3D	width × height × height/width
2D (height should divide by four, width should divide by three)	Cube	width/4 × height/3
3D	2D	width × height*depth
3D	2D texture array	width × height
Cube	2D	width4 × height3
Cube	2D array texture	width × height
2D array texture	2D	width × height*number of texture layers

Arguments

int type - Type for conversion. One of the IMAGE_* types.

Return value

1 if the conversion is successful; otherwise, 0.

void AssignFrom ( Image src_image ) #

Copies the data from the specified source image. The size of the image shall be updated according to the size of the source image (unlike the resizeFrom() method).

Arguments

Image src_image - Source image.

bool ResizeFrom ( Image src_image, Image.FILTER filter = FILTER_LINEAR ) #

Copies the data from the specified source image, resizing the source. The source image shall be resized (enlarged/shrinked) to fit the size of the image.

Arguments

Image src_image - Source image.
Image.FILTER filter - Filter type to be used: linear or point. The default filter is linear. See the Unigine::Image Enumerations with FILTER_* prefixes.

Return value

true if the data was successfully copied from the source image; otherwise, false.

bool Copy ( Image src_image, int layer ) #

Copies data from the specified source image according to the specified layer parameter. Depending on the image and the source image types the layer parameter either defines the index of the layer/face to copy data FROM (source), or the index of the layer/face to copy data TO (destination):

Image	Source Image	Copy
Cube	2D	Specified source 2D image is copied to the face of the cubemap image specified by the layer argument in the [0; 5] range: 2D_image TO cubemap_face[ *layer* ]
2D Array	2D	Specified source 2D image is copied to the specified layer of the 2D image array: 2D image TO 2D_array[ *layer* ]
Cube Array	Cube	Specified source cubemap image (all 6 faces) is copied to the specified layer of the cubemap image array: cubemap_image TO cubemap_array[ *layer* ]
2D	Cube	Face of the source cubemap image specified by the layer argument in the [0; 5] range is copied to the 2D image: 2D_image FROM cubemap_face[ *layer* ]
2D	2D Array	Specified layer of the source 2D image array is copied to the 2D image: 2D image FROM 2D_array[ *layer* ]
Cube	Cube Array	Specified layer of the source сubemap image array is copied to the cubemap image (all 6 faces): cubemap_image FROM cubemap_array[ *layer* ]

Source code (C#)

src_image.Load(src_image_path);
src_image.ConvertToFormat(Image.FORMAT_RGB8);// 2D 1024x1024 image
		
dest_image.Create2DArray(1024, 1024, 5, Image.FORMAT_RGB8);
dest_image.Copy(src_image, 4); // created 2D image is copied to the 5th layer of the 2D image array

Arguments

Image src_image - Source image.
int layer - Zero-based index defining layer/face TO or FROM which the data is to be copied.

Return value

1 if the data is copied successfully; otherwise, 0.

bool Copy ( Image src_image, int dest_channel, int src_channel ) #

Copies a given channel from the specified image to the specified image channel.

Arguments

Image src_image - Source image.
int dest_channel
int src_channel - Source channel.

Return value

true if the channel is copied successfully from the source image; otherwise, false.

bool Copy ( Image src_image, int x_dst, int y_dst, int x_src, int y_src, int width, int height, bool safe = 0 ) #

Copies a data fragment with specified width, height, and coordinates from the source image.

Arguments

Image src_image - Source image, from which a fragment is to be copied.
int x_dst - X coordinate of a position in the image, to which the data fragment is to be copied.
int y_dst - Y coordinate of a position in the image, to which the data fragment is to be copied.
int x_src - X coordinate of a position in a source image, starting from which the data fragment is to be copied.
int y_src - Y coordinate of a position in a source image, starting from which the data fragment is to be copied.
int width - Width of the fragment to be copied from the source image, in pixels.
int height - Height of the fragment to be copied from the source image, in pixels.
bool safe - 1 for safe copying with respect to destination image boundaries; otherwise, 0.
Notice
The safe flag doesn't provide safe copying with respect to source image boundaries.

Return value

true if the specified fragment was successfully copied from the source image; otherwise, false.

bool CopyFast ( Image src_image, uint x_dst, uint y_dst, uint x_src, uint y_src, uint w, uint h ) #

Copies a data fragment with specified width, height, and coordinates from the source image.

Arguments

Image src_image - Source image, from which a fragment is to be copied.
uint x_dst - X coordinate of a position in the image, to which the data fragment is to be copied.
uint y_dst - Y coordinate of a position in the image, to which the data fragment is to be copied.
uint x_src - X coordinate of a position in a source image, starting from which the data fragment is to be copied.
uint y_src - Y coordinate of a position in a source image, starting from which the data fragment is to be copied.
uint w - Width of the fragment to be copied from the source image, in pixels.
uint h - Height of the fragment to be copied from the source image, in pixels.

Return value

true if the specified fragment was successfully copied from the source image; otherwise, false.

bool Create2D ( int width, int height, int format, int num_mipmaps = 1, bool clear = 1, bool allocate = 1 ) #

Creates an empty 2D image filled with black color.

Arguments

int width - Required width, in pixels.
int height - Required height, in pixels.
int format - Required format. See the FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument. If the value is smaller than 1, an assertion is raised.
bool clear - Positive number to fill the image with black color, 0 not to fill. This optional argument can be set to 0 if new data will fully overwrite the data existing in the memory.
bool allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

true if 2D image is successfully created; otherwise, false.

bool Create2DArray ( int width, int height, int num_layers, int format, int num_mipmaps = 1, bool clear = 1, bool allocate = 1 ) #

Creates an empty 2D texture array filled with black color.

Arguments

int width - Required width, in pixels.
int height - Required height, in pixels.
int num_layers - Number of texture layers.
int format - Required format. See the FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument. If the value is smaller than 1, an assertion is raised.
bool clear - Positive number to fill the texture array with black color, 0 not to fill. This optional argument can be set to 0 if new data will fully overwrite the data existing in the memory.
bool allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

true if 2D texture array is successfully created; otherwise, false.

bool Create3D ( int width, int height, int depth, int format, int num_mipmaps = 1, bool clear = 1, bool allocate = 1 ) #

Creates an empty 3D image filled with black color.

Arguments

int width - Required width, in pixels.
int height - Required height, in pixels.
int depth - Required depth.
int format - Required format. See the IMAGE_FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument. If the value is smaller than 1, an assertion is raised.
bool clear - Positive number to fill the image with black color, 0 not to fill. This optional argument can be set to 0 if new data will fully overwrite the data existing in the memory.
bool allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

true if 3D image is successfully created; otherwise, false.

void Create3DTurbulence ( int size, float scale, int frequency, int seed ) #

Creates a 3D turbulence image (RGBA8).

Arguments

int size - 3D image size, in pixels. Width, height, and depth are equal.
float scale - Scaling factor applied to the displacement amount.
int frequency - Base frequency, determines how rapidly the displacement amount changes. Increasing this value creates more turbulence.
int seed - Specifies the initial number used for noise generation. Different Seed values produce different random variations and can be useful in changing the result. Keep in mind, that you should use the same Seed value when you want to retain the same variations.

bool CreateCube ( int width, int height, int format, int num_mipmaps = 1, bool clear = 1, bool allocate = 1 ) #

Creates the empty cube image filled with black color.

Arguments

int width - Image width, in pixels.
int height - Image height, in pixels.
int format - Texture format. See the FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument.
bool clear - 1 to fill the image with black color, 0 is not to fill. This optional argument can be set to 0 if new data will fully overwrite the data existing in the memory.
bool allocate - 1 to allocate memory for the created image. This value should be always set to 1.

Return value

1 if the cube image is successfully created; otherwise, 0.

bool CreateCubeArray ( int width, int height, int num_layers, int format, int num_mipmaps = 1, bool clear = 1, bool allocate = 1 ) #

Creates the empty cube array image filled with black color.

Arguments

int width - Image width, in pixels.
int height - Image height, in pixels.
int num_layers - Number of image layers.
int format - Texture format. See the FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument.
bool clear - 1 to fill the image with black color, 0 is not to fill. This optional argument can be set to 0 if new data will fully overwrite the data existing in the memory.
bool allocate - 1 to allocate memory for the created image. This value should be always set to 1.

Return value

1 if the cube array image is successfully created; otherwise, 0.

bool CreateMipmaps ( Image.FILTER filter = FILTER_LINEAR, float gamma = 1.0f ) #

Generates mipmaps for the image. Mipmaps cannot be created for compressed and combined image formats.

Arguments

Image.FILTER filter - Filter type to be used: linear or point. The default filter is linear. See the Unigine::Image Enumerations with FILTER_* prefixes.
float gamma - Gamma correction value. If 1 is provided, no gamma correction is applied. This is an optional argument.

Return value

true if the mipmaps are generated successfully; otherwise, false.

bool RemoveMipmaps ( ) #

Removes mipmaps generated for the image.

Return value

true if mipmaps generated for the image are removed successfully; otherwise, false.

bool Decombine ( ) #

Automatically converts the image from the combined format to a correct one. The following conversions are available:

RGB565 to RGB8
RGBA4 to RGBA8
RGB5A1 to RGBA8
RGB10A2 to RGBA16

Return value

1 if the image is successfully converted from the combined format; otherwise, 0.

bool DecombineMipmaps ( ) #

Decombines the loaded 2D-image and the mipmap images. The number of mipmaps must be larger than 1. Compressed image formats cannot be decombined.

Return value

1 if the 2D-image and mipmap image are successfully decombined; otherwise, 0.

bool Decompress ( ) #

Decompresses the image from the compressed format to a correct one. The following conversions are available:

DXT1 to RGB8
DXT1 without alpha data to RGB8
DXT3 to RGBA8
DXT5 to RGBA8
ATI1 to R8
ATI2 to RG8

Return value

1 if the image was successfully decompressed; otherwise, 0.

bool Extrude ( int pixels ) #

Extrudes contour of the image in the alpha=0 region on the given number of pixels. Only images of the RGBA8 and RGBA16 formats can be extruded.

Arguments

int pixels - Number of contour pixels.

Return value

1 if the image contour is successfully extruded; otherwise, 0.

bool FlipX ( ) #

Flips the 2D image horizontally. Compressed and combined image formats are not supported.

Return value

bool FlipY ( ) #

Flips the 2D image vertically. Compressed and combined image formats are not supported.

Return value

1 if the image is successfully flipped; otherwise, 0.

bool HasMipmaps ( ) #

Returns a value indicating if the source image has mipmaps.

Return value

1 if the image has mipmaps; otherwise, 0.

bool Info ( string file ) #

Returns information about the given image. The following file formats are supported:

*.texture
*.tga
*.jpg
*.png
*.dds
*.psd
*.ies
tif
- *.tif
- *.tiff

Arguments

string file - Name of the image file.

Return value

1 if the operation was a success; otherwise, 0.

bool Invert ( ) #

Inverts values of all the image channels. Only R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R32F, RG32F, RGB32F and RGBA32F formats can be inverted.

Return value

true if the image is inverted successfully; otherwise, false.

bool Load ( string file, int mip_offset ) #

Loads an image from a specified file. The following file formats are supported:

*.texture
*.tga
*.png
*.dds
*.psd
*.ppm
*.pgm
*.hdr
*.sgi
*.ies
*.exr
tif
- *.tif
- *.tiff
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi
sgi
- *.bw
- *.la
- *.int
- *.inta
- *.rgb
- *.rgba

Arguments

string file - Name of the image file.
int mip_offset - Mipmap offset.

Return value

true if the image is loaded successfully; otherwise, false.

bool Load ( string file ) #

Loads an image from the specified file. The following file formats are supported:

*.texture
*.tga
*.png
*.dds
*.psd
*.ppm
*.pgm
*.hdr
*.sgi
*.ies
*.exr
tif
- *.tif
- *.tiff
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi
sgi
- *.bw
- *.la
- *.int
- *.inta
- *.rgb
- *.rgba

Arguments

string file - Name of the image file.

Return value

true if the image is loaded successfully; otherwise, false.

bool Load ( Stream stream ) #

Loads an image from a specified stream. The following file formats are supported:

*.texture
*.tga
*.png
*.dds
*.psd
*.ppm
*.pgm
*.hdr
*.sgi
*.ies
*.exr
tif
- *.tif
- *.tiff
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi
sgi
- *.bw
- *.la
- *.int
- *.inta
- *.rgb
- *.rgba

Arguments

Stream stream - Stream.

Return value

1 if the image is loaded successfully; otherwise, 0.

bool Normalize ( ) #

Creates a three-component normal map out of the image.

Return value

1 if normalization was successful; otherwise, 0.

bool Resize ( int new_width, int new_height, Image.FILTER filter = FILTER_LINEAR ) #

Resizes the image. Only the 2D or cube image can be resized. Compressed and combined image formats cannot be resized.

Arguments

int new_width - New image width.
int new_height - New image height.
Image.FILTER filter - Filter type to be used: linear or point. The default filter is linear. See the Unigine::Image Enumerations with FILTER_* prefixes.

Return value

1 if the image is resized successfully; otherwise, 0.

bool Rotate ( int angle ) #

Rotates the image by a given angle (with the step of 90 degrees). Only the 2D or cube image can be rotated. Compressed and combined image formats cannot be rotated.

Arguments

int angle - Angle, that will be multiplied by the step (angle * 90) to set the image rotation degree.

Return value

1 if the image is rotated successfully; otherwise, 0.

bool Save ( string file ) #

Saves the image to a file with the specified name. The following file formats are supported:

*.texture
*.tga
*.png
*.dds
*.psd
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi

Arguments

string file - Name of the file to save image data to.

Return value

Returns 1 if the image is saved successfully; otherwise, 0.

bool Save ( string file, float quality ) #

Saves the image to a specified file. The following file formats are supported:

*.texture
*.tga
*.png
*.dds
*.psd
jpg
- *.jpg
- *.jpeg
- *.jpe
- *.jif
- *.jfif
- *.jfi

Arguments

string file - Name of a file with extension into which data will be saved.
float quality - Quality of JPG compression in range [0;1].

Return value

Returns 1 if the image is saved successfully; otherwise, 0.

bool Save ( Stream stream ) #

Saves the image data (either compressed or uncompressed) to the specified stream. Current image compression is to be used.

Arguments

Stream stream - Pointer to the stream.

Return value

true if the image is successfully saved to the specified stream; otherwise, false.

bool Sign ( ) #

Converts the image from unsigned type to signed char. Only R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, ATI1 and ATI2 formats can be converted.

Return value

1 if the image has been converted successfully; otherwise, 0.

void Swap ( Image image ) #

Swaps the data of the current image with the source image.

Arguments

Image image - Source image.

Pixel ToPixel ( vec4 color ) #

Converts a vec4 color vector (R, G, B, A) to Pixel color.

Arguments

vec4 color - Color vec4 vector (R, G, B, A) with components normalized in range [0.0f; 1.0f]

Return value

Pixel color represented by a Pixel structure.

Pixel ToPixel ( int format, vec4 color ) #

Converts a vec4 color vector (R, G, B, A) to Pixel color depending on the specified image format.

Arguments

int format - Image format identifier. See the FORMAT_* variables.
vec4 color - Color vec4 vector (R, G, B, A) with components normalized in range [0.0f; 1.0f]

Return value

Pixel color represented by a Pixel structure.

vec4 ToVec4 ( Pixel pixel ) #

Converts Pixel color to a vec4 color vector (R, G, B, A).

Arguments

Pixel pixel - Pixel color represented by a Pixel structure.

Return value

Color vec4 vector (R, G, B, A). Each component is normalized in range [0.0f; 1.0f]

vec4 ToVec4 ( int format, Pixel p ) #

Converts Pixel color to a vec4 color vector (R, G, B, A) depending on the specified image format.

Arguments

int format - Image format identifier. See the FORMAT_* variables.
Pixel p - Pixel color represented by a Pixel structure.

Return value

Color vec4 vector (R, G, B, A). Each component is normalized in range [0.0f; 1.0f]

int GetNumChannels ( int format ) #

Returns the number of channels for the specified image format.

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

Number of channels for the specified image format.

int GetPixelSize ( int format ) #

Returns the pixel size for the specified image format. Not available for compressed image formats (DXT1, DXT3, DXT5, ATI1, ATI2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

Pixel size for the specified image format.

int GetBlockSize ( int format ) #

Returns the block size for the specified image format. Available for compressed image formats only (DXT1, DXT3, DXT5, ATI1, ATI2).

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

Block size for the specified image format.

bool InvertChannel ( byte channel ) #

Inverts the values stored in the specified channel. Channels of images of half (FORMAT_R16F to FORMAT_RGBA16F) and float (FORMAT_R32F to FORMAT_RGBA32F) formats cannot be inverted.

Arguments

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

Return value

true if the specified channel is inverted successfully; otherwise, false.

bool SaveDDS ( Stream stream ) #

Saves the DDS image to a specified stream.

Arguments

Stream stream - Stream.

Return value

true if the DDS image is saved successfully; otherwise, false.

bool LoadDDS ( Stream stream ) #

Loads a DDS image from a specified stream.

Arguments

Stream stream - Stream.

Return value

true if the DDS image is loaded successfully; otherwise, false.

int GetRawFormat ( int format ) #

Returns the closest RAW format of the uncompressed image.

Arguments

int format - Image format identifier. See the FORMAT_* variables.

Return value

Identifier of the uncompressed image (stored in R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F format).

void SetFileCompression ( Image.FILE_COMPRESSION compression ) #

File compression type to be used for the image. Compression is applied only when saving the image into the *.texture format.

Arguments

Image.FILE_COMPRESSION compression - File compression type to be used for the image. One of the FILE_COMPRESSION_* values.

Image.FILE_COMPRESSION GetFileCompression ( ) #

Returns the image file compression type. Compression is applied only when saving the image into the *.texture format.

Return value

File compression type used for the image. One of the FILE_COMPRESSION_* values.

void CalcRange ( out dvec2 range ) #

Calculates the image range for all available channels in total.

Arguments

out dvec2 range - The vector to store the image range (min and max values).

void CalcRange ( out dvec2 r, out dvec2 g, out dvec2 b, out dvec2 a ) #

Calculates the image range for each channel separately.

Arguments

out dvec2 r - The vector to store the R channel range (min and max values).
out dvec2 g - The vector to store the G channel range (min and max values).
out dvec2 b - The vector to store the B channel range (min and max values).
out dvec2 a - The vector to store the A channel range (min and max values).

void ChangeRange ( dvec4 range ) #

Changes the image range.

NoticeThe range of the final image will be clamped, if the set range values exceed the maximum values of the image format.

Arguments

dvec4 range - Vector that stores the range values: x and y coordinates of the value specify the original range, z and w specify the new range.

void ChangeRange ( dvec4 range_r, dvec4 range_g, dvec4 range_b, dvec4 range_a ) #

Changes the image range for each channel separately.

NoticeThe range of the final image will be clamped, if the set range values exceed the maximum values of the image format.

Arguments

dvec4 range_r - Vector that stores the range values for the R channel: x and y coordinates of the value specify the original range, z and w specify the new range.
dvec4 range_g - Vector that stores the range values for the G channel: x and y coordinates of the value specify the original range, z and w specify the new range.
dvec4 range_b - Vector that stores the range values for the B channel: x and y coordinates of the value specify the original range, z and w specify the new range.
dvec4 range_a - Vector that stores the range values for the A channel: x and y coordinates of the value specify the original range, z and w specify the new range.

void NormalizeRange ( bool per_cahnnel ) #

Normalizes the image range either per channel or for all channels altogether.

Arguments

bool per_cahnnel - true if per-channel normalization is required; otherwise, false.

bool FlipCubemapX ( ) #

Flips the cubemap image along the X axis.

Return value

true if the cubemap is flipped successfully; otherwise, false.

bool FlipCubemapY ( ) #

Flips the cubemap image along the Y axis.

Return value

true if the cubemap is flipped successfully; otherwise, false.

bool FlipCubemapZ ( ) #

Flips the cubemap image along the Z axis.

Return value

true if the cubemap is flipped successfully; otherwise, false.

Last update: 2021-11-03

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine.Image Class

See Also

Properties:

Methods:

Variables:

Usage example#

Image Class

Enums

FILE_COMPRESSION#

FILTER#

Properties

int NumChannels#

int Type#

string TypeName#

int NumMipmaps#

int NumLayers#

int NumFaces#

bool IsLoaded#

int BlockSize#

int PixelSize#

bool IsCubeType#

bool IsArrayType#

bool Is3DType#

bool Is2DType#

int Format#

string FormatName#

int Depth#

int Height#

int Width#

uint PixelsSize#

uint NumPixels#

Image.FILE_COMPRESSION FileCompression#

Members

Image ( ) #

Image ( string name ) #

Arguments

Image ( Image image ) #

Arguments

bool AllocData ( bool clear = true ) #

Arguments

Return value

void ClearData ( ) #

void Set ( int id, dvec4 value ) #

Arguments

void get ( int id, out dvec4 value ) #

Arguments

vec4 get ( ivec2 coord, int offset ) #

Arguments

Return value

void get ( ivec2 coord, int offset, out vec4 p00, out vec4 p01, out vec4 p10, out vec4 p11 ) #

Arguments

void Get8F ( ivec2 coord, out vec4 p ) #

Arguments

float Get8F ( ivec2 coord ) #

Arguments

Return value

void Get16F ( ivec2 coord, out vec4 p ) #

Arguments

float Get16F ( ivec2 coord ) #

Arguments

Return value

void Get32F ( ivec2 coord, out vec4 p ) #

Arguments

float Get32F ( ivec2 coord ) #

Arguments

Return value

void Set2D ( int x, int y, Pixel p ) #

Arguments

void Set2D ( ivec2 coord, Pixel p ) #

Arguments

Pixel Get2D ( int x, int y ) #

Arguments

Return value

Pixel Get2D ( float x, float y ) #

Arguments

Return value

Pixel Get2D ( float x, float y, Pixel skip_pixel ) #

Arguments

Return value

Pixel Get2D ( ivec2 coord ) #