Image Class

Image Class

Members

static Image ( ) #

static Image ( string name ) #

Arguments

• string name - Image file name.

int allocData ( int clear = true ) #

Arguments

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

Return value

void clearData ( ) #

int set ( int channel, int value ) #

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

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

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

Arguments

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

Return value

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

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

Arguments

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

Return value

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

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

Arguments

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

Return value

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

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 ( Variable x, Variable y, int layer ) #

Arguments

• Variable 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.
• Variable 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 - X integer coordinate of a pixel in range [0; width].

Return value

int is2DType ( ) #

Return value

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

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

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

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

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

int is3DType ( ) #

Return value

int isArrayType ( ) #

Return value

int isBCCompressedFormat ( ) #

Return value

int isBCCompressedFormat ( int format ) #

Arguments

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

Return value

int getBlockSize ( ) #

Return value

int isCombinedFormat ( ) #

Return value

int isCombinedFormat ( int format ) #

Arguments

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

Return value

int isCompressedFormat ( ) #

Return value

int isCompressedFormat ( int format ) #

Arguments

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

Return value

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

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

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

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

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

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

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

Arguments

• int layer - Image layer number.

Return value

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

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

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

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

int isCubeType ( ) #

Return value

int getDepth ( int level = 0 ) #

Arguments

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

Return value

int isFloatFormat ( ) #

Return value

int isFloatFormat ( int format ) #

Arguments

• int format - Image format identifier. See the IMAGE_FORMAT_* variables.

Return value

int getFormat ( ) #

Return value

static int getFormat ( int num_channels, int format ) #

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

string getFormatName ( ) #

Return value

string getFormatName ( int format ) #

Arguments

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

Return value

int isHalfFormat ( ) #

Return value

int isHalfFormat ( int format ) #

Arguments

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

Return value

int getHeight ( int level = 0 ) #

Arguments

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

Return value

int isLoaded ( ) #

Return value

int getNumChannels ( ) #

Return value

int getNumFaces ( ) #

Return value

int getNumLayers ( ) #

Return value

int getNumMipmaps ( ) #

Return value

int getOffset ( int level ) #

Arguments

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

Return value

void getPixels ( ) #

Arguments

int getPixelSize ( ) #

Return value

static int getPixelsSize ( int format, int w, int h ) #

Arguments

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

Return value

int getPixelsSize ( ) #

Return value

int isRawFormat ( ) #

Return value

int isRawFormat ( int format ) #

Arguments

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

Return value

int getSize ( ) #

Return value

int getSize ( int level ) #

Arguments

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

Return value

int getStride ( int level = 0 ) #

Arguments

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

Return value

int getDepthStride ( int level = 0 ) #

Arguments

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

Return value

int getType ( ) #

Return value

string getTypeName ( ) #

Return value

static string getTypeName ( int type ) #

Arguments

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

Return value

int isUCharFormat ( ) #

Return value

int isUCharFormat ( int format ) #

Arguments

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

Return value

int isUShortFormat ( ) #

Return value

int isUShortFormat ( int format ) #

Arguments

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

Return value

int getWidth ( int level = 0 ) #

Arguments

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

Return value

int isZCompressedFormat ( ) #

Return value

• FORMAT_ZLC1
• FORMAT_ZLC2

int isZCompressedFormat ( int format ) #

Arguments

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

Return value

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

• 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

int blur ( int size ) #

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

void clear ( ) #

int combine ( int new_format = -1 ) #

• 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

int combineMipmaps ( ) #

Return value

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

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

int compress ( int new_format = -1 ) #

• 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

int convertToFormat ( int new_format ) #

Converts the image to a specified format. The following variants of conversion are possible:

Arguments

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

Return value

int convertToType ( int type ) #

Arguments

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

Return value

int assignFrom ( const Image & src_image ) #

Arguments

• const Image & src_image - Source image.

Return value

int resizeFrom ( const Image & src_image ) #

Arguments

• const Image & src_image - Source image.

Return value

int copy ( const Image & src_image, int layer ) #

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

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

Arguments

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

Return value

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool createMipmaps ( int filter = FILTER_LINEAR, float gamma = 1.0f ) #

Arguments

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

Return value

int removeMipmaps ( ) #

Return value

int decombine ( ) #

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

Return value

int decombineMipmaps ( ) #

Return value

int decompress ( ) #

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

Return value

int extrude ( int pixels ) #

Arguments

• int pixels - Number of contour pixels.

Return value

int flipX ( ) #

Return value

int flipY ( ) #

Return value

int hasMipmaps ( ) #

Return value

int info ( string file ) #

Arguments

• string file - Name of the image file. The following file formats are supported: PSD, TGA, JPG, PNG, DDS.

Return value

int invert ( ) #

Return value

int load ( string file, int offset ) #

Arguments

• string file - Name of the image file. The following file formats are supported: DDS.
• int offset - Mipmap offset.

Return value

int load ( string file ) #

Arguments

• string file - Name of the image file.

Return value

int load ( string file, int min_mip, int max_mip ) #

Arguments

• string file - Name of the image file to be loaded. The following file formats are supported: DDS.
• int min_mip
• int max_mip

Return value

int normalize ( ) #

Return value

bool resize ( int new_width, int new_height, int filter = FILTER_LINEAR ) #

Arguments

• int new_width - New image width.
• int new_height - New image height.
• int filter - Quality setting, accepts one of the FILTER_* values.

Return value

int rotate ( int angle ) #

Arguments

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

Return value

bool save ( ) #

Arguments

Return value

bool save ( float quality ) #

• DDS
• JPG
• PNG
• PSD
• TGA

Arguments

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

Return value

int sign ( ) #

Return value

int swap ( int channel, int index ) #

Arguments

• int channel
• int index

Return value

void swap ( Image image ) #

Arguments

• Image image - Source image.

Pixel toPixel ( int format, const vec4 & color ) #

Arguments

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

Return value

vec4 toVec4 ( int format, Pixel p ) #

Arguments

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

Return value

int getNumChannels ( int format ) #

Arguments

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

Return value

int getPixelSize ( int format ) #

Arguments

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

Return value

int getBlockSize ( int format ) #

Arguments

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

Return value

int getDepth ( ) #

Return value

int getHeight ( ) #

Return value

int getWidth ( ) #

Return value