This page has been translated automatically.
Видеоуроки
Интерфейс
Основы
Продвинутый уровень
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Профессиональный уровень (SIM)
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Контроль версий
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Sandworm
Использование инструментов редактора для конкретных задач
Расширение функционала редактора
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World-ноды
Звуковые объекты
Объекты поиска пути
Player-ноды
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Плагины
Форматы файлов
Материалы и шейдеры
Rebuilding the Engine Tools
Интерфейс пользователя (GUI)
VR Development
Двойная точность координат
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Сэмплы материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Учебные материалы

Unigine::ImageConverter Class

Header: #include <UnigineImage.h>

This class is used to define the convertation parameters required for the image at the import.

ImageConverter Class

Enums

MIPMAPS_MODE#

ИмяОписание
MIPMAPS_MODE_DISABLE = 0Mipmaps are not generated.
MIPMAPS_MODE_POINT = 1Point filtering method is used at mipmap generation.
MIPMAPS_MODE_LINEAR = 2Linear filtering method is used at mipmap generation.
MIPMAPS_MODE_BLUR = 3Blurring is applied at mipmap generation.
MIPMAPS_MODE_SHARPEN = 4Sharpening is applied at mipmap generation.
MIPMAPS_MODE_COMBINED = 5Combination of the loaded 2D image with the most detailed mipmap image.
MIPMAPS_MODE_GGX = 6Generation of mipmaps for cubemap images (IMAGE_CUBE or IMAGE_CUBE_ARRAY) using GGX BRDF microfacet model.

RESOLUTION_MODE#

ИмяОписание
RESOLUTION_MODE_AUTO = 0Resolution set by the converter depending on the image format (for example, the 2D image is converted to 2D array / 3D image).
RESOLUTION_MODE_ORIGINAL = 1Resolution of the original image.
RESOLUTION_MODE_MANUAL = 2Resolution set manually in the converter.

COMPRESSION_QUALITY#

ИмяОписание
COMPRESSION_QUALITY_LOW = 0Low quality of compression.
COMPRESSION_QUALITY_HIGH = 1High quality of compression.

RESIZE_FILTER#

ИмяОписание
RESIZE_FILTER_POINT = 0Point filtering method used for resizing.
RESIZE_FILTER_LINEAR = 1Linear filtering method used for resizing.
RESIZE_FILTER_MIN = 2Minimum filtering method used for resizing.

RANGE_MODE#

ИмяОписание
RANGE_MODE_DISABLE = 0Image values are not normalized.
RANGE_MODE_NORMALIZE = 1Values in all channels of the image are normalized altogeter to the values from 0 to 1 (i.e. overall brightness of the image). Recommended to be used for colors.
RANGE_MODE_NORMALIZE_PER_CHANNEL = 2Normalization to the values from 0 to 1 is performed for each channel of the image separately.
RANGE_MODE_MANUAL = 3Normalization to manually set values is performed.

Members


ImageConverter ( ) #

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

ImageConverter ( const Ptr<ImageConverter> & imageconverter ) #

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

Arguments

  • const Ptr<ImageConverter> & imageconverter - Source image converter.

void setType ( int type ) #

Sets a numerical code of the image type.

Arguments

int getType ( ) const#

Returns a numerical code of the image type.

Return value

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

void setFormat ( int format ) #

Sets a numerical code of the image format.

Arguments

  • int format - The numerical code of the image format. See the FORMAT_* variables.

int getFormat ( ) const#

Returns a numerical code of the image format.

Return value

The numerical code of the image format. See the FORMAT_* variables.

void setResolutionMode ( ImageConverter::RESOLUTION_MODE mode ) #

Sets the resolution mode to be used for the image.

Arguments

ImageConverter::RESOLUTION_MODE getResolutionMode ( ) const#

Returns the resolution mode used for the image.

Return value

The resolution mode used for the image. One of the RESOLUTION_MODE values.

void setResizeFilter ( ImageConverter::RESIZE_FILTER filter ) #

Sets the resize filter to be used for the image.

Arguments

ImageConverter::RESIZE_FILTER getResizeFilter ( ) const#

Returns the resize filter used for the image.

Return value

The resize filter used for the image. One of the RESIZE_FILTER values.

void setWidth ( int width ) #

Sets the image width, in pixels.

Arguments

  • int width - The image width, in pixels.

int getWidth ( ) const#

Returns the image width, in pixels.

Return value

The image width, in pixels.

void setHeight ( int height ) #

Sets the image height, in pixels.

Arguments

  • int height - The image height, in pixels.

int getHeight ( ) const#

Returns the image height, in pixels.

Return value

The image height, in pixels.

void setDepth ( int depth ) #

Sets the image depth, in pixels.

Arguments

  • int depth - The image depth, in pixels.

int getDepth ( ) const#

Returns the image depth, in pixels.

Return value

The image depth, in pixels.

void setFileCompression ( Image::FILE_COMPRESSION compression ) #

Sets the image file compression type.

Arguments

Image::FILE_COMPRESSION getFileCompression ( ) const#

Returns the image file compression type.

Return value

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

void setCompressionQuality ( ImageConverter::COMPRESSION_QUALITY quality ) #

Sets the image file compression quality.

Arguments

ImageConverter::COMPRESSION_QUALITY getCompressionQuality ( ) const#

Returns the image file compression quality.

Return value

The compression quality used for the image. One of the COMPRESSION_QUALITY_* values.

void setGPUCompression ( bool compression ) #

Defines if GPU compression is used at converting the image.

Arguments

  • bool compression - true to enable image compression on GPU, or false to disable it.

bool isGPUCompression ( ) const#

Returns the value specifying if GPU compression is used at converting the image.

Return value

true if GPU compression is enabled; otherwise, false.

void setMipmapsMode ( ImageConverter::MIPMAPS_MODE mode ) #

Sets the filtering type for the image mipmaps.

Arguments

ImageConverter::MIPMAPS_MODE getMipmapsMode ( ) const#

Returns the filtering type set for the image mipmaps.

Return value

The mipmaps mode to be used. One of the MIPMAPS_MODE_* values.

void setMipmapsGamma ( float gamma ) #

Sets the gamma correction value to be used for the mipmaps.

Arguments

  • float gamma - The gamma correction value to be used for the mipmaps.

float getMipmapsGamma ( ) const#

Returns the gamma correction value used for the mipmaps.

Return value

The gamma correction value used for the mipmaps.

void setMipmapsFilterIntensity ( float intensity ) #

Sets the filter intensity value to be used for the mipmaps.

Arguments

  • float intensity - The filter intensity value used for the mipmaps.

float getMipmapsFilterIntensity ( ) const#

Returns the filter intensity value used for the mipmaps.

Return value

The filter intensity value used for the mipmaps.

void setMipmapsFilterRadius ( float radius ) #

Sets the radius to be used for the mipmaps filtering.

Arguments

  • float radius - The filter radius value.

float getMipmapsFilterRadius ( ) const#

Returns the radius used for the mipmaps filtering.

Return value

The filter radius value.

void setMipmapsSharpOnlyLightness ( bool lightness ) #

Sets the value specifying if sharpness is applied to the HSL lightness value of the mipmap only.

Arguments

  • bool lightness - true to adjust sharpness of the lightness value only, or false to sharpen all HSL values.

bool isMipmapsSharpOnlyLightness ( ) const#

Returns the value specifying if sharpness is applied to the HSL lightness value of the mipmap only.

Return value

true if sharpness is adjusted for the lightness value only, or false if sharpness affects all HSL values.

void setGGXMipmapsQuality ( Image::GGX_MIPMAPS_QUALITY quality ) #

Sets the quality for mipmaps generated for cubemap images using the GGX BRDF microfacet model. The value is applied when the mipmap mode is set to GGX.

Arguments

Image::GGX_MIPMAPS_QUALITY getGGXMipmapsQuality ( ) const#

Returns the quality of mipmaps generated for cubemap images using the GGX BRDF microfacet model.

Return value

The quality of the GGX mipmaps for the cubemap image. One of the Image::GGX_MIPMAPS_QUALITY values.

void setRangeMode ( ImageConverter::RANGE_MODE mode ) #

Sets the range mode to be applied at the image conversion.

Arguments

ImageConverter::RANGE_MODE getRangeMode ( ) const#

Returns the range mode applied at the image conversion.

Return value

The range mode applied at the image conversion. One of the RANGE_MODE_* values.

void setRange ( int channel, const Math::dvec4 & value ) #

Sets the range to be applied at the image conversion.
Notice
The range of the final image will be clamped, if the set range values exceed the maximum values of the image conversion format.

Arguments

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

Math::dvec4 getRange ( int channel ) const#

Returns the range to be applied at the image conversion.

Arguments

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

Return value

Range values: x and y coordinates of the value specify the original range, z and w specify the range to which the image will be converted.

void setFlipX ( bool flipx ) #

Flips the image horizontally.

Arguments

  • bool flipx - true if the image is to be flipped horizontally; otherwise, false.

bool isFlipX ( ) const#

Returns the value indicating if the image is to be flipped horizontally.

Return value

true if the image is to be flipped horizontally; otherwise, false.

void setFlipY ( bool flipy ) #

Flips the image vertically.

Arguments

  • bool flipy - true if the image is to be flipped vertically; otherwise, false.

bool isFlipY ( ) const#

Returns the value indicating if the image is to be flipped vertically.

Return value

true if the image is to be flipped vertically; otherwise, false.

void setBlur ( int blur ) #

Sets the amount of blur in pixels.

Arguments

  • int blur - The amount of blur in pixels.

int getBlur ( ) const#

Returns the amount of blur in pixels.

Return value

The amount of blur in pixels.

void setRotate ( int rotate ) #

Sets the image rotation angle.

Arguments

  • int rotate - The rotation angle, clock-wise.

int getRotate ( ) const#

Returns the image rotation angle.

Return value

The rotation angle, clock-wise.

bool getInvertChannel ( int channel ) #

Returns the value indicating if the channel needs to be inverted.

Arguments

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

Return value

true if the channel needs to be inverted; otherwise, false.

void setInvertChannel ( int channel, bool value ) #

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 - The number of the channel to be inverted, in the range from 0 to the total number of channels.
  • bool value - true if the channel needs to be inverted; otherwise, false.

void reset ( ) #

Sets the converter to the default values.

void copy ( Ptr<ImageConverter> & converter ) const#

Copies data from the specified source converter.

Arguments

  • Ptr<ImageConverter> & converter - The source converter.

Ptr<ImageConverter> clone ( ) const#

Creates a clone of the specified source converter.

Return value

The converter to be cloned.

bool load ( const char * path ) #

Loads the image converter settings on the disk using the specified path.

Arguments

  • const char * path - The path to the file with the image converter settings.

Return value

true if the image converter settings are loaded successfully; otherwise, false.

void load ( const Ptr<Json> & json ) #

Loads the .json object with the image converter settings.

Arguments

  • const Ptr<Json> & json - The object with the image converter settings.

bool save ( const char * path ) const#

Saves image converter settings on the disk to the specified location.

Arguments

  • const char * path - The path to the file to store the image converter settings.

Return value

true if the image converter settings are saved successfully; otherwise, false.

void save ( const Ptr<Json> & json ) const#

Saves image converter settings to the specified .json object.

Arguments

  • const Ptr<Json> & json - The object with the image converter settings.

void updateParameters ( const Ptr<Image> & image ) #

Validates the parameters of the image converter for the specified image. This method allows checking the resulting parameters before converting the image.

Arguments

  • const Ptr<Image> & image - The image to be converted.

bool runCpu ( Ptr<Image> & image ) #

Runs the image converter on CPU.

Arguments

  • Ptr<Image> & image - The image to be converted.

Return value

true if the image has been converted successfully; otherwise, false.

bool run ( CallbackBase1<Ptr<Image>> * on_converted, const Ptr<Image> & image ) #

Runs the image converter.

Arguments

Return value

true if the image has been converted successfully; otherwise, false.
Last update: 06.02.2024
Build: ()