Image Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

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.

Methods:

Name	Description View: Sort by:
Image	Default constructor.
is2DType	Returns a value indicating if the image is a 2D image.
is3DType	Returns a value indicating if the image is a 3D image.
isArrayType	Returns a value indicating if the image is of an array type (see *_ARRAY variables).
getBlockSize	Returns the compressed image block size.
isCubeType	Returns a value indicating if the image is Cube image.
getFormat	Returns a numerical code of the image format.
getFormatName	Returns an image format name.
isLoaded	Returns a value indicating whether the image is loaded.
getNumChannels	Returns the number of image channels.
getNumFaces	Returns the number of faces in the image.
getNumLayers	Returns the number of layers in the image.
getNumMipmaps	Returns the number of mipmaps stored with the image.
getNumPixels	Returns the number of Pixels in the image.
getPixelSize	Returns the uncompressed image pixel size.
getPixelsSize	Returns the size of all pixels of the image.
getType	Returns a numerical code of the image type.
getTypeName	Returns an image type name.
getDepth	Returns the image depth, in pixels.
getHeight	Returns the image height, in pixels.
getWidth	Returns the image width, in pixels.
setFileCompression	File compression type to be used for the image.
getFileCompression	Returns the image file compression type.
allocData	Allocates memory for the image data.
clearData	Clears all image data.
set	Sets a value for a pixel by its id.
get	Gens a value for a pixel by its id and puts it to value.
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.
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.
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.
getPixels	Copies the image data to a given target blob.
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 depending on the specified image format.
toVec4	Converts Pixel color to a vec4 color vector (R, G, B, A) depending on the specified image format.
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.
getRawFormat	Returns the closest RAW format of the uncompressed image.
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.
getSupportedExtensions	Returns a list of supported file extensions.
isSupportedExtension	Returns a value indicating if the file extension is supported.
isSupported	Returns a value indicating if the extension of a file provided by path is supported.

Variables:

Name	Description
IMAGE_FILTER_POINT = 0	A point mipmap filter.
IMAGE_FILTER_LINEAR = 1	A linear mipmap filter.
IMAGE_FILTER_MIN = 2	A minimum mipmap filter.
IMAGE_AUTO_FORMAT = -1	Format is set automatically.
IMAGE_FORMAT_R8 = 0	Non-compressed unsigned format. Stores data in one 8-bit channel (red).
IMAGE_FORMAT_RG8 = 1	Non-compressed unsigned format. Stores data in two 8-bit channels (red, green).
IMAGE_FORMAT_RGB8 = 2	Non-compressed unsigned format. Stores data in three 8-bit channels (red, green, blue).
IMAGE_FORMAT_RGBA8 = 3	Non-compressed unsigned format. Stores data in four 8-bit channels (red, green, blue, alpha).
IMAGE_FORMAT_R16 = 4	Non-compressed unsigned format. Stores data in one 16-bit channel (red).
IMAGE_FORMAT_RG16 = 5	Non-compressed unsigned format. Stores data in two 16-bit channels (red, green).
IMAGE_FORMAT_RGB16 = 6	Non-compressed unsigned format. Stores data in three 16-bit channels (red, green, blue).
IMAGE_FORMAT_RGBA16 = 7	Non-compressed unsigned format. Stores data in four 16-bit channels (red, green, blue, alpha).
IMAGE_FORMAT_R16F = 8	Non-compressed float format. Stores data in one 16-bit channel (red).
IMAGE_FORMAT_RG16F = 9	Non-compressed float format. Stores data in two 16-bit channels (red, green).
IMAGE_FORMAT_RGB16F = 10	Non-compressed float format. Stores data in three 16-bit channels (red, green, blue).
IMAGE_FORMAT_RGBA16F = 11	Non-compressed float format. Stores data in four 16-bit channels (red, green, blue, alpha).
IMAGE_FORMAT_R32F = 12	Non-compressed float format. Stores data in one 32-bit channel (red).
IMAGE_FORMAT_RG32F = 13	Non-compressed float format. Stores data in two 32-bit channels (red, green).
IMAGE_FORMAT_RGB32F = 14	Non-compressed float format. Stores data in three 32-bit channels (red, green, blue).
IMAGE_FORMAT_RGBA32F = 15	Non-compressed float format. Stores data in four 32-bit channels (red, green, blue, alpha).
IMAGE_FORMAT_RGB565 = 16	Combined unsigned format. Stores 16 bit color values without alpha.
IMAGE_FORMAT_RGBA4 = 17	Combined unsigned format. Stores data in four 4-bit channels (red, green, blue, alpha).
IMAGE_FORMAT_RGB5A1 = 18	Combined unsigned format. Stores data in three 5-bit channels (red, green, blue) and one 1-bit channel (alpha).
IMAGE_FORMAT_RGB10A2 = 19	Combined unsigned format. Stores data in three 10-bit channels (red, green, blue) and one 2-bit channel (alpha).
IMAGE_FORMAT_RG11B10F = 20	Combined unsigned float format. Stores data in two 11-bit channels (red, green) and one 10-bit channel (blue).
IMAGE_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.
IMAGE_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.
IMAGE_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.
IMAGE_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.
IMAGE_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.
IMAGE_FILE_COMPRESSION_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).
IMAGE_FILE_COMPRESSION_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).
IMAGE_FILE_COMPRESSION_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).
IMAGE_FILE_COMPRESSION_ZLC_LOW = 1	Fast compression used for images stored in the system memory (based on zlib library).
IMAGE_FILE_COMPRESSION_DISABLE = 0	Image data is uncompressed.

Image Class

Members

static Image ( ) #

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

static Image ( string name ) #

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

Arguments

string name - Image file name.

int allocData ( int clear = true ) #

Allocates memory for the image data.

Arguments

int clear - Clear flag: set 1 to fill allocated memory with zero-values; otherwise, set 0.

Return value

1 if memory for the image data is allocated successfully; otherwise, 0.

void clearData ( ) #

Clears all image data.

void set ( int id, const dvec4 & value ) #

Sets a value for a pixel by its id. Compressed and combined image formats are not supported.

Arguments

int id - Pixel ID: id = image_width * Y + X, (0 , 0) - top left corner of the image.
const dvec4 & value - RGBA color of a pixel with the specified ID.

void get ( int id, dvec4 & value ) #

Gens a value for a pixel by its id and puts it to value.

Arguments

int id - Pixel ID: id = image_width * Y + X, (0 , 0) - top left corner of the image.
dvec4 & value - RGBA color of a pixel with the specified ID.

void get8F ( const ivec2 & coord, 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

const ivec2 & coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
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 ( const ivec2 & coord ) #

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

Arguments

const 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 ( const ivec2 & coord, 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

const ivec2 & coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
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 ( const ivec2 & coord ) #

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

Arguments

const 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 ( const ivec2 & coord, 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

const ivec2 & coord - Pixel coordinates (X, Y) - X in the [0; width] range, Y in the [0; height] range.
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 ( const ivec2 & coord ) #

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

Arguments

const 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, float r, float g, float b, float a, variable color ) #

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].
float r - Red component of a color normalized in range from 0 to 1.
float g - Green component of a color normalized in range from 0 to 1.
float b - Blue component of a color normalized in range from 0 to 1.
float a - Alpha component of a color normalized in range from 0 to 1.
variable color - Color. It can be a vector of 4 float or integer components (vec4 or ivec4) or a scalar (for images with a single channel).

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.If float coordinates are provided, linear interpolation is used to get a color sample.

Arguments

int x - The X coordinate of a pixel. It can be one of the following:
- int in range [0; width]
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
int y - Y coordinate of a pixel. Must be of the same type as x:
- int in range [0; height]
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
int layer - Image layer number.

Return value

Color. It can be a vector of 4 float or integer components (vec4 or ivec4) or a scalar (for images with a single channel).

int is2DType ( ) #

Returns a value indicating if the image is a 2D image.

Return value

1 if the image is a 2D image; otherwise - 0.

void set3D ( int x, int y, int z, float r, float g, float b, float a ) #

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].
float r - Red component of a color normalized in range from 0 to 1.
float g - Green component of a color normalized in range from 0 to 1.
float b - Blue component of a color normalized in range from 0 to 1.
float a - Alpha component of a color normalized in range from 0 to 1.

get3D ( float x, float y, float z ) #

Returns a color of a given pixel. The image must be of the 2D type. Compressed formats are not supported. If float coordinates are provided, linear interpolation is used to get a color sample.

Arguments

float x - X coordinate of a pixel. It can be:
- int in range [0; width].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
float y - Y coordinate of a pixel. It can be:
- int in range [0; width].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
float z - Z coordinate of a pixel. It can be:
- int in range [0; width].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.

Return value

Color. It can be a vector of 4 float or integer components (vec4 or ivec4) or a scalar (for images with a single channel).

get3D ( int x, int y, int z ) #

Returns a color of a given pixel. The image must be of the 3D type. Compressed formats are not supported. If float coordinates are provided, linear interpolation is used to get a color sample.

Arguments

int x - X coordinate of a pixel. It can be:
- int in range [0; width].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
int y - Y coordinate of a pixel. Must be of the same type as x:
- int in range [0; height].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.
int z - Z coordinate of a pixel. Must be of the same type as x:
- int in range [0; depth].
- float in range [0.0f; 1.0f]
  Notice
  If the provided value is outside the range, modulus is used to count pixels from the beginning.

Return value

Color. It can be a vector of 4 float or integer components (vec4 or ivec4) or a scalar (for images with a single channel).

int is3DType ( ) #

Returns a value indicating if the image is a 3D image.

Return value

1 if the image is a 3D image; otherwise, 0.

int isArrayType ( ) #

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

Return value

1 if the image is of an array type; otherwise, 0.

int getBlockSize ( ) #

Returns the compressed image block size.

Return value

Block size in bytes.

int 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.

int 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.

int 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.

int 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 ) #

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.

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 stored in a vec4.

getCube ( int x, int y, int face, vec3 direction ) #

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.
vec3 direction - Direction vector used for color sampling.

Return value

Pixel color stored in a vec4.

void setCubeArray ( int x, int y, int face, int layer ) #

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.

getCubeArray ( int layer ) #

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

Notice

Compressed formats are not supported.

Arguments

int layer - Image layer number.

Return value

Pixel color (can be vec4, or ivec4, or a scalar for single-channel images).

getCubeArray ( int v1, int v2, int face, int layer ) #

Returns the color of a given pixel of the cube array image. Both the first and the second passed arguments mush be either of the float or of the integer type.

Notice

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 stored in a vec4.

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 stored in a vec4.

int isCubeType ( ) #

Returns a value indicating if the image is Cube image.

Return value

1 if the image is a cube image; otherwise, 0.

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.

int 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.

int 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 IMAGE_FORMAT_* variables.

Return value

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

int getFormat ( ) #

Returns a numerical code of the image format.

Return value

Numerical code of the image format. See the IMAGE_FORMAT_* variables.

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 IMAGE_FORMAT_* variables.

Return value

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

string getFormatName ( ) #

Returns an image format name.

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.

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

int 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.

int 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.

int isLoaded ( ) #

Returns a value indicating whether the image is loaded.

Return value

1 if the image is loaded; otherwise, 0.

int 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

1 if the value is set successfully; otherwise, 0.

int 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

1 if the value is set successfully; otherwise, 0.

int 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

1 if the two specified channels were swapped successfully; otherwise, 0.

int getNumChannels ( ) #

Returns the number of image channels.

Return value

Number of image channels.

int getNumFaces ( ) #

Returns the number of faces in the image.

Return value

Number of image faces.

int getNumLayers ( ) #

Returns the number of layers in the image.

Return value

Number of layers.

int getNumMipmaps ( ) #

Returns the number of mipmaps stored with the image.

Return value

Number of mipmap levels.

int 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.

int getNumPixels ( ) #

Returns the number of Pixels in the image.

Return value

Number of pixels.

void getPixels ( ) #

Copies the image data to a given target blob.

Arguments

int getPixelSize ( ) #

Returns the uncompressed image pixel size.

Return value

Pixel size, in bytes.

int 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.

int getPixelsSize ( ) #

Returns the size of all pixels of the image.

Return value

Size of all pixels of the image, in bytes.

int 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.

int 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.

int getSize ( ) #

Returns the current image size.

Return value

Image size, in bytes.

int 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.

int 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.

int 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.

int getType ( ) #

Returns a numerical code of the image type.

Return value

Numerical code of the image type: 0 for a 2D image, 1 for a 3D image, 2 for a cube image, 3 for a 2D Array. See the Unigine::Image:: Enumeration with IMAGE_* prefixes.

string getTypeName ( ) #

Returns an image type name.

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.

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.

int 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.

int 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.

int 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.

int 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.

int blend ( Image image, int x0, int y0, int x1, int y1, int width, int height, float scale = 1.0f, int 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.
int safe - 1 for safe blending with respect to destination image boundaries; otherwise, 0.

Return value

Returns 1 if blending is successful; otherwise, 0.

int 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.

int 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.

int 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.

int 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.

int 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 ( const 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

const Image & src_image - Source image.

bool resizeFrom ( ) #

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

Return value

1 if the data was successfully copied from the source image; otherwise, 0.

int copy ( const 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 (UnigineScript)

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

const 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.

int copy ( const Image & src_image, int dest_channel, int src_channel ) #

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

Arguments

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

Return value

1 if the channel is copied successfully from the source image; otherwise, 0.

int copy ( const Image & src_image, int x_dst, int y_dst, int x_src, int y_src, int width, int height, int safe = 0 ) #

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

Arguments

const 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.
int 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

1 if the specified fragment was successfully copied from the source image; otherwise, 0.

int copyFast ( const Image & src_image, int x_dst, int y_dst, int x_src, int y_src, int w, int h ) #

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

Arguments

const 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 w - Width of the fragment to be copied from the source image, in pixels.
int h - Height of the fragment to be copied from the source image, in pixels.

Return value

1 if the specified fragment was successfully copied from the source image; otherwise, 0.

int create2D ( int width, int height, int format, int num_mipmaps = 1, int clear = 1, int 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 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.
int 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.
int allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

1 if 2D image is successfully created; otherwise, 0.

int create2DArray ( int width, int height, int num_layers, int format, int num_mipmaps = 1, int clear = 1, int 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 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.
int 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.
int allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

1 if 2D texture array is successfully created; otherwise, 0.

int create3D ( int width, int height, int depth, int format, int num_mipmaps = 1, int clear = 1, int 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.
int 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.
int allocate - Positive number to allocate memory for the created image. This value should be always set to 1.

Return value

1 if 3D image is successfully created; otherwise, 0.

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.

int createCube ( int width, int height, int format, int num_mipmaps = 1, int clear = 1, int 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 IMAGE_FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument.
int 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.
int 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.

int createCubeArray ( int width, int height, int num_layers, int format, int num_mipmaps = 1, int clear = 1, int 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 IMAGE_FORMAT_* variables.
int num_mipmaps - Number of mipmaps to create. This is an optional argument.
int 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.
int 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 ( int filter = FILTER_LINEAR, float gamma = 1.0f ) #

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

Arguments

int 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.

int removeMipmaps ( ) #

Removes mipmaps generated for the image.

Return value

1 if mipmaps generated for the image are removed successfully; otherwise, 0.

int 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.

int 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.

int 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.

int 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.

int flipX ( ) #

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

Return value

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

int 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.

int hasMipmaps ( ) #

Returns a value indicating if the source image has mipmaps.

Return value

1 if the image has mipmaps; otherwise, 0.

int 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.

int 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

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

int 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

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

int 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

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

int 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, int 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.
int 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.

int 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 ( ) #

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

Return value

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

bool save ( 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

float quality - Quality of JPG compression in range [0;1].

Return value

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

int 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 ( 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 ( 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.

int getDepth ( ) #

Returns the image depth, in pixels.

Return value

Image depth, in pixels

int getHeight ( ) #

Returns the image height, in pixels.

Return value

Image height, in pixels

int getWidth ( ) #

Returns the image width, in pixels.

Return value

Image width, in pixels

int invertChannel ( int 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

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

Return value

1 if the specified channel is inverted successfully; otherwise, 0.

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 ( int compression ) #

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

Arguments

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

int 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 ( dvec2 & range ) #

Calculates the image range for all available channels in total.

Arguments

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

void calcRange ( dvec2 & r, dvec2 & g, dvec2 & b, dvec2 & a ) #

Calculates the image range for each channel separately.

Arguments

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

void changeRange ( const 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

const 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 ( const dvec4 & range_r, const dvec4 & range_g, const dvec4 & range_b, const 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

const 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.
const 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.
const 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.
const 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 ( int per_cahnnel ) #

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

Arguments

int per_cahnnel - 1 if per-channel normalization is required; otherwise, 0.

int flipCubemapX ( ) #

Flips the cubemap image along the X axis.

Return value

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

int flipCubemapY ( ) #

Flips the cubemap image along the Y axis.

Return value

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

int flipCubemapZ ( ) #

Flips the cubemap image along the Z axis.

Return value

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

Vector<String> getSupportedExtensions ( ) #

Returns a list of supported file extensions.

Return value

Vector of supported file extensions.

int isSupportedExtension ( string ext ) #

Returns a value indicating if the file extension is supported.

Arguments

string ext - File extension.

Return value

1 if the file extension is supported; otherwise, 0.

int isSupported ( string path ) #

Returns a value indicating if the extension of a file provided by path is supported.

Arguments

string path - Path to the file.

Return value

1 if the file extension is supported; otherwise, 0.

Last update: 2022-01-29

Help improve this article

Was this article helpful?

Report a problem related to this article

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

Image Class

See Also

Methods:

Variables:

Image Class

Members

static Image ( ) #

static Image ( string name ) #

Arguments

int allocData ( int clear = true ) #

Arguments

Return value

void clearData ( ) #

void set ( int id, const dvec4 & value ) #

Arguments

void get ( int id, dvec4 & value ) #

Arguments

void get8F ( const ivec2 & coord, vec4 & p ) #

Arguments

float get8F ( const ivec2 & coord ) #

Arguments

Return value

void get16F ( const ivec2 & coord, vec4 & p ) #

Arguments

float get16F ( const ivec2 & coord ) #

Arguments

Return value

void get32F ( const ivec2 & coord, vec4 & p ) #

Arguments

float get32F ( const ivec2 & coord ) #

Arguments

Return value

void set2D ( int x, int y, float r, float g, float b, float a, variable color ) #

Arguments

get2DArray ( int x, int y, int layer ) #

Arguments

Return value

int is2DType ( ) #

Return value

void set3D ( int x, int y, int z, float r, float g, float b, float a ) #

Arguments

get3D ( float x, float y, float z ) #

Arguments

Return value

get3D ( int x, int y, int z ) #

Arguments

Return value

int is3DType ( ) #

Return value

int isArrayType ( ) #

Return value

int getBlockSize ( ) #

Return value

int isCombinedFormat ( ) #

Return value

int isCombinedFormat ( int format ) #

Arguments

Return value

int isCompressedFormat ( ) #

Return value

int isCompressedFormat ( int format ) #

Arguments

Return value

void setCube ( int x, int y, int face ) #

Arguments

getCube ( float x, float y, int face ) #

Arguments

Return value

getCube ( int x, int y, int face, vec3 direction ) #

Arguments

Return value

void setCubeArray ( int x, int y, int face, int layer ) #

Arguments

getCubeArray ( int layer ) #

Arguments

Return value

getCubeArray ( int v1, int v2, int face, int layer ) #

Arguments

Return value

getCubeArray ( float v1, float v2, int face, int layer ) #