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)
Двойная точность координат
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
VR-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Учебные материалы

Unigine::Render Class

Header: #include <UnigineRender.h>

Provides access to Unigine rendering functions. For example, it is used by Wall application to render onto multiple monitors.

See AlsoSee Also#

  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/rendering/ folder

Render Class

Перечисления (Enums)

PASS#

ИмяОписание
PASS_WIREFRAME = 0Wireframe pass.
PASS_VISUALIZER_SOLID = 1Visualizer pass.
PASS_DEFERRED = 2Deferred pass.
PASS_AUXILIARY = 3Auxiliary pass.
PASS_EMISSION = 4Emission pass.
PASS_REFRACTION = 5Refraction pass.
PASS_TRANSPARENT_BLUR = 6Transparent blur pass.
PASS_AMBIENT = 7Ambient pass.
PASS_LIGHT_VOXEL_PROBE = 8Light voxel probe pass.
PASS_LIGHT_ENVIRONMENT_PROBE = 9Light environment probe pass.
PASS_LIGHT_PLANAR_PROBE = 10Light planar probe pass.
PASS_LIGHT_OMNI = 11Omni light pass.
PASS_LIGHT_PROJ = 12Proj light pass.
PASS_LIGHT_WORLD = 13World light pass.
PASS_SHADOW = 14Shadow pass.
PASS_DEPTH_PRE_PASS = 15Depth pre-pass.
PASS_MS_DEPTH = 16MS depth pass.
PASS_POST = 17Post materials pass.
PASS_LIGHTMAP_DATA = 18Lightmap data rendering pass.
PASS_PROCEDURAL_DECALS = 19Pass for rendering of particles into procedural textures to be used by orthographic decals.
PASS_PROCEDURAL_FIELDS = 20Pass for rendering of particles into procedural textures to be used by height fields.
PASS_MIXED_REALITY_BLEND_MASK_COLOR = 21Pass for rendering the blend mask for mixed reality.
PASS_CUSTOM_0 = 22Custom pass (unassigned).
PASS_CUSTOM_1 = 23Custom pass (unassigned).
PASS_CUSTOM_2 = 24Custom pass (unassigned).
PASS_CUSTOM_3 = 25Custom pass (unassigned).
PASS_CUSTOM_4 = 26Custom pass (unassigned).
PASS_CUSTOM_5 = 27Custom pass (unassigned).
PASS_CUSTOM_6 = 28Custom pass (unassigned).
PASS_CUSTOM_7 = 29Custom pass (unassigned).
PASS_CUSTOM_8 = 30Custom pass (unassigned).
PASS_CUSTOM_9 = 31Custom pass (unassigned).
PASS_CUSTOM_10 = 32Custom pass (unassigned).
PASS_CUSTOM_11 = 33Custom pass (unassigned).
PASS_CUSTOM_12 = 34Custom pass (unassigned).
PASS_CUSTOM_13 = 35Custom pass (unassigned).
PASS_CUSTOM_14 = 36Custom pass (unassigned).
PASS_CUSTOM_15 = 37Custom pass (unassigned).
PASS_CUSTOM_16 = 38Custom pass (unassigned).
PASS_CUSTOM_17 = 39Custom pass (unassigned).
PASS_CUSTOM_18 = 40Custom pass (unassigned).
PASS_CUSTOM_19 = 41Custom pass (unassigned).
PASS_CUSTOM_20 = 42Custom pass (unassigned).
PASS_CUSTOM_21 = 43Custom pass (unassigned).
PASS_CUSTOM_22 = 44Custom pass (unassigned).
PASS_CUSTOM_23 = 45Custom pass (unassigned).
PASS_CUSTOM_24 = 46Custom pass (unassigned).
PASS_CUSTOM_25 = 47Custom pass (unassigned).
PASS_CUSTOM_26 = 48Custom pass (unassigned).
PASS_CUSTOM_27 = 49Custom pass (unassigned).
PASS_CUSTOM_28 = 50Custom pass (unassigned).
PASS_CUSTOM_29 = 51Custom pass (unassigned).
PASS_CUSTOM_30 = 52Custom pass (unassigned).
PASS_CUSTOM_31 = 53Custom pass (unassigned).
PASS_CUSTOM_32 = 54Custom pass (unassigned).
NUM_PASSES = 55Total number of rendering passes.

GGX_MIPMAPS_QUALITY#

Quality of GGX mipmaps for environment reflections on rough surfaces.
ИмяОписание
GGX_MIPMAPS_QUALITY_LOW = 0Low quality of GGX mipmaps.
GGX_MIPMAPS_QUALITY_MEDIUM = 1Medium quality of GGX mipmaps.
GGX_MIPMAPS_QUALITY_HIGH = 2High quality of GGX mipmaps.
GGX_MIPMAPS_QUALITY_ULTRA = 3Ultra quality of GGX mipmaps.

STREAMING_MESHES_PREFETCH#

ИмяОписание
STREAMING_MESHES_PREFETCH_DISABLE = 0Asynchronous pre-loading of meshes is disabled.
STREAMING_MESHES_PREFETCH_RADIUS = 1Asynchronous pre-loading of meshes is enabled within a certain radius.
STREAMING_MESHES_PREFETCH_FULL = 2Asynchronous pre-loading of all meshes is enabled.

STREAMING_MESHES#

ИмяОписание
STREAMING_MESHES_ASYNC = 0Asynchronous streaming of meshes.
STREAMING_MESHES_FORCE = 1Force-loading of meshes.
STREAMING_MESHES_ALL = 2Loading of all meshes.

STREAMING_TEXTURES#

ИмяОписание
STREAMING_TEXTURES_ASYNC = 0Asynchronous streaming of textures.
STREAMING_TEXTURES_FORCE = 1Force-loading of textures.

SHOW_TEXTURE_RESOLUTION_UV#

ИмяОписание
SHOW_TEXTURE_RESOLUTION_UV_MODE_0 = 0UV Channel 0 is used for visualization of the texture resolution.
SHOW_TEXTURE_RESOLUTION_UV_MODE_1 = 1UV Channel 1 is used for visualization of the texture resolution.

SHOW_TEXTURE_RESOLUTION#

ИмяОписание
SHOW_TEXTURE_RESOLUTION_DISABLED = 0Texture resolution rendering mode is disabled.
SHOW_TEXTURE_RESOLUTION_BY_MAX_PIXEL_COUNT = 1Surfaces are colored depending on maximum resolution of textures used in materials assigned to them in accordance with the scale.
SHOW_TEXTURE_RESOLUTION_BY_SCREEN_SIZE = 2Surfaces are colored to display the relationship between maximum texture resolution of the material to the size of triangles on the screen to which it is applied: blue indicates insufficient texture resolution, while yellow tells that it is excessive, if the color is green - everything is ok.

SHOW_IMMOVABLE#

ИмяОписание
SHOW_IMMOVABLE_DISABLED = 0Do not display geometry with or without the Immovable option.
SHOW_IMMOVABLE_OPTION_ENABLED = 1Display geometry with the Immovable option enabled.
SHOW_IMMOVABLE_OPTION_DISABLED = 2Display geometry with the Immovable option disabled.

SHOW_VERTEX_COLOR#

ИмяОписание
SHOW_VERTEX_COLOR_DISABLED = 0Displaying of vertex colors is disabled.
SHOW_VERTEX_COLOR_RED = 1Display geometry that uses the red vertex color channel.
SHOW_VERTEX_COLOR_GREEN = 2Display geometry that uses the green vertex color channel.
SHOW_VERTEX_COLOR_BLUE = 3Display geometry that uses the blue vertex color channel.
SHOW_VERTEX_COLOR_ALPHA = 4Display geometry that uses the alpha vertex color channel.
SHOW_VERTEX_COLOR_RGB = 5Display geometry that uses RGB vertex color channels.

TONEMAPPER#

Tone mapping mode.
ИмяОписание
TONEMAPPER_FILMIC = 0Filmic - basic customizable filmic tone mapping mode.
TONEMAPPER_ACES = 1ACES - tone mapping in accordance with the industry standard set by the Academy Color Encoding System (ACES) for television and film.
TONEMAPPER_MIX_ACES_WITH_REINHARD = 2Mix ACES With Reinhard - Combination of ACES and Reinhard tone mapping.
TONEMAPPER_REINHARD = 3Reinhard - Simple Reinhard. C/(1+C) formula applied to each of the channels. May cause slight desaturation.
TONEMAPPER_REINHARD_LUMA_BASED = 4Reinhard Luma-Based - Luma-based Reinhard tone mapping, applied to luminance only. More accurate representation of colors.

VIEWPORT_MODE#

ИмяОписание
VIEWPORT_MODE_DEFAULT = 0Enables the default stereo mode - no stereo and panoramic rendering in the current viewport is available. This mode is set by default for a new viewport.
VIEWPORT_MODE_PANORAMA_CURVED_180 = 1Enables rendering of the viewport as a panorama with curved edges with an angle of 180 degrees.
VIEWPORT_MODE_PANORAMA_CURVED_360 = 2Enables rendering of the viewport as a panorama with curved edges with an angle of 360 degrees.
VIEWPORT_MODE_PANORAMA_LINEAR_180 = 3Enables rendering of the viewport as a linear panorama without distortion at the edges with an angle of 180 degrees.
VIEWPORT_MODE_PANORAMA_LINEAR_360 = 4Enables rendering of the viewport as a linear panorama without distortion at the edges with an angle of 360 degrees.
VIEWPORT_MODE_PANORAMA_FISHEYE_ORTHOGRAPHIC = 5Enables rendering of the viewport as an orthographic spherical panorama (fisheye).
VIEWPORT_MODE_PANORAMA_FISHEYE_EQUDISTANT = 6Enables rendering of the viewport as an equidistant spherical panorama (fisheye).
VIEWPORT_MODE_PANORAMA_FISHEYE_STEREOGRAPHIC = 7Enables rendering of the viewport as an stereographic spherical panorama (fisheye).
VIEWPORT_MODE_PANORAMA_FISHEYE_EQUISOLID = 8Enables rendering of the viewport as an equisolid spherical panorama (fisheye).
VIEWPORT_MODE_STEREO_ANAGLYPH = 9Enables the anaglyph stereo mode that is viewed with red-cyan anaglyph glasses.
VIEWPORT_MODE_STEREO_INTERLACED = 10Enables the interlaced stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
VIEWPORT_MODE_STEREO_HORIZONTAL = 11Enables the horizontal stereo mode that is supported on mobile devices.
VIEWPORT_MODE_STEREO_VERTICAL = 12Enables the vertical stereo mode that is supported on mobile devices.
VIEWPORT_MODE_STEREO_SEPARATE = 13Enables the replicate images stereo mode.
VIEWPORT_MODE_STEREO_REPLICATE = 14Enables the separate images stereo mode. This mode serves to output two separate images for each of the eye. It can be used with any VR/AR output devices that support separate images output, e.g. for 3D video glasses or helmets (HMD).

VSYNC#

ИмяОписание
VSYNC_DISABLE = 0Vertical FPS synchronization is disabled.
VSYNC_STRICT = 1Strict vertical FPS synchronization.
VSYNC_ADAPTIVE = 2Adaptive vertical FPS synchronization (OpenGL only).

SHOW_LIGHTING_MODE#

ИмяОписание
SHOW_LIGHTING_MODE_DISABLED = 0Displaying of lighting mode is disabled.
SHOW_LIGHTING_MODE_STATIC = 1Displaying of surfaces for which static lighting mode is enabled.
SHOW_LIGHTING_MODE_DYNAMIC = 2Displaying of surfaces for which dynamic lighting mode is enabled.
SHOW_LIGHTING_MODE_ADVANCED = 3Displaying of surfaces for which advanced lighting mode is enabled.

SHADERS_COMPILE_MODE#

ИмяОписание
SHADERS_COMPILE_MODE_ASYNC = 0Asynchronous shaders compilation mode.
SHADERS_COMPILE_MODE_FORCE = 1Forced shaders compilation mode.

EXPOSURE_MODE#

ИмяОписание
EXPOSURE_MODE_DISABLED = 0Static exposure mode. The amount of luminance is determined by the Exposure (см. setExposure()) depending on the Camera Mode (см. setCameraMode()) parameter.
EXPOSURE_MODE_LOGARITHMIC = 1Exposure mode based on the adaptive logarithmic mapping technique.
EXPOSURE_MODE_QUADRATIC = 2Exposure mode based on the adaptive quadratic mapping technique.
EXPOSURE_MODE_CURVE_BASED = 3Exposure mode based on the adaptive curve mapping technique.

CAMERA_MODE#

ИмяОписание
CAMERA_MODE_CLASSIC = 0Camera mode with the exposure set by the Exposure value (см. setExposure()).
CAMERA_MODE_PHYSICALLY_BASED = 1Camera mode with the real-world values used to set up lighting and camera exposure: ISO (см. setISO()), shutter speed (см. setShutterSpeed()), F-stop (см. setFStop()). With the default values of these parameters, the static exposure value is near 1. The exposure mode (см. setExposureMode()) should be set to Static to avoid exposure issues.

RENDER_API#

ИмяОписание
API_NULL = 0Null API name.
API_OPENGL = 1OpenGL API.
API_DIRECT3D11 = 2DIRECT3D 11 API.
API_DIRECT3D12 = 3DIRECT3D 12 API.
API_VULKAN = 4VULKAN API.

Члены класса

void setEnabled ( bool ena