engine.render Functions

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.

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

Methods:

Name	Description View: Sort by:
getNumTriangles	Returns number of rendered per frame triangles that can be currently seen in the viewport.
getNumSurfaces	Returns number of rendered per frame surfaces that can be currently seen in the viewport (in all rendering passes).
getNumShadows	Returns number of shadow passes rendered per frame.
getNumShaders	Returns number of shaders set per frame.
getNumReflections	Returns number of reflections drawn per frame that can be currently seen in the viewport.
getNumPrimitives	Returns number of geometric rendered per frame primitives that can be currently seen in the viewport.
getNumMaterials	Returns number of materials set per frame (during all of the rendering passes) in the current scene.
getNumLights	Returns number of light passes rendered per frame.
getNumDips	Returns Returns the number of draw calls used in the current scene.
getNumDecals	Returns number of rendered per frame decals that can be currently seen in the viewport (during all of the rendering passes).
getGray2DArrayTexture	Returns gray 2D array texture.
getGrayCubeTexture	Returns gray cube texture.
getGray3DTexture	Returns gray 3D texture.
getGray2DTexture	Returns gray 2d texture.
getWhite2DArrayTexture	Returns white 2d array texture.
getWhiteCubeTexture	Returns white cube texture.
getWhite3DTexture	Returns white 3d texture.
getWhite2DTexture	Returns white 2d texture.
getBlack2DArrayTexture	Returns black 2d array texture.
getBlackCubeTexture	Returns black cube texture.
getBlack3DTexture	Returns black 3d texture.
getBlack2DTexture	Returns black 2d texture.
getHDRTextureFormat	Returns HDR texture format to be used.
void setShowLightmapChecker	Setter and Getter for value indicating whether the Baked Lightmap Checker debug mode is enabled.
getShowLightmapChecker
void setShowTriangles	Setter and Getter for wireframe mode for scene triangles.
getShowTriangles	Setter and Getter for wireframe mode for scene triangles.
void setShowTexturesNumber	Setter and Getter for number of buffers in a row and column displayed in the full view mode (see the setShowTextures() method) .
getShowTexturesNumber
void setShowTexturesOffset	Setter and Getter for number of the buffer to start displaying from in the full view mode.
getShowTexturesOffset
void setShowTextures	Setter and Getter for display mode for texture buffers used by the renderer.
getShowTextures
void setShowGeodeticPivot	Setter and Getter for value indicating whether geodetic pivots are displayed.
getShowGeodeticPivot
void setShowAmbient	Setter and Getter for value indicating whether the ambient pass buffer is displayed.
getShowAmbient
void setShowTransparent	Setter and Getter for value indicating whether the visualizer is displayed for transparent objects.
getShowTransparent
void setShowDynamic	Setter and Getter for value indicating whether the visualizer is displayed for dynamic objects.
getShowDynamic
void setShowAlphaTest	Setter and Getter for value indicating whether the visualizer is displayed for transparent objects using alpha test.
getShowAlphaTest
void setShowCascades	Setter and Getter for value indicating whether Parallel Split Shadow Map - world shadow cascades are displayed.
getShowCascades
void setShowOccluder	Setter and Getter for value indicating whether the buffer used for occluders is displayed in the viewport.
getShowOccluder
void setShowScissors	Setter and Getter for value indicating if scissor rectangles are displayed.
getShowScissors
void setShowDecals	Setter and Getter for value indicating whether the visualizer is displayed for decals or not.
getShowDecals
void setShowQueries	Setter and Getter for value indicating whether occlusion query boxes are displayed in the viewport or not.
getShowQueries
void setTransparentMultipleEnvProbes	Setter and Getter for value indicating if the transparent multiple environment probes pass is rendered.
getTransparentMultipleEnvProbes
void setTransparentDeferred	Setter and Getter for value indicating if the deferred pass for transparent objects is enabled.
getTransparentDeferred
void setTransparentLight	Setter and Getter for value indicating if the transparent light pass is rendered.
getTransparentLight
void setTransparentAmbient	Setter and Getter for value indicating if the transparent ambient pass is rendered.
getTransparentAmbient
void setTransparentEnabled	Setter and Getter for value indicating if the transparent pass is rendered.
getTransparentEnabled
void setScreenSpaceEffects	Setter and Getter for value indicating if rendering of screen-space effects is enabled.
getScreenSpaceEffects
void setFieldShorelineResolution	Setter and Getter for resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
getFieldShorelineResolution
void setFieldPrecision	Setter and Getter for value indicating the precision of textures used for field objects.
getFieldPrecision
void setFieldHeightResolution	Setter and Getter for resolution of the texture into which all textures set for all FieldHeight objects are rendered.
getFieldHeightResolution
void setCloudsNoiseStepSkip	Setter and Getter for value of the noise step skip parameter for clouds.
getCloudsNoiseStepSkip
void setCloudsNoiseLighting	Setter and Getter for value of the noise lighting parameter for the clouds.
getCloudsNoiseLighting
void setCloudsNoiseIterations	Setter and Getter for value of the noise iterations parameter for clouds.
getCloudsNoiseIterations
void setCloudsNoiseStep	Setter and Getter for value of the noise step parameter for clouds.
getCloudsNoiseStep
void setCloudsSoftIntersection	Setter and Getter for soft intersection distance for clouds, in meters.
getCloudsSoftIntersection
void setCloudsSamplesCount	Setter and Getter for number of samples used for clouds rendering.
getCloudsSamplesCount
void setCloudsDownsamplingRendering	Setter and Getter for downsampling rendering mode for clouds.
getCloudsDownsamplingRendering
void setCloudsInterleavedRendering	Setter and Getter for interleaved rendering mode for clouds.
getCloudsInterleavedRendering
void setCloudsDynamicCoverageResolution	Setter and Getter for the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels.
getCloudsDynamicCoverageResolution
void setCloudsDynamicCoverageArea	Setter and Getter for dynamic coverage area for clouds, in units.
getCloudsDynamicCoverageArea
void setCloudsLightingConeRadius	Setter and Getter for lighting cone sampling radius for clouds lighting.
getCloudsLightingConeRadius
void setCloudsLightingTraceLength	Setter and Getter for lighting trace length for clouds.
getCloudsLightingTraceLength	Setter and Getter for lighting trace length for clouds.
void setCloudsSamplingQuality	Setter and Getter for sampling quality for clouds.
getCloudsSamplingQuality	Setter and Getter for sampling quality for clouds.
void setCloudsLightingQuality	Setter and Getter for lighting quality for clouds.
getCloudsLightingQuality	Setter and Getter for lighting quality for clouds.
void setCloudsGroundShadows	Setter and Getter for value indicating if rendering of shadows from the clouds on the ground is enabled.
getCloudsGroundShadows
void setCloudsEnabled	Setter and Getter for value indicating if rendering of clouds is enabled.
getCloudsEnabled
void setCloudsStepAccuracy	Setter and Getter for accuracy of ray marching steps.
getCloudsStepAccuracy	Setter and Getter for accuracy of ray marching steps.
void setCloudsAccurateLayersSorting	Setter and Getter for value indicating if correct sorting of intersecting cloud layers is enabled.
getCloudsAccurateLayersSorting
void setCloudDistortionTexture	Setter and Getter for value indicating which texture type is currently used for clouds distortion.
getCloudDistortionTexture
void setCloudsInterleavedRenderingTemporal	Setter and Getter for value indicating if temporal accumulation of noises for interleaved sampling for clouds is enabled.
getCloudsInterleavedRenderingTemporal
void setCloudsDepthBasedReconstructionThreshold	Setter and Getter for depth threshold value for clouds depth-based reconstruction mode (see the setCloudsDepthBasedReconstruction() method) .
getCloudsDepthBasedReconstructionThreshold
void setCloudsDepthBasedReconstruction	Setter and Getter for value indicating if clouds ray-marched depth is used for upsampling the downsampled clouds without obscuring the geometry and reprojection depending on the cloud depth.
getCloudsDepthBasedReconstruction
void setCloudsRoundedPlanetRadius	Setter and Getter for radius of the planet to be used for clouds curving.
getCloudsRoundedPlanetRadius
void setCloudsRounded	Setter and Getter for value indicating if cloud layers are to be curved to make them look more natural imitating planet's curvature.
getCloudsRounded
void setWaterAnisotropy	Setter and Getter for water texture anisotropy level.
getWaterAnisotropy	Setter and Getter for water texture anisotropy level.
void setWaterRefractionQuality	Setter and Getter for quality of water refraction.
getWaterRefractionQuality	Setter and Getter for quality of water refraction.
void setWaterSSRQuality	Setter and Getter for resolution of water SSR (Screen Space Reflections).
getWaterSSRQuality
void setWaterLights	Setter and Getter for value indicating if rendering of lights on the water surface is enabled.
getWaterLights
void setWaterVoxelProbes	Setter and Getter for value indicating if voxel probes are enabled for water rendering.
getWaterVoxelProbes
void setWaterEnvironmentProbes	Setter and Getter for value indicating if rendering of environment probes on the water surface is enabled.
getWaterEnvironmentProbes
void setWaterOpacityDepth	Setter and Getter for value indicating if depth data for water is written to the opacity buffer.
getWaterOpacityDepth
void setWaterShafts	Setter and Getter for value indicating if rendering of underwater shafts is enabled.
getWaterShafts
void setWaterShorelineWetness	Setter and Getter for value indicating if the wetness effect for objects near the shoreline is enabled.
getWaterShorelineWetness
void setWaterSSRIncreasedAccuracy	Setter and Getter for value indicating if increased accuracy for the water SSR (Screen Space Reflections).
getWaterSSRIncreasedAccuracy
void setWaterSSR	Setter and Getter for value indicating if the SSR (Screen Space Reflections) effect is enabled for water.
getWaterSSR
void setWaterEnabled	Setter and Getter for value indicating if rendering of water is enabled.
getWaterEnabled
void setTerrainGlobalAnisotropy	Setter and Getter for global terrain texture anisotropy level (degree of anisotropic filtering).
getTerrainGlobalAnisotropy
void setTerrainGlobalHoles	Setter and Getter for value indicating if decal-based holes are enabled for the global terrain.
getTerrainGlobalHoles
void setTerrainGlobalDisplacementNormal	Setter and Getter for value indicating if displacement mapping for the Global Terrain rendering uses normals.
getTerrainGlobalDisplacementNormal
void setTerrainGlobalDisplacement	Setter and Getter for value indicating if displacement mapping is enabled for the Global Terrain.
getTerrainGlobalDisplacement
void setTerrainGlobalTriplanar	Setter and Getter for value indicating if triplanar texture mapping is enabled for the Global Terrain.
getTerrainGlobalTriplanar
void setSSDirtConvexityMetalnessVisibility	Setter and Getter for metalness visibility value for convexities.
getSSDirtConvexityMetalnessVisibility
void setSSDirtConvexityMetalness	Setter and Getter for metalness value for convexities.
getSSDirtConvexityMetalness	Setter and Getter for metalness value for convexities.
void setSSDirtConvexityExponent	Setter and Getter for exponent value that determines the rate of gradual change of intensity along the radius for convexities.
getSSDirtConvexityExponent
void setSSDirtConvexityColor	Setter and Getter for color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern).
getSSDirtConvexityColor
void setSSDirtConvexityTextureSize	Setter and Getter for scaling factor for the textures used for convexities.
getSSDirtConvexityTextureSize
void setSSDirtCavityMetalnessVisibility	Setter and Getter for metalness visibility value for cavities.
getSSDirtCavityMetalnessVisibility
void setSSDirtCavityMetalness	Setter and Getter for metalness value for cavities.
getSSDirtCavityMetalness	Setter and Getter for metalness value for cavities.
void setSSDirtCavityExponent	Setter and Getter for exponent value that determines the rate of gradual change of intensity along the radius for cavities.
getSSDirtCavityExponent
void setSSDirtCavityColor	Setter and Getter for color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern).
getSSDirtCavityColor
void setSSDirtCavityTextureSize	Setter and Getter for scaling factor for the textures used for cavities.
getSSDirtCavityTextureSize
void setSSDirtConvexityShadingTextureName	Setter and Getter for name of the shading texture to be used for convexities.
getSSDirtConvexityShadingTextureName
void setSSDirtConvexityAlbedoTextureName	Setter and Getter for name of the albedo texture to be used for convexities.
getSSDirtConvexityAlbedoTextureName
void setSSDirtCavityShadingTextureName	Setter and Getter for name of the shading texture to be used for cavities.
getSSDirtCavityShadingTextureName
void setSSDirtCavityAlbedoTextureName	Setter and Getter for name of the albedo texture to be used for cavities.
getSSDirtCavityAlbedoTextureName
void setSSDirtIncreaseAccuracy	Setter and Getter for value indicating if increased accuracy for the SSDirt effect.
getSSDirtIncreaseAccuracy
void setSSDirtPerspective	Setter and Getter for perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
getSSDirtPerspective
void setSSDirtAngleBias	Setter and Getter for angle bias value to limit the SSDirt effect where information cannot be obtained.
getSSDirtAngleBias
void setSSDirtThreshold	Setter and Getter for threshold of the SSDirt effect.
getSSDirtThreshold	Setter and Getter for threshold of the SSDirt effect.
void setSSDirtRadius	Setter and Getter for size of the SSDirt effect.
getSSDirtRadius	Setter and Getter for size of the SSDirt effect.
void setSSDirtIntensity	Setter and Getter for intensity of the SSDirt effect.
getSSDirtIntensity	Setter and Getter for intensity of the SSDirt effect.
void setSSDirtResolution	Setter and Getter for resolution of the SSDirt effect.
getSSDirtResolution	Setter and Getter for resolution of the SSDirt effect.
void setSSDirtQuality	Setter and Getter for quality for the SSDirt effect.
getSSDirtQuality	Setter and Getter for quality for the SSDirt effect.
void setSSDirt	Setter and Getter for value indicating if the Screen-Space Dirt (SSDirt) effect is enabled.
getSSDirt
void setSSBevelRadius	Setter and Getter for size of the Screen-Space Bevel effect.
getSSBevelRadius
void setSSBevelNoise	Setter and Getter for value indicating if the noise is enabled for smoothing bevels.
getSSBevelNoise
void setSSBevelQuality	Setter and Getter for quality mode for the screen-space bevels.
getSSBevelQuality
void setSSBevelVertexNormal	Setter and Getter for rendering mode of the screen-space bevels.
getSSBevelVertexNormal
void setSSBevel	Setter and Getter for value indicating if the Screen-Space Bevels (SSBevel effect) are enabled.
getSSBevel
void setScreenPrecision	Setter and Getter for value indicating the current screen precision.
getScreenPrecision
void setShadowsFilterNoise	Setter and Getter for value indicating if noise for shadow filtering is enabled.
getShadowsFilterNoise
void setShadowsFilterMode	Setter and Getter for global filtering mode to be used for shadows from all light sources by default.
getShadowsFilterMode
void setShadowsPenumbraNoise	Setter and Getter for value indicating if noise for penumbra rendering is enabled.
getShadowsPenumbraNoise
void setShadowsPenumbraMode	Setter and Getter for global quality mode to be used for rendering penumbra from all light sources by default.
getShadowsPenumbraMode
void setShadowsScreenSpace	Setter and Getter for value indicating if screen space shadows are enabled.
getShadowsScreenSpace
void setShadowsAlphaTest	Setter and Getter for value indicating if alpha test is enabled for shadows.
getShadowsAlphaTest
void setShadowsWorldLerpCascades	Setter and Getter for value indicating if linear interpolation of shadow cascades is enabled, making transitions between cascades smoother.
getShadowsWorldLerpCascades
void setShadowsTranslucentDepth	Setter and Getter for global translucence depth value defining how deep the light goes through translucent objects shifting the shadow.
getShadowsTranslucentDepth
void setShadows	Setter and Getter for value indicating whether shadows are rendered or not.
getShadows
void setLightsLensFlares	Setter and Getter for value indicating if rendering of per-light lens flares is enabled.
getLightsLensFlares
void setLightsForwardPerObjectVoxel	Setter and Getter for maximum number of Voxel Probes per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectVoxel
void setLightsForwardPerObjectEnv	Setter and Getter for maximum number of Environment Probes per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectEnv
void setLightsForwardPerObjectPlanar	Setter and Getter for maximum number of Planar Reflection Probes per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectPlanar
void setLightsForwardPerObjectProj	Setter and Getter for maximum number of Projected lights per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectProj
void setLightsForwardPerObjectOmni	Setter and Getter for maximum number of Omni lights per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectOmni
void setLightsForwardPerObjectWorld	Setter and Getter for maximum number of World lights per object (available only for materials rendered in the forward rendering pass).
getLightsForwardPerObjectWorld
void setLightsInterleavedSamples	Setter and Getter for interleaved rendering mode defining the number of pixels to be skipped when rendering lights during the deferred pass with subsequent reconstruction of neighboring pixels using the data from previous frames.
getLightsInterleavedSamples
void setLightsInterleavedColorClamping	Setter and Getter for color clamping mode to be used for interleaved lights rendering mode.
getLightsInterleavedColorClamping
void setLightsInterleavedCatmullResampling	Setter and Getter for value indicating if the Catmull-Rom resampling for interleaved lights rendering mode is enabled.
getLightsInterleavedCatmullResampling
void setLightsInterleaved	Setter and Getter for value indicating if interleaved mode for rendering lights during the deferred pass is enabled.
getLightsInterleaved
void setLightsTileGridSize	Setter and Getter for number of grid tiles per axis for tiled rendering optimization.
getLightsTileGridSize
void setLightsMaxPerBatch	Setter and Getter for maximum number of lights rendered by a tile (see the setLightsTileGridSize() method) per batch call.
getLightsMaxPerBatch
void setLightsEnabled	Setter and Getter for value indicating if rendering of lights is enabled.
getLightsEnabled
void setOccludersShadowsResolution	Setter and Getter for resolution of the texture, to which occluders for shadows are rendered.
getOccludersShadowsResolution
void setOccludersShadows	Setter and Getter for value indicating whether rendering of occluders for shadows is enabled.
getOccludersShadows
void setOccludersResolution	Setter and Getter for resolution of the texture, to which occluders are rendered.
getOccludersResolution
void setOccluders	Setter and Getter for value indicating if rendering of occluders is enabled.
getOccluders
void setOcclusionQueriesNumFrames	Setter and Getter for number of frames for additional hardware occlusion query test performed before sending data to GPU.
getOcclusionQueriesNumFrames
void setOcclusionQueries	Setter and Getter for value indicating if additional hardware occlusion query test before sending data to GPU is enabled.
getOcclusionQueries
void setSkyRotation	Setter and Getter for sky rotation.
getSkyRotation	Setter and Getter for sky rotation.
getEnvironmentSkyIntensity	Returns intensity of the environment sky set for the preset that overlays the other ones.
getEnvironmentReflectionIntensity	Returns intensity of the environment reflections for the preset that overlays the other ones.
getEnvironmentAmbientIntensity	Returns intensity of the environment ambient lighting for the preset that overlays the other ones.
getEnvironmentHazeDensity	Returns haze density set for the preset that overlays the other ones.
getEnvironmentHazeMaxDistance	Returns distance starting at which the haze becomes completely solid, so nothing will be seen behind.
getEnvironmentHazeColor	Returns haze color for the preset that overlays the other ones.
void setEnvironmentCubemapBlendMode	Setter and Getter for blending mode for the environment cubemap.
getEnvironmentCubemapBlendMode
void setEnvironmentHazeGradient	Setter and Getter for environment haze gradient mode.
getEnvironmentHazeGradient	Setter and Getter for environment haze gradient mode.
void setEnvironmentHazeMode	Setter and Getter for mode for the haze effect.
getEnvironmentHazeMode	Setter and Getter for mode for the haze effect.
void setEnvironment	Setter and Getter for value indicating if rendering of environment of the scene is enabled.
getEnvironment
void setColorCorrectionLUTPath	Setter and Getter for name of a new color transformation texture (LUT).
getColorCorrectionLUTPath
void setColorCorrectionWhite	Setter and Getter for white balance of the scene.
getColorCorrectionWhite	Setter and Getter for white balance of the scene.
void setColorCorrectionGamma	Setter and Getter for Gamma correction value for the scene.
getColorCorrectionGamma	Setter and Getter for Gamma correction value for the scene.
getColorCorrectionCurve	Returns Color Correction curve texture of the scene.
void setColorCorrectionSaturation	Setter and Getter for saturation adjustment values for the scene.
getColorCorrectionSaturation
void setColorCorrectionHueShift	Setter and Getter for hue adjustment values for the scene.
getColorCorrectionHueShift	Setter and Getter for hue adjustment values for the scene.
void setColorCorrectionContrast	Setter and Getter for overall contrast value for the scene.
getColorCorrectionContrast	Setter and Getter for overall contrast value for the scene.
void setColorCorrectionBrightness	Setter and Getter for overall brightness value for the scene.
getColorCorrectionBrightness
void setColorCorrectionPreserveSaturation	Setter and Getter for value indicating if initial scene color saturation is to be preserved after applying color correction.
getColorCorrectionPreserveSaturation
void setFadeColor	Setter and Getter for current fade color for the scene on the screen.
getFadeColor
void setBackgroundColor	Setter and Getter for background color vector.
getBackgroundColor	Setter and Getter for background color vector.
void setWireframeColor	Setter and Getter for color of the wireframe.
getWireframeColor	Setter and Getter for color of the wireframe.
void setLensDispersion	Setter and Getter for color displacement for red, green, and blue channels of the lens flares.
getLensDispersion
void setLensColor	Setter and Getter for color of HDR lens flares.
getLensColor	Setter and Getter for color of HDR lens flares.
void setLensThreshold	Setter and Getter for value of the brightness threshold for areas to produce lens flares.
getLensThreshold
void setLensRadius	Setter and Getter for radius of the spherical lens flares on the screen.
getLensRadius
void setLensLength	Setter and Getter for length of the radial lens flare indicating if the whole radial lens flare is rendered on the screen or only a part of it.
getLensLength
void setLensScale	Setter and Getter for multiplier for color (see the setLensColor() method) of HDR lens flares.
getLensScale
void setLens	Setter and Getter for value indicating if lens flares are enabled.
getLens
void setShadowShaftsLength	Setter and Getter for relative length of volumetric shadows in the screen space.
getShadowShaftsLength
void setShadowShaftsExposure	Setter and Getter for contrast used for volumetric shadows.
getShadowShaftsExposure	Setter and Getter for contrast used for volumetric shadows.
void setShadowShafts	Setter and Getter for value indicating if volumetric shadows are enabled.
getShadowShafts
void setCrossColor	Setter and Getter for color of the cross flares.
getCrossColor	Setter and Getter for color of the cross flares.
void setCrossThreshold	Setter and Getter for brightness threshold for areas to produce flare
getCrossThreshold
void setCrossAngle	Setter and Getter for cross flares orientation angle.
getCrossAngle	Setter and Getter for cross flares orientation angle.
void setCrossScale	Setter and Getter for cross color scale — a multiplier for the color of cross flares.
getCrossScale
void setCrossLength	Setter and Getter for length of a cross flare relative to the screen width.
getCrossLength
void setCrossShafts	Setter and Getter for number of shafts in a cross flare.
getCrossShafts	Setter and Getter for number of shafts in a cross flare.
void setCross	Setter and Getter for value indicating if cross flares are enabled.
getCross
void setFilmicSaturationRecovery	Setter and Getter for color saturation recovery value for the filmic tonemapper.
getFilmicSaturationRecovery
void setFilmicWhiteLevel	Setter and Getter for Linear White Point tonemapping parameter value, which is mapped as pure white in the resulting image.
getFilmicWhiteLevel
void setFilmicToeDenominator	Setter and Getter for Toe Denominator tonemapping parameter value.
getFilmicToeDenominator
void setFilmicToeNumerator	Setter and Getter for Toe Numerator tonemapping parameter value.
getFilmicToeNumerator
void setFilmicToeScale	Setter and Getter for Toe Scale tonemapping parameter value that is used to change dark values.
getFilmicToeScale
void setFilmicLinearAngle	Setter and Getter for Linear Angle tone mapping parameter value.
getFilmicLinearAngle
void setFilmicLinearScale	Setter and Getter for Linear Strength tone mapping parameter value that is used to change gray values.
getFilmicLinearScale
void setFilmicShoulderScale	Setter and Getter for Shoulder Strength tonemapping parameter value that is used to change bright values.
getFilmicShoulderScale
void setBloomPower	Setter and Getter for power of the Bloom effect.
getBloomPower	Setter and Getter for power of the Bloom effect.
void setBloomScale	Setter and Getter for scale of the Bloom effect.
getBloomScale	Setter and Getter for scale of the Bloom effect.
void setBloomPasses	Setter and Getter for number of passes for the bloom effect.
getBloomPasses
void setBloomResolution	Setter and Getter for resolution of the Bloom effect.
getBloomResolution	Setter and Getter for resolution of the Bloom effect.
void setBloom	Setter and Getter for value indicating if the Bloom effect is enabled.
getBloom
void setDOFNearFocalOffset	Setter and Getter for offset from the focal to the nearest blurred zone.
getDOFNearFocalOffset
void setDOFNearDistance	Setter and Getter for near DOF limit of the camera: the distance between the camera and the first element that is considered to be acceptably sharp.
getDOFNearDistance
void setDOFFarFocalOffset	Setter and Getter for Sets the offset from the focal to the farthest blurred zone for the DOF effect.
getDOFFarFocalOffset
void setDOFFarDistance	Setter and Getter for far DOF limit of the camera: the distance between the camera and the furthest element that is considered to be acceptably sharp.
getDOFFarDistance
void setDOFBlur	Setter and Getter for intensity of blur for the DOF (Depth Of Field) effect.
getDOFBlur
void setDOFChromaticAberration	Setter and Getter for intensity of chromatic aberration for the DOF (Depth Of Field) effect.
getDOFChromaticAberration
void setDOFFocalDistance	Setter and Getter for focal distance of the camera, i.e. a point where objects are in-focus and visible clearly.
getDOFFocalDistance
void setDOFBokehMode	Setter and Getter for shape of the Bokeh for the DOF effect.
getDOFBokehMode
void setDOFResolution	Setter and Getter for resolution of the DOF (Depth Of Field) effect.
getDOFResolution
void setDOFQuality	Setter and Getter for quality of the DOF (Depth Of Field) effect.
getDOFQuality
void setDOFFocusImprovement	Setter and Getter for value indicating if the focus improvement option is enabled for the DOF (Depth Of Field) effect.
getDOFFocusImprovement
void setDOFIncreasedAccuracy	Setter and Getter for value indicating if the increased accuracy option is enabled for the DOF (Depth Of Field) effect.
getDOFIncreasedAccuracy
void setDOF	Setter and Getter for value indicating if the DOF (Depth Of Field) effect is enabled.
getDOF
void setMotionBlurNumSteps	Setter and Getter for number of steps used in the motion blur.
getMotionBlurNumSteps
void setMotionBlurNoiseIntensity	Setter and Getter for intensity of the noise used in the motion blur.
getMotionBlurNoiseIntensity
void setMotionBlurMaxVelocity	Setter and Getter for maximum possible amount of motion blur for moving physical objects.
getMotionBlurMaxVelocity
void setMotionBlurVelocityScale	Setter and Getter for scale value of bodies' linear and angular velocities used for the motion blur.
getMotionBlurVelocityScale
void setMotionBlurCameraVelocity	Setter and Getter for value indicating if camera velocity contributes to the motion blur effect (false to take into account velocities of objects only).
getMotionBlurCameraVelocity
void setMotionBlurNeatSilhouettes	Setter and Getter for value indicating if neat silhouettes option for motion blur is enabled.
getMotionBlurNeatSilhouettes
void setMotionBlur	Setter and Getter for value indicating if the motion blur effect is enabled.
getMotionBlur
void setWhiteBalanceAdaptationTime	Setter and Getter for time period set for the camera to adjust white balance.
getWhiteBalanceAdaptationTime
void setWhiteBalanceIntensity	Setter and Getter for value of white balance correction intensity.
getWhiteBalanceIntensity
void setWhiteBalance	Setter and Getter for value indicating if automatic white balance correction is enabled.
getWhiteBalance
void setExposureMaxLuminance	Setter and Getter for maximum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the lower the value, the brighter the adapted image will be.
getExposureMaxLuminance
void setExposureMinLuminance	Setter and Getter for minimum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the higher the value, the darker the adapted image will be.
getExposureMinLuminance
void setExposureAdaptation	Setter and Getter for time for the camera to adjust exposure, in seconds.
getExposureAdaptation
void setExposure	Setter and Getter for camera exposure (a multiplier of the scene luminance and brightness).
getExposure
void setExposureMode	Setter and Getter for mode of the adaptive exposure effect.
getExposureMode	Setter and Getter for mode of the adaptive exposure effect.
void setFStop	Setter and Getter for f-stop value used for static exposure calculation.
getFStop
void setShutterSpeed	Setter and Getter for shutter speed used for static exposure calculation.
getShutterSpeed
void setISO	Setter and Getter for ISO value used for static exposure calculation.
getISO
void setCameraMode	Setter and Getter for camera mode, which determines the way the exposure is set.
getCameraMode
void setDirtTextureName	Setter and Getter for name of the texture that modulates the pattern of lens flares.
getDirtTextureName
void setDirtScale	Setter and Getter for intensity of lens dirt effect modulating the pattern of lens flares defined by the Dirt Texture.
getDirtScale
void setCameraEffectsTemporalFiltering	Setter and Getter for value indicating if temporal filtering for camera effects is enabled.
getCameraEffectsTemporalFiltering
void setCameraEffectsThreshold	Setter and Getter for brightness threshold, which is used to detect if an object should be blurred in the HDR mode.
getCameraEffectsThreshold
void setTranslucentColor	Setter and Getter for color used for translucent objects globally.
getTranslucentColor
void setSSSSSColor	Setter and Getter for subsurface scattering color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside of the subsurface tissue layers (epidermis and dermis) before exiting.
getSSSSSColor
void setSSSSSRadius	Setter and Getter for subsurface scattering radius — distance in the screen space, within which colors will be sampled.
getSSSSSRadius
void setSSSSSResolution	Setter and Getter for resolution of the SSSSS (Screen-Space Subsurface Scattering) effect.
getSSSSSResolution
void setSSSSSQuality	Setter and Getter for quality of the SSSSS (Screen-Space Subsurface Scattering) effect.
getSSSSSQuality
void setSSSSS	Setter and Getter for value indicating if the SSSSS (Screen-Space Subsurface Scattering) effect is enabled.
getSSSSS
void setSSRThresholdOcclusion	Setter and Getter for value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) cannot get information.
getSSRThresholdOcclusion
void setSSRThreshold	Setter and Getter for threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information.
getSSRThreshold
void setSSRVisibilityRoughnessMax	Setter and Getter for maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered.
getSSRVisibilityRoughnessMax
void setSSRVisibilityRoughnessMin	Setter and Getter for minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out.
getSSRVisibilityRoughnessMin
void setSSRNoiseStep	Setter and Getter for intensity of the step noise used for SSR (Screen-Space Reflections) calculation.
getSSRNoiseStep
void setSSRNoiseRay	Setter and Getter for intensity of the ray noise used for SSR (Screen-Space Reflections) calculation.
getSSRNoiseRay
void setSSRStepSize	Setter and Getter for size of the trace step used for SSR calculation.
getSSRStepSize
void setSSRNumSteps	Setter and Getter for number of SSR steps per ray that are used for trace calculation.
getSSRNumSteps
void setSSRNumRays	Setter and Getter for number of SSR rays per pixel that are used to calculate rough refrections.
getSSRNumRays
void setSSRResolutionColor	Setter and Getter for resolution of the color buffer used for SSR (Screen Space Reflections) calculation.
getSSRResolutionColor
void setSSRResolutionDepth	Setter and Getter for resolution of the depth buffer used for SSR (Screen Space Reflections) calculation.
getSSRResolutionDepth
void setSSRResolution	Setter and Getter for resolution of SSR (Screen Space Reflections).
getSSRResolution
void setSSRDenoise	Setter and Getter for value indicating if noise reduction for the SSR (Screen Space Reflections) effect is enabled.
getSSRDenoise
void setSSRIncreasedAccuracy	Setter and Getter for value indicating if increased accuracy option is enabled for the SSR (Screen Space Reflections).
getSSRIncreasedAccuracy
void setSSRFastTracing	Setter and Getter for value indicating if fast tracing for the SSR (Screen Space Reflections) effect is enabled.
getSSRFastTracing
void setSSR	Setter and Getter for value indicating if the SSR (Screen Space Reflections) effect is enabled.
getSSR
void setBentNormalRayTracingThreshold	Setter and Getter for threshold value for the ray-traced bent normals calculation.
getBentNormalRayTracingThreshold
void setBentNormalFixOverlitAreas	Setter and Getter for value indicating if correction of overlit areas for bent normals calculation is enabled.
getBentNormalFixOverlitAreas
void setBentNormalRayTracingDenoise	Setter and Getter for value indicating if noise reduction for ray-traced bent normals calculation is enabled.
getBentNormalRayTracingDenoise
void setBentNormalRayTracing	Setter and Getter for value indicating if ray-traced bent normals calculation is enabled.
getBentNormalRayTracing
void setSSGIRadius	Setter and Getter for radius of the SSGI (Screen Space Global Illumination).
getSSGIRadius
void setSSGIThreshold	Setter and Getter for threshold value for the ray-traced SSGI (Screen Space Global Illumination).
getSSGIThreshold
void setSSGIIntensity	Setter and Getter for intensity of the SSGI (Screen Space Global Illumination) for the scene.
getSSGIIntensity
void setSSGIResolutionColor	Setter and Getter for resolution of the color buffer used for SSGI (Screen Space Global Illumination) calculation.
getSSGIResolutionColor
void setSSGIDenoise	Setter and Getter for value indicating if noise reduction for the ray-traced SSGI (Screen Space Global Illumination) is enabled.
getSSGIDenoise
void setSSGI	Setter and Getter for value indicating if the SSGI (Screen Space Global Illumination) effect is enabled.
getSSGI
void setSSAOThreshold	Setter and Getter for threshold value for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAOThreshold
void setSSAOCavityRadius	Setter and Getter for size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAOCavityRadius
void setSSAOCavityIntensity	Setter and Getter for intensity of sharpening of contours for the cavity option.
getSSAOCavityIntensity
void setSSAORadius	Setter and Getter for radius of SSAO (Screen Space Ambient Occlusion).
getSSAORadius
void setSSAORayTracingThreshold	Setter and Getter for threshold value for the ray-traced SSAO (Screen Space Ambient Occlusion).
getSSAORayTracingThreshold
void setSSAOIntensityReflection	Setter and Getter for intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
getSSAOIntensityReflection
void setSSAOIntensityLightedSide	Setter and Getter for intensity of the SSAO (Screen Space Ambient Occlusion) for the scene object's lighted side.
getSSAOIntensityLightedSide
void setSSAOIntensity	Setter and Getter for intensity of the SSAO (Screen Space Ambient Occlusion) for the scene.
getSSAOIntensity
void setSSAOResolution	Setter and Getter for resolution of SSAO (Screen Space Ambient Occlusion).
getSSAOResolution
void setSSAOQuality	Setter and Getter for quality of SSAO (Screen Space Ambient Occlusion).
getSSAOQuality
void setSSAORayTracingDenoise	Setter and Getter for value indicating if noise reduction for the ray-traced SSAO (Screen Space Ambient Occlusion) is enabled.
getSSAORayTracingDenoise
void setSSAORayTracing	Setter and Getter for value indicating if ray tracing is used for SSAO (Screen Space Ambient Occlusion) calculation.
getSSAORayTracing
void setSSAONoise	Setter and Getter for value indicating if noise for the SSAO (Screen Space Ambient Occlusion) effect is enabled. This option reduces banding effect.
getSSAONoise
void setSSAOCavity	Setter and Getter for value indicating if the cavity option for the SSAO (Screen Space Ambient Occlusion) effect is enabled.
getSSAOCavity
void setSSAO	Setter and Getter for value indicating if the SSAO (Screen Space Ambient Occlusion) effect is enabled.
getSSAO
void setSSRTGIStepSize	Setter and Getter for size of the trace step used for SSRTGI calculation.
getSSRTGIStepSize
void setSSRTGINoiseStep	Setter and Getter for intensity of the step noise used for SSRTGI calculation.
getSSRTGINoiseStep
void setSSRTGINoiseRay	Setter and Getter for intensity of the ray noise used for SSRTGI calculation.
getSSRTGINoiseRay
void setSSRTGINumSteps	Setter and Getter for number of steps of SSRTGI per ray that are used for trace calculation.
getSSRTGINumSteps
void setSSRTGINumRays	Setter and Getter for number of rays of SSRTGI per pixel that are used to calculate the final image.
getSSRTGINumRays
void setSSRTGIResolutionDepth	Setter and Getter for resolution of the depth buffer used for SSRTGI (screen space ray-traced global illumination) calculation.
getSSRTGIResolutionDepth
void setSSRTGIResolution	Setter and Getter for resolution of the SSRTGI (screen space ray-traced global illumination) effect.
getSSRTGIResolution
void setSSRTGIUpscaling	Setter and Getter for value indicating if upscaling is enabled for the SSRTGI (screen space ray-traced global illumination).
getSSRTGIUpscaling
void setSSRTGIIncreasedAccuracy	Setter and Getter for value indicating if increased accuracy is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination).
getSSRTGIIncreasedAccuracy
void setSSRTGIFastTracing	Setter and Getter for value indicating if fast tracing is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination).
getSSRTGIFastTracing
void setSSRTGI	Setter and Getter for value indicating if the SSRTGI (screen space ray-traced global illumination) effect is enabled.
getSSRTGI
void setReflectionLods	Setter and Getter for value indicating if reduction of resolution of dynamic reflections when the camera moves away is enabled.
getReflectionLods
void setReflectionDynamic	Setter and Getter for value indicating if dynamic reflections for materials are enabled.
getReflectionDynamic
void setTransparentBlur	Setter and Getter for value indicating if transparent blur is enabled for materials.
getTransparentBlur
void setRefractionDispersion	Setter and Getter for refraction displacement for red, green, and blue channels (according to the refraction texture of refractive materials).
getRefractionDispersion
void setRefraction	Setter and Getter for value indicating if refraction is enabled.
getRefraction
void setDecals	Setter and Getter for value indicating if rendering of decals is enabled.
getDecals
void setAuxiliary	Setter and Getter for value indicating if auxiliary render buffer is used.
getAuxiliary
void setAlphaFade	Setter and Getter for value indicating if alpha-blend fading (dithering) is enabled for objects.
getAlphaFade
void setSharpenIntensity	Setter and Getter for intensity of the sharpening effect.
getSharpenIntensity	Setter and Getter for intensity of the sharpening effect.
void setSharpen	Setter and Getter for value indicating if the sharpening post-processing effect is enabled.
getSharpen
void setFXAAIntensity	Setter and Getter for intensity of FXAA.
getFXAAIntensity	Setter and Getter for intensity of FXAA.
void setFXAA	Setter and Getter for value indicating if FXAA (post-process anti-aliasing) is enabled.
getFXAA
void setTAASamples	Setter and Getter for number of the sample offsets performed during subpixel jittering.
getTAASamples
void setTAACatmullResampling	Setter and Getter for value indicating if Catmull-Rom resampling is enabled.
getTAACatmullResampling
void setTAAPixelOffset	Setter and Getter for size of the sample offset performed during subpixel jittering.
getTAAPixelOffset
void setTAAFramesByVelocity	Setter and Getter for value indicating if the TAA velocity clamping option is enabled.
getTAAFramesByVelocity
void setTAAMinFramesByVelocity	Setter and Getter for minimum frame count of TAA (Temporal Anti-Aliasing).
getTAAMinFramesByVelocity
void setTAAMaxFramesByVelocity	Setter and Getter for maximum frame count of TAA (Temporal Anti-Aliasing).
getTAAMaxFramesByVelocity
void setTAAFramesVelocityThreshold	Setter and Getter for velocity threshold of TAA (Temporal Anti-Aliasing), at which pixels are treated as fast moving ones.
getTAAFramesVelocityThreshold
void setTAAFrameCount	Setter and Getter for frame count of TAA (Temporal Anti-Aliasing).
getTAAFrameCount
void setTAAPreserveDetails	Setter and Getter for detail level of TAA (Temporal Anti-Aliasing).
getTAAPreserveDetails
void setTAADiagonalNeighbors	Setter and Getter for value indicating if diagonally neighboring pixels are to be taken into account in the process of color clamping for TAA.
getTAADiagonalNeighbors
void setTAAFramesByColor	Setter and Getter for value indicating if TAA color clamping option is enabled.
getTAAFramesByColor
void setTAAAntialiasingInMotion	Setter and Getter for value indicating if improved anti-aliasing in motion (for moving camera and objects) is enabled.
getTAAAntialiasingInMotion
void setTAAFixFlicker	Setter and Getter for value indicating if the taa fix flicker option is enabled.
getTAAFixFlicker
void setTAA	Setter and Getter for value indicating if TAA (Temporal Anti-Aliasing) is enabled.
getTAA
void setSupersampling	Setter and Getter for number of samples per pixel used for supersampling.
getSupersampling
void setStereoHiddenAreaExposureTransform	Setter and Getter for area to be used for exposure calculation, when culling of pixels that are not visible in VR mode (see the setStereoHiddenArea() method) is enabled.
getStereoHiddenAreaExposureTransform
void setStereoHiddenAreaTransform	Setter and Getter for size and offset parameters for a new oval or circular mesh to be used for culling pixels, that are not visible in VR mode.
getStereoHiddenAreaTransform
void setStereoHiddenArea	Setter and Getter for culling mode for pixels that are not visible in VR mode.
getStereoHiddenArea
void setStereoOffset	Setter and Getter for virtual camera offset (an offset after the perspective projection).
getStereoOffset
void setStereoRadius	Setter and Getter for radius for stereo (the half of the separation distance between the cameras).
getStereoRadius
void setStereoDistance	Setter and Getter for focal distance for stereo rendering (distance in the world space to the point where two views line up).
getStereoDistance
void setVREmulation	Setter and Getter for value indicating the current VR emulation mode.
getVREmulation
getAnimationOldTime	Returns previous render animation time for vegetation.
void setAnimationTime	Setter and Getter for render animation time for vegetation.
getAnimationTime	Setter and Getter for render animation time for vegetation.
void setAnimationWind	Setter and Getter for direction of wind for all vegetation (grass and trees).
getAnimationWind
void setAnimationScale	Setter and Getter for global scale for rotation speed of vegetation leaves.
getAnimationScale
void setAnimationLeaf	Setter and Getter for global scale for rotation angle of vegetation leaves.
getAnimationLeaf
void setAnimationStem	Setter and Getter for global scale for movement amplitude of vegetation stems.
getAnimationStem
void setShadowDistance	Setter and Getter for distance from the camera, beyond which shadows will not be rendered.
getShadowDistance
void setShadowDistanceScale	Setter and Getter for global scale multiplier for shadow distances.
getShadowDistanceScale
void setReflectionDistance	Setter and Getter for distance starting from which (and farther) reflections will not be rendered.
getReflectionDistance
void setObjectDistance	Setter and Getter for distance at which (and farther) objects will not be rendered.
getObjectDistance
void setDecalDistance	Setter and Getter for distance at which (and farther) decals will not be rendered.
getDecalDistance
void setLightDistance	Setter and Getter for distance at which (and farther) dynamic lights will not be rendered.
getLightDistance
void setFieldDistance	Setter and Getter for distance at which (and farther) field nodes will not be rendered.
getFieldDistance
void setDistanceScale	Setter and Getter for global distance multiplier for all distance parameters, such as the world rendering distance, decal distance, field distance, light distance, object distance, reflection distance, LODs, and surface visibility distances.
getDistanceScale
void setShadersPreload	Setter and Getter for value indicating if all shaders that are used in the loaded world are compiled and loaded to RAM every time the world is loaded.
getShadersPreload
void setStreamingMeshesMemoryLimit	Setter and Getter for cache memory limit used for mesh streaming.
getStreamingMeshesMemoryLimit
void setStreamingTexturesCacheResolution	Setter and Getter for resolution for texture cache elements.
getStreamingTexturesCacheResolution
void setStreamingTexturesMemoryLimit	Setter and Getter for cache memory limit used for texture streaming.
getStreamingTexturesMemoryLimit
void setStreamingParticlesMemoryLimit	Setter and Getter for cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
getStreamingParticlesMemoryLimit
void setStreamingDestroyDuration	Setter and Getter for resource cleanup interval, in number of frames.
getStreamingDestroyDuration
void setStreamingMaxThreads	Setter and Getter for maximum number of threads used for streaming.
getStreamingMaxThreads
void setStreamingUseMemoryLimit	Setter and Getter for value indicating if memory limitation for asynchronous resource loading (streaming of meshes and textures) is enabled.
getStreamingUseMemoryLimit
void setStreamingMode	Setter and Getter for streaming mode to be used for textures and meshes.
getStreamingMode
void setTexturesAnisotropy	Setter and Getter for anisotropy level for textures (degree of anisotropic filtering).
getTexturesAnisotropy
void setTexturesFilter	Setter and Getter for texture filtering mode.
getTexturesFilter	Setter and Getter for texture filtering mode.
void setTexturesMinResolution	Setter and Getter for minimum resolution of all textures.
getTexturesMinResolution	Setter and Getter for minimum resolution of all textures.
void setTexturesMaxResolution	Setter and Getter for maximum resolution of all textures.
getTexturesMaxResolution	Setter and Getter for maximum resolution of all textures.
void setTexturesQuality	Setter and Getter for resolution of textures.
getTexturesQuality	Setter and Getter for resolution of textures.
void setLatency	Setter and Getter for maximum number of back buffer frames that a driver is allowed to queue for rendering.
getLatency
void setDeferredMaterialGUID	Setter and Getter for material that will be used on the Deferred Composite stage of rendering sequence.
getDeferredMaterialGUID
void setDebug	Setter and Getter for value indicating whether debug materials (the debug_materials material) are rendered or not.
getDebug
void setGbufferLightmap	Setter and Getter for value indicating if lightmap data is stored in the gbuffer.
getGbufferLightmap
void setDepthPrePass	Setter and Getter for value indicating if depth pre-pass rendering is enabled.
getDepthPrePass
void setVirtualResolution	Setter and Getter for virtual screen resolution.
getVirtualResolution	Setter and Getter for virtual screen resolution.
void setMaxFPS	Setter and Getter for maximum FPS value, to which rendering FPS is to be clamped.
getMaxFPS
void setBorder	Setter and Getter for width and height of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
getBorder
void setBudget	Setter and Getter for render budget value, in seconds, which limits the number of loaded/created graphics resources during a frame according to loading/creation time.
getBudget
void setCompositeMaterialGUID	Setter and Getter for GUID of a custom composite material that specifies a custom shader used for the final composition of the full-screen image instead of the default one.
getCompositeMaterialGUID
getNumScriptableMaterials	Returns total number of scriptable materials applied globally.
void setViewport	Setter and Getter for main application window viewport.
getViewport	Setter and Getter for main application window viewport.
void setViewportMode	Setter and Getter for viewport rendering mode.
getViewportMode	Setter and Getter for viewport rendering mode.
void setShaderDefines	Setter and Getter for Macros list related to the renderer (defines to make corresponding resources available in shaders).
getShaderDefines
void setClearBufferMask	Setter and Getter for buffer cleanup mask.
getClearBufferMask	Setter and Getter for buffer cleanup mask.
void setFirstFrame	Setter and Getter for value indicating if the first frame is enabled over the current frame.
getFirstFrame
void setData	Setter and Getter for user data associated with the render.
getData	Setter and Getter for user data associated with the render.
getMaxFieldShorelines	Returns maximum limit of FieldShoreline nodes allowed to be used in shaders.
getMaxFieldHeights	Returns maximum limit of FieldHeight nodes allowed to be used in shaders.
getMaxFieldAnimations	Returns maximum limit of FieldAnimation nodes allowed to be used in shaders.
getMaxFieldSpacers	Returns maximum limit of FieldSpacer nodes allowed to be used in shaders.
getNumInstances	Returns maximum number of instances that can be rendered for each of the following node types: Field Animation Field Height Field Shoreline Field Spacer Returned value depends on the graphics API used.
getIsFlipped	Returns value indicating render orientation.
getGPUMemory	Returns amount of memory provided by the current GPU.
getGPUName	Returns name of the current GPU.
getAPI	Returns current Graphics API, or API_UNKNOWN if API cannot be identified.
void setEnvironmentCorrectRoughness	Setter and Getter for correction mode for environment reflections on rough surfaces.
getEnvironmentCorrectRoughness
void setSSSSSTAASamples	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Samples.
getSSSSSTAASamples
void setSSSSSTAACatmullResampling	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Catmull Resampling.
getSSSSSTAACatmullResampling
void setSSSSSTAAMinFramesByVelocity	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Min Frames By Velocity.
getSSSSSTAAMinFramesByVelocity
void setSSSSSTAAMaxFramesByVelocity	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Max Frames By Velocity.
getSSSSSTAAMaxFramesByVelocity
void setSSSSSTAAFramesVelocityThreshold	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames Velocity Threshold.
getSSSSSTAAFramesVelocityThreshold
void setSSSSSTAAFrameCount	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frame Count.
getSSSSSTAAFrameCount
void setSSSSSTAAPixelOffset	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Pixel Offset.
getSSSSSTAAPixelOffset
void setSSSSSTAAPreserveDetails	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Preserve Details.
getSSSSSTAAPreserveDetails
void setSSSSSTAAFramesByVelocity	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Velocity.
getSSSSSTAAFramesByVelocity
void setSSSSSTAAFramesByColor	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Color.
getSSSSSTAAFramesByColor
void setSSSSSTAAAntialiasingInMotion	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Antialiasing In Motion.
getSSSSSTAAAntialiasingInMotion
void setSSSSSTAAFixFlicker	Setter and Getter for value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Fix Flicker.
getSSSSSTAAFixFlicker
void setSSSSSInterleavedSamples	Setter and Getter for number of pixels to be skipped when rendering the SSSSS (Screen-Space Subsurface Scattering) effect with subsequent reconstruction of neighboring pixels using the data from previous frames.
getSSSSSInterleavedSamples
void setSSSSSInterleavedColorClamping	Setter and Getter for color clamping mode used to reduce ghosting effect.
getSSSSSInterleavedColorClamping
void setSSSSSInterleaved	Setter and Getter for value indicating if the interleaved rendering mode for SSSSS (Screen-Space Subsurface Scattering) is enabled.
getSSSSSInterleaved
void setSSSSSNoiseRay	Setter and Getter for intensity of the ray noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
getSSSSSNoiseRay
void setSSSSSNoiseStep	Setter and Getter for intensity of the step noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
getSSSSSNoiseStep
void setSSSSSMaxThreshold	Setter and Getter for threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 1 (maximum translucency).
getSSSSSMaxThreshold
void setSSSSSMinThreshold	Setter and Getter for threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 0 (minimum translucency).
getSSSSSMinThreshold
void setSSSSSAmbient	Setter and Getter for value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for ambient lighting (environment) is enabled.
getSSSSSAmbient
void setSSSSSDiffuse	Setter and Getter for value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for diffuse lighting (directional lights) is enabled.
getSSSSSDiffuse
void setSSRColorClampingVelocityThreshold	Setter and Getter for sensitivity of TAA color clamping for the SSR (Screen-Space Reflections) effect to pixel velocity change.
getSSRColorClampingVelocityThreshold
void setSSRColorClampingIntensity	Setter and Getter for intensity of TAA color clamping at zero pixel velocity for the SSR (Screen-Space Reflections) effect.
getSSRColorClampingIntensity
void setSSRDenoiseRadius	Setter and Getter for radius of the area to be affected by noise reduction for the SSR (Screen-Space Reflections) effect.
getSSRDenoiseRadius
void setSSRDenoiseThreshold	Setter and Getter for threshold value for color difference of neighboring pixels used for noise reduction for the SSR (Screen-Space Reflections) effect.
getSSRDenoiseThreshold
void setSSRDenoiseGaussianSigma	Setter and Getter for sigma parameter of Gaussian blur used for noise reduction for the SSR (Screen-Space Reflections) effect.
getSSRDenoiseGaussianSigma
void setSSRDenoiseIntensity	Setter and Getter for noise reduction intensity for the SSR (Screen-Space Reflections) effect.
getSSRDenoiseIntensity
void setSSRDenoiseQuality	Setter and Getter for noise reduction quality level for the SSR (Screen-Space Reflections) effect defining the number of samples used.
getSSRDenoiseQuality
void setBentNormalDenoiseQuality	Setter and Getter for noise reduction quality level for Bent Normals calculation defining the number of samples used.
getBentNormalDenoiseQuality
void setSSGIColorClampingVelocityThreshold	Setter and Getter for sensitivity of TAA color clamping for the SSGI (Screen Space Global Illumination) effect to pixel velocity change.
getSSGIColorClampingVelocityThreshold
void setSSGIColorClampingIntensity	Setter and Getter for intensity of TAA color clamping at zero pixel velocity for the SSGI (Screen Space Global Illumination) effect.
getSSGIColorClampingIntensity
void setSSGIDenoiseRadius	Setter and Getter for radius of the area to be affected by noise reduction for the SSGI (Screen Space Global Illumination) effect.
getSSGIDenoiseRadius
void setSSGIDenoiseThreshold	Setter and Getter for threshold value for color difference of neighboring pixels used for noise reduction for the ssgi (screen space global illumination) effect.
getSSGIDenoiseThreshold
void setSSGIDenoiseGaussianSigma	Setter and Getter for sigma parameter of Gaussian blur used for noise reduction for the SSGI (Screen Space Global Illumination) effect.
getSSGIDenoiseGaussianSigma
void setSSGIDenoiseIntensity	Setter and Getter for noise reduction intensity for the SSGI (Screen Space Global Illumination) effect.
getSSGIDenoiseIntensity
void setSSGIDenoiseQuality	Setter and Getter for noise reduction quality level for the SSGI (Screen-Space Global Illumination) effect defining the number of samples used.
getSSGIDenoiseQuality
void setSSAODenoiseQuality	Setter and Getter for noise reduction quality level for the SSAO (Screen-Space Ambient Occlusion) effect defining the number of samples used.
getSSAODenoiseQuality
void setShowLandscapeTerrainVTStreaming	Setter and Getter for value indicating if visualization is enabled for streaming of tiles of the Landscape Terrain megatexture.
getShowLandscapeTerrainVTStreaming
void setShowLandscapeMask	Setter and Getter for number of the Landscape Terrain detail mask to be visualized.
getShowLandscapeMask
void setShowLandscapeAlbedo	Setter and Getter for value indicating if visualization of albedo data of the Landscape Terrain is enabled.
getShowLandscapeAlbedo
void setLandscapeCacheGPULifeTime	Setter and Getter for lifetime of GPU cache used for Landscape Terrain rendering, in frames.
getLandscapeCacheGPULifeTime
void setLandscapeCacheGPUSize	Setter and Getter for GPU cache size to be used for landscape terrain rendering, in percentage of the total GPU memory.
getLandscapeCacheGPUSize
void setLandscapeCacheCPUSize	Setter and Getter for CPU cache size to be used for landscape terrain rendering, in percentage of the total memory.
getLandscapeCacheCPUSize
void setLandscapeTerrainCullingObliqueFrustum	Setter and Getter for multiplier for culling of tessellation patches of the Landscape Terrain beyond the oblique frustum plane.
getLandscapeTerrainCullingObliqueFrustum
void setLandscapeTerrainCullingBackFace	Setter and Getter for threshold used for culling tessellation patches of the Landscape Terrain oriented to the camera with their back faces (it is a multiplier for the angle between the tessellation patch normal and the camera's view direction).
getLandscapeTerrainCullingBackFace
void setLandscapeTerrainCullingFrustumPadding	Setter and Getter for multiplier for the size of viewing frustum to be used for culling polygons of the Landscape Terrain (value, by which the borders of the current frustum are increased).
getLandscapeTerrainCullingFrustumPadding
void setLandscapeTerrainCullingAggressive	Setter and Getter for value indicating if frustum culling optimization is enabled for the Landscape Terrain.
getLandscapeTerrainCullingAggressive
void setLandscapeTerrainGeometrySubpixelReduction	Setter and Getter for minimum ratio between the polygon size (in screen space) to the size of an area in the viewport for skipping polygons rendering (the ones having a lower ratio will be removed).
getLandscapeTerrainGeometrySubpixelReduction
void setLandscapeTerrainGeometryFadeLods	Setter and Getter for intensity of fading between levels of Landscape Terrain geometry tessellation.
getLandscapeTerrainGeometryFadeLods
void setLandscapeTerrainGeometryProgression	Setter and Getter for progression of Landscape Terrain geometry tessellation.
getLandscapeTerrainGeometryProgression
void setLandscapeTerrainGeometryPolygonSize	Setter and Getter for size of Landscape Terrain polygons defining the maximum allowed density of Landscape Terrain geometry.
getLandscapeTerrainGeometryPolygonSize
void setLandscapeTerrainGeometryHoles	Setter and Getter for value indicating if decal-based holes for the Landscape Terrain are enabled.
getLandscapeTerrainGeometryHoles
void setLandscapeTerrainDetailResolutionAdditionalMask	Setter and Getter for resolution of the additional mask texture for details of the Landscape Terrain.
getLandscapeTerrainDetailResolutionAdditionalMask
void setLandscapeTerrainDetailResolutionHeight	Setter and Getter for resolution of the height texture for details of the Landscape Terrain.
getLandscapeTerrainDetailResolutionHeight
void setLandscapeTerrainDetailResolutionAlbedo	Setter and Getter for resolution of the albedo texture for details of the Landscape Terrain.
getLandscapeTerrainDetailResolutionAlbedo
void setLandscapeTerrainVTTilesReloadPerFrame	Setter and Getter for number of tiles to be reloaded per frame after applying changes to the Landscape Terrain surface.
getLandscapeTerrainVTTilesReloadPerFrame
void setLandscapeTerrainVTTilesLoadPerFrame	Setter and Getter for number of Landscape Terrain tiles loaded per frame.
getLandscapeTerrainVTTilesLoadPerFrame
void setLandscapeTerrainVTTilesUpdatePerFrame	Setter and Getter for number of tiles passed to the virtual texture of the Landscape Terrain each frame.
getLandscapeTerrainVTTilesUpdatePerFrame
void setLandscapeTerrainVTFiltering	Setter and Getter for filtering mode for the Landscape Terrain textures.
getLandscapeTerrainVTFiltering
void setLandscapeTerrainVTDetailLevelByAngle	Setter and Getter for value indicating detail level reduction depending on the inclination of the the Landscape Terrain polygons relative to viewing direction.
getLandscapeTerrainVTDetailLevelByAngle
void setLandscapeTerrainVTTargetResolution	Setter and Getter for target resolution (width x height) for the Landscape Terrain, in pixels.
getLandscapeTerrainVTTargetResolution
void setLandscapeTerrainVTMemorySize	Setter and Getter for value defining memory consumption for the Landscape Terrain textures.
getLandscapeTerrainVTMemorySize
void setLandscapeTerrainTexelSize	Setter and Getter for texel size of the Landscape Terrain render textures representing the maximum level of detail for the albedo, normal, and height components of the Landscape Terrain.
getLandscapeTerrainTexelSize
void setLandscapeTerrainVisibleDistance	Setter and Getter for maximum visibility distance for the Landscape Terrain, in meters.
getLandscapeTerrainVisibleDistance
void setLandscapeTerrainMaskDithering	Setter and Getter for global dither amount multiplier to be used for rendering details of the Landscape Terrain.
getLandscapeTerrainMaskDithering
void setFfpAntialiasingLines	Setter and Getter for value indicating if antialiasing is enabled for rrendering of the Visualizer and other FFP lines.
getFfpAntialiasingLines
void setWireframeAntialiasing	Setter and Getter for value indicating if antialiasing is enabled for wireframe rendering.
getWireframeAntialiasing
getEnvironmentHazePhysicalSunColorSaturation	Returns Returns the current intensity of the impact of the sunlight on haze (how much the sunlight affects the haze).
getEnvironmentHazePhysicalSunLightIntensity	Returns intensity of the impact of the sunlight on haze defining how much the sunlight affects the haze.
getEnvironmentHazePhysicalAmbientColorSaturation	Returns intensity of the ambient color's contribution to the haze (how much the sunlight affects the haze).
getEnvironmentHazePhysicalAmbientLightIntensity	Returns intensity of the impact of the ambient lighting on haze (how much the ambient lighting affects the haze).
getEnvironmentHazePhysicalHalfFalloffHeight	Returns current height of the haze density gradient.
getEnvironmentHazePhysicalHalfVisibilityDistance	Returns distance to the boundary at which the visibility comprises 50%.
getEnvironmentHazePhysicalStartHeight	Returns reference height value for the two parameters (Half Visibility Distance and Half Faloff Height).
void setTessellationDensityMultiplier	Setter and Getter for global Density multiplier for the adaptive hardware-accelerated tessellation.
getTessellationDensityMultiplier
void setTessellationShadowDensityMultiplier	Setter and Getter for global Shadow Density multiplier for the Tessellated Displacement effect.
getTessellationShadowDensityMultiplier
void setTessellationDistanceMultiplier	Setter and Getter for global multiplier for all distance parameters of the adaptive hardware-accelerated tessellation used for distance-dependent optimization.
getTessellationDistanceMultiplier
void setLightmapColor	Setter and Getter for color multiplier for lightmaps.
getLightmapColor	Setter and Getter for color multiplier for lightmaps.
void setSSRViewBias	Setter and Getter for bias value to which the ray starting position has been shifted along the view vector.
getSSRViewBias
void setSSRNormalBias	Setter and Getter for bias value to which the ray starting position has been shifted along the normal vector.
getSSRNormalBias
void setSSGIIntensityBoost	Setter and Getter for boost intensity value.
getSSGIIntensityBoost	Setter and Getter for boost intensity value.
void setSRAADepthThreshold	Setter and Getter for depth threshold value used for edges detection that specifies the area for the SRAA processing.
getSRAADepthThreshold
void setSRAADebug	Setter and Getter for value indicating if the SRAA debug mode is enabled.
getSRAADebug
void setSRAATemporal	Setter and Getter for value indicating if TAA integration is enabled.
getSRAATemporal
void setSRAASamples	Setter and Getter for number of depth geometry samples per pixel.
getSRAASamples
void setSRAA	Setter and Getter for value indicating if Subpixel Reconstruction Anti-Aliasing (SRAA) is enabled.
getSRAA
void setPanoramaFisheyeFov	Setter and Getter for Field of View (in degrees) for the currently selected panoramic viewport mode.
getPanoramaFisheyeFov
void setShowVoxelProbeVisualizerSphereScale	Setter and Getter for scale factor of the sphere that is used to visualize Voxel Probes.
getShowVoxelProbeVisualizerSphereScale
void setShowVoxelProbeVisualizerGridSize	Setter and Getter for size of the grid that is used to visualize Voxel Probes.
getShowVoxelProbeVisualizerGridSize
void setShowVoxelProbeVisualizer	Setter and Getter for value indicating if the Voxel Probe visualizer is enabled.
getShowVoxelProbeVisualizer
void setClouds3dTextureVerticalResolution	Setter and Getter for vertical resolution for the 3D texture to be used for clouds rendering.
getClouds3dTextureVerticalResolution
void setClouds3dTextureHorizontalResolution	Setter and Getter for horizontal resolution for the 3D texture to be used for clouds rendering.
getClouds3dTextureHorizontalResolution
void setCloudsLightingSamplesDistribution	Setter and Getter for value that controls distribution of samples for clouds lighting.
getCloudsLightingSamplesDistribution
void setCloudsTransparentOrder	Setter and Getter for rendering order for clouds relative to transparent objects (except water).
getCloudsTransparentOrder
getCloudsQualityPresetNumNames	Returns number of clouds quality presets.
void setCloudsQualityPreset	Setter and Getter for index of the currently used clouds quality preset.
getCloudsQualityPreset
void setLandscapeOperationsPerFrame	Setter and Getter for maximum number of Landscape texture draw operations (asyncTextureDraw) that can be performed per frame.
getLandscapeOperationsPerFrame
getLandscapeTerrainStreamingPresetNumNames	Returns number of Landscape Terrain streaming presets.
void setLandscapeTerrainStreamingPreset	Setter and Getter for index of the currently used Landscape Terrain streaming preset.
getLandscapeTerrainStreamingPreset
getLandscapeTerrainGeometryPresetNumNames	Returns number of Landscape Terrain geometry presets.
void setLandscapeTerrainGeometryPreset	Setter and Getter for index of the currently used Landscape Terrain geometry preset.
getLandscapeTerrainGeometryPreset
getWaterGeometryPresetNumNames	Returns number of Global Water geometry presets.
void setWaterGeometryPreset	Setter and Getter for index of the currently used Global Water geometry preset.
getWaterGeometryPreset
getDOFPresetNumNames	Returns number of DoF presets.
void setDOFPreset	Setter and Getter for DoF effect quality preset.
getDOFPreset	Setter and Getter for DoF effect quality preset.
getMotionBlurPresetNumNames	Returns number of Motion Blur presets.
void setMotionBlurPreset	Setter and Getter for Motion Blur preset.
getMotionBlurPreset	Setter and Getter for Motion Blur preset.
getSSSSSPresetNumNames	Returns number of SSSSS (Screen-Space Subsurface Scattering) presets.
void setSSSSSPreset	Setter and Getter for currently used SSSSS (Screen-Space Subsurface Scattering) preset.
getSSSSSPreset
getSSRPresetNumNames	Returns number of SSR (Screen-Space Reflections) presets.
void setSSRPreset	Setter and Getter for currently used SSR (Screen-Space Reflections) preset.
getSSRPreset
void setBentNormalColorClampingVelocityThreshold	Setter and Getter for sensitivity of TAA color clamping for the bent normals effect to pixel velocity change.
getBentNormalColorClampingVelocityThreshold
void setBentNormalColorClampingIntensity	Setter and Getter for intensity of TAA color clamping at zero pixel velocity for the bent normals effect.
getBentNormalColorClampingIntensity
void setBentNormalDenoiseRadius	Setter and Getter for radius of the area to be affected by noise reduction for the bent normal effect.
getBentNormalDenoiseRadius
void setBentNormalDenoiseThreshold	Setter and Getter for threshold value for color difference of neighboring pixels used for noise reduction for the bent normals effect.
getBentNormalDenoiseThreshold
void setBentNormalDenoiseGaussianSigma	Setter and Getter for sigma parameter of Gaussian blur used for noise reduction for the bent normals effect.
getBentNormalDenoiseGaussianSigma
void setBentNormalDenoiseIntensity	Setter and Getter for noise reduction intensity for the Bent Normals effect.
getBentNormalDenoiseIntensity
getBentNormalPresetNumNames	Returns number of Bent Normal presets.
void setBentNormalPreset	Setter and Getter for currently used Bent Normal preset.
getBentNormalPreset	Setter and Getter for currently used Bent Normal preset.
getSSGIPresetNumNames	Returns number of SSGI (Screen-Space Global Illumination) presets.
void setSSGIPreset	Setter and Getter for currently used SSGI (Screen-Space Global Illumination) preset.
getSSGIPreset
void setSSAOColorClampingVelocityThreshold	Setter and Getter for sensitivity of TAA color clamping for the SSAO (Screen Space Ambient Occlusion) effect to pixel velocity change.
getSSAOColorClampingVelocityThreshold
void setSSAOColorClampingIntensity	Setter and Getter for intensity of TAA color clamping at zero pixel velocity for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAOColorClampingIntensity
void setSSAODenoiseRadius	Setter and Getter for radius of the area to be affected by noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAODenoiseRadius
void setSSAODenoiseThreshold	Setter and Getter for threshold value for color difference of neighboring pixels used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAODenoiseThreshold
void setSSAODenoiseGaussianSigma	Setter and Getter for sigma parameter of Gaussian blur used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAODenoiseGaussianSigma
void setSSAODenoiseIntensity	Setter and Getter for noise reduction intensity for the SSAO (Screen Space Ambient Occlusion) effect.
getSSAODenoiseIntensity
getSSAOPresetNumNames	Returns number of SSAO (Screen-Space Ambient Occlusion) presets.
void setSSAOPreset	Setter and Getter for currently used SSAO (Screen-Space Ambient Occlusion) preset.
getSSAOPreset
getSSRTGIPresetNumNames	Returns number of SSRTGI (Screen-Space Ray-Traced Global Illumination) presets.
void setSSRTGIPreset	Setter and Getter for index of the currently used SSRTGI (Screen-Space Ray-Traced Global Illumination) preset.
getSSRTGIPreset
getGIPresetNumNames	Returns number of GI (Global Illumination) presets.
void setGIPreset	Setter and Getter for index of the currently used GI (Global Illumination) preset.
getGIPreset
void setRefractionWarpBackgroundTransparentSurfaces	Setter and Getter for value indicating if refraction affects background transparent surfaces (except for water and clouds).
getRefractionWarpBackgroundTransparentSurfaces
getTAAPresetNumNames	Returns number of TAA (Temporal Anti-Aliasing) presets.
void setTAAPreset	Setter and Getter for currently used TAA (Temporal Anti-Aliasing) preset.
getTAAPreset
getAAPresetNumNames	Returns number of AA (Anti-Aliasing) presets.
void setAAPreset	Setter and Getter for index of the currently used AA (Anti-Aliasing) preset.
getAAPreset
void setACESWithReinhardShoulderLength	Setter and Getter for shoulder length parameter for the ACES with Reinhard operator.
getACESWithReinhardShoulderLength
void setACESWithReinhardShoulderStrength	Setter and Getter for shoulder strength parameter for the ACES with Reinhard operator.
getACESWithReinhardShoulderStrength
void setACESWithReinhardShoulderAngle	Setter and Getter for shoulder angle parameter for the ACES with Reinhard operator.
getACESWithReinhardShoulderAngle
void setACESWithReinhardToe	Setter and Getter for toe parameter for the ACES with Reinhard operator.
getACESWithReinhardToe
void setACESWithReinhardWhiteClip	Setter and Getter for white clip parameter for the ACES with Reinhard operator.
getACESWithReinhardWhiteClip
void setACESShoulderLength	Setter and Getter for shoulder length parameter for the ACES operator.
getACESShoulderLength
void setACESShoulderStrength	Setter and Getter for shoulder strength parameter for the ACES operator.
getACESShoulderStrength
void setACESShoulderAngle	Setter and Getter for shoulder angle parameter for the ACES operator.
getACESShoulderAngle
void setACESToe	Setter and Getter for toe parameter for the ACES operator.
getACESToe	Setter and Getter for toe parameter for the ACES operator.
void setACESWhiteClip	Setter and Getter for white clip parameter for the ACES operator.
getACESWhiteClip
void setACESWithReinhardMix	Setter and Getter for ACES with Reinhard tonemapping operator contribution.
getACESWithReinhardMix
void setReinhardLumaBasedContribution	Setter and Getter for Reinhard Luma Based tonemapping operator contribution.
getReinhardLumaBasedContribution
void setReinhardContribution	Setter and Getter for Reinhard tonemapping operator contribution.
getReinhardContribution
void setTonemapper	Setter and Getter for mode of tone mapping.
getTonemapper	Setter and Getter for mode of tone mapping.
void setWaterWaterlineAccuracy	Setter and Getter for quality of underwater and waterline determination.
getWaterWaterlineAccuracy
void setWaterCullingObliqueFrustum	Setter and Getter for multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane.
getWaterCullingObliqueFrustum
void setWaterCullingFrustumPadding	Setter and Getter for value, by which the borders of the current frustum are increased.
getWaterCullingFrustumPadding
void setWaterCullingAggressive	Setter and Getter for value indicating if frustum culling optimization is enabled for the Global Water.
getWaterCullingAggressive
void setWaterGeometrySubpixelReduction	Setter and Getter for minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport.
getWaterGeometrySubpixelReduction
void setWaterGeometryFadeLods	Setter and Getter for intensity of fading between levels of Global Water geometry tessellation.
getWaterGeometryFadeLods
void setWaterGeometryProgression	Setter and Getter for progression of Global Water geometry tessellation.
getWaterGeometryProgression
void setWaterGeometryPolygonSize	Setter and Getter for size of Global Water polygons.
getWaterGeometryPolygonSize	Setter and Getter for size of Global Water polygons.
void setWaterVisibleDistance	Setter and Getter for maximum visibility distance for the Global Water.
getWaterVisibleDistance
void setStreamingUpdateLimit	Setter and Getter for maximum cache update limit.
getStreamingUpdateLimit	Setter and Getter for maximum cache update limit.
void setDistanceOffset	Setter and Getter for global distance offset for all distance parameters: shadow distance, light distance, LOD distances, etc.
getDistanceOffset
void setEnvironmentHemisphere	Setter and Getter for value indicating if rendering of environment only for the top (above-ground) hemisphere is enabled.
getEnvironmentHemisphere
void setWaterPlanarProbes	Setter and Getter for
getWaterPlanarProbes	Setter and Getter for
getNumDebugMaterials	Returns
setEnabled	Enables or disables the render.
isEnabled	Returns a value indicating if the render is enabled.
isAPISupported	Returns a value indicating if the specified graphics API (Null/OpenGL/DirectX) is currently supported.
beginDebugGroup	Starts a GPU debug group with a specified name in Microprofiler.
endDebugGroup	Ends a GPU debug group previously started via the beginDebugGroup() method.
destroyCacheTexture	Deletes cache (images and metadata) stored on disk for the texture with the specified GUID.
createCacheTexture	Generates cache for the texture with the specified GUID.
destroyCacheTextures	Clears texture cache (images and metadata) stored on disk.
unloadCacheTextures	Unloads texture cache from the memory.
createCacheTextures	Generates texture cache for all textures used in the project.
loadCacheTextures	Loads texture cache from the disk.
getScreenshot	Takes a screenshot and puts it to the specified image.
getMaxTextureBufferSize	Returns the maximum size of the texture buffer.
addScriptableMaterial	Adds a new global scriptable material.
insertScriptableMaterial	Inserts a new global scriptable material to the list of globally applied scriptable materials.
removeScriptableMaterial	Removes the global scriptable material with the specified number.
findScriptableMaterial	Returns the number of the specified scriptable material applied globally.
setScriptableMaterial	Replaces the scriptable material with the specified number with the new scriptable material specified.
getScriptableMaterial	Returns a scriptable material applied globally by its number.
setScriptableMaterialEnabled	Enables or disables the scriptable material with the specified number.
getScriptableMaterialEnabled	Returns a value indicating if the scriptable material with the specified number is enabled (active).
swapScriptableMaterials	Swaps two scriptable materials with specified numbers.
clearScriptableMaterials	Clears all global scriptable materials.
getTemporaryTexture	Allocates a temporary render texture with the specified width, height, format, and flags.
getTemporary2DArrayTexture	Allocates a temporary 2D array texture with the specified width, height, number of layers, format, and flags.
getTemporary3DTexture	Allocates a temporary 3D texture with the specified width, height, depth, format, and flags.
releaseTemporaryTexture	Releases the temporary texture previously obtained via getTemporaryTexture(), getTemporary2DArrayTexture(), or getTemporary3DTexture() method and returns it to the pool.
getTemporaryRenderTarget	Allocates a temporary render target.
releaseTemporaryRenderTarget	Releases the temporary render target previously obtained via getTemporaryRenderTarget() method and returns it to the pool.
compressImage	Converts the image to a specified compressed format.
compressTexture	Compresses the given texture to the specified format.
convertColorSpecularToMetalness	Performs color conversion from the specular workflow (diffuse, specular) to the metalness workflow (albedo, shading).
convertImageSpecularToMetalness	Performs texture conversion from the specular workflow (diffuse, specular) to the metalness workflow (albedo, shading).
createMipmapsCubeGGXImage	Generates mipmaps for a cubemap image using GGX BRDF microfacet model.
createMipmapsCubeGGXTexture	Generates mipmaps for a cubemap texture using GGX BRDF microfacet model.
createShorelineDistanceField	Grabs a shoreline distance field texture with the specified parameters.
setColorCorrectionLUTImage	Sets a new color transformation image (LUT).
getColorCorrectionLUTImage	Return the current color transformation image (LUT).
resetColorCorrectionCurve	Resets the Color Correction curve to the default value.
resetColorCorrectionSaturationCurve	Resets the Saturation Correction curve to the default value.
loadSettings	Loads render settings from a given file.
loadWorld	Loads render state from the Xml.
renderImage2D	Renders the scene into a 2D image in accordance with the specified parameters.
renderImageCube	Renders the scene into a cube map image in accordance with the specified parameters.
renderNodeImage2D	Renders the given node into a 2D image in accordance with the specified parameters.
renderScreenMaterial
saveSettings	Saves the current renderer settings to a given file.
saveState	Saves a render state into the stream.
restoreState	Restores a render state from the stream.
saveWorld	Saves the render state into the given Xml node.
getEnvironmentPreset	Returns the environment preset of the given number.
getCloudsQualityPresetName	Returns the Clouds Quality preset name by given index.
getAAPresetName	Returns the AA (Anti-Aliasing) preset name by given index.
getTAAPresetName	Returns the TAA (Temporal Anti-Aliasing) preset name by given index.
getGIPresetName	Returns the GI (Global Illumination) preset name by given index.
getSSRTGIPresetName	Returns the SSRTGI (Screen-Space Ray-Traced Global Illumination) preset name by given index.
getSSAOPresetName	Returns the SSAO (Screen Space Ambient Occlusion) preset name by given index.
getSSGIPresetName	Returns the SSGI (Screen-Space Global Illumination) preset name by given index.
getBentNormalPresetName	Returns the Bent Normal preset name by given index.
getSSRPresetName	Returns the SSR preset name by given index.
getSSSSSPresetName	Returns the SSSSS preset name by given index.
getMotionBlurPresetName	Returns the Motion Blur preset name by given index.
getDOFPresetName	Returns the DOF preset name by given index.
getLandscapeTerrainGeometryPresetName	Returns the Landscape Terrain Geometry preset name by given index.
getLandscapeTerrainStreamingPresetName	Returns the Landscape Terrain Streaming preset name by given index.
getWaterGeometryPresetName	Returns the Global Water Geometry preset name by given index.
isViewportModeStereo	Returns a value indicating if the specified mode is one of the stereo rendering modes.
isViewportModePanorama	Returns a value indicating if the specified mode is one of the panorama rendering modes.
clearDebugMaterials	Clears all global debug materials.
setDebugMaterial	Replaces the debug material with the specified number with the new debug material specified.
getDebugMaterial	Returns a debug material applied globally by its number.
insertDebugMaterial	Inserts a new global debug material to the list of globally applied debug materials.
findDebugMaterial	Returns the number of the specified debug material applied globally.
addDebugMaterial	Adds a new global debug material.
removeDebugMaterial	Removes the global debug material with the specified number.
swapDebugMaterials	Swaps two debug materials with specified numbers.
setDebugMaterialEnabled	Enables or disables the debug material with the specified number.
getDebugMaterialEnabled	Returns a value indicating if the debug material with the specified number is enabled (active).
getCacheTexture

Variables:

Name	Description
API_UNKNOWN = 0	Unknown API.
API_NULL = 1	Null API name.
API_OPENGL = 2	OpenGL API.
API_DIRECT3D11 = 3	DIRECT3D 11 API.
RENDER_ENVIRONMENT_NUM_PRESETS = 3	Number of environment presets.
RENDER_EXPOSURE_DISABLED = 0	Rendering of the adaptive exposure effect is disabled.
RENDER_EXPOSURE_LOGARITHMIC = 1	The logarithmic exposure effect is used.
RENDER_EXPOSURE_QUADRATIC = 2	The adaptive exposure effect is rendered using quadratic function.
GPU_AMD = 1	AMD GPU.
GPU_APPLE = 5	Apple GPU.
GPU_ARM = 4	ARM GPU.
GPU_IMGTEC = 6	Imagination Technologies GPU.
GPU_INTEL = 3	Intel GPU.
GPU_NVIDIA = 2	NVIDIA GPU.
GPU_QUALCOMM = 7	Qualcomm GPU.
GPU_UNKNOWN = 0	Unknown GPU.
RENDER_HAZE_DISABLED = 0	Rendering of the haze effect is disabled.
RENDER_HAZE_SCATTERING = 2	Haze colored according to the sky LUT textures. This mode is recommended to achieve higher realism.
RENDER_HAZE_SOLID = 1	Solid color haze. The haze color is set by setHazeColor().
RENDER_NUM_PASSES = 54	Total number of rendering passes.
RENDER_PASS_ALPHA_TEST	Alpha test pass.
RENDER_PASS_AMBIENT = 8	Ambient pass.
RENDER_PASS_AUXILIARY = 3	Auxiliary pass.
RENDER_PASS_DEFERRED = 2	Deferred pass.
RENDER_PASS_DEPTH_PRE_PASS = 16	Depth pre-pass.
RENDER_PASS_MS_DEPTH = 17	MS depth pass.
RENDER_PASS_EMISSION = 4	Emission pass.
RENDER_PASS_LIGHT_ENVIRONMENT_PROBE = 10	Light environment probe pass.
RENDER_PASS_LIGHT_PLANAR_PROBE = 11	Light planar probe pass.
RENDER_PASS_LIGHT_OMNI = 12	Omni light pass.
RENDER_PASS_LIGHT_PROJ = 13	Proj light pass.
RENDER_PASS_LIGHT_VOXEL_PROBE = 9	Light voxel probe pass.
RENDER_PASS_LIGHT_WORLD = 14	World light pass.
RENDER_PASS_PROCEDURAL_FIELDS = 20	Pass for rendering of particles into procedural textures to be used by height fields.
RENDER_PASS_PROCEDURAL_DECALS = 19	Pass for rendering of particles into procedural textures to be used by orthographic decals.
RENDER_PASS_POST = 18	Post materials pass.
RENDER_PASS_REFLECTION = 5	Reflection pass.
RENDER_PASS_REFRACTION = 6	Refraction pass.
RENDER_PASS_SHADOW = 15	Shadow pass.
RENDER_PASS_TRANSPARENT_BLUR = 7	Transparent blur pass.
RENDER_PASS_VISUALIZER_SOLID = 1	Visualizer pass.
RENDER_PASS_WIREFRAME = 0	Wireframe pass.
RENDER_PASS_CUSTOM_BEGIN	Beginning of the range of custom rendering passes. Up to 32 custom rendering passes are available.
RENDER_PASS_CUSTOM_0 = 21	Custom pass (unassigned).
RENDER_PASS_CUSTOM_1 = 22	Custom pass (unassigned).
RENDER_PASS_CUSTOM_2 = 23	Custom pass (unassigned).
RENDER_PASS_CUSTOM_3 = 24	Custom pass (unassigned).
RENDER_PASS_CUSTOM_4 = 25	Custom pass (unassigned).
RENDER_PASS_CUSTOM_5 = 26	Custom pass (unassigned).
RENDER_PASS_CUSTOM_6 = 27	Custom pass (unassigned).
RENDER_PASS_CUSTOM_7 = 28	Custom pass (unassigned).
RENDER_PASS_CUSTOM_8 = 29	Custom pass (unassigned).
RENDER_PASS_CUSTOM_9 = 30	Custom pass (unassigned).
RENDER_PASS_CUSTOM_10 = 31	Custom pass (unassigned).
RENDER_PASS_CUSTOM_11 = 32	Custom pass (unassigned).
RENDER_PASS_CUSTOM_12 = 33	Custom pass (unassigned).
RENDER_PASS_CUSTOM_13 = 34	Custom pass (unassigned).
RENDER_PASS_CUSTOM_14 = 35	Custom pass (unassigned).
RENDER_PASS_CUSTOM_15 = 36	Custom pass (unassigned).
RENDER_PASS_CUSTOM_16 = 37	Custom pass (unassigned).
RENDER_PASS_CUSTOM_17 = 38	Custom pass (unassigned).
RENDER_PASS_CUSTOM_18 = 39	Custom pass (unassigned).
RENDER_PASS_CUSTOM_19 = 40	Custom pass (unassigned).
RENDER_PASS_CUSTOM_20 = 41	Custom pass (unassigned).
RENDER_PASS_CUSTOM_21 = 42	Custom pass (unassigned).
RENDER_PASS_CUSTOM_22 = 43	Custom pass (unassigned).
RENDER_PASS_CUSTOM_23 = 44	Custom pass (unassigned).
RENDER_PASS_CUSTOM_24 = 45	Custom pass (unassigned).
RENDER_PASS_CUSTOM_25 = 46	Custom pass (unassigned).
RENDER_PASS_CUSTOM_26 = 47	Custom pass (unassigned).
RENDER_PASS_CUSTOM_27 = 48	Custom pass (unassigned).
RENDER_PASS_CUSTOM_28 = 49	Custom pass (unassigned).
RENDER_PASS_CUSTOM_29 = 50	Custom pass (unassigned).
RENDER_PASS_CUSTOM_30 = 51	Custom pass (unassigned).
RENDER_PASS_CUSTOM_31 = 52	Custom pass (unassigned).
RENDER_PASS_CUSTOM_32 = 53	Custom pass (unassigned).
RENDER_PASS_CUSTOM_END	End of the range of custom rendering passes. Up to 32 custom rendering passes are available.
RENDER_QUALITY_HIGH = 2	High quality of textures.
RENDER_QUALITY_LOW = 0	Low quality of textures. 1/16 of the original texture will be used.
RENDER_QUALITY_MEDIUM = 1	Medium quality of textures. 1/4 of the original texture will be used.
RENDER_CALLBACK_BEGIN = 0	Beginning of the callback range.
RENDER_NUM_CALLBACKS = 76	Callback counter.
RENDER_CALLBACK_END = 75	End of the callback range.
RENDER_CALLBACK_END_VISUALIZER = 73	Callback after the visualizer rendering stage.
RENDER_CALLBACK_BEGIN_VISUALIZER = 72	Callback before the visualizer rendering stage.
RENDER_CALLBACK_END_DEBUG_MATERIALS = 71	Callback after the debug materials stage.
RENDER_CALLBACK_BEGIN_DEBUG_MATERIALS = 70	Callback before the debug materials stage.
RENDER_CALLBACK_END_POST_MATERIALS = 69	Callback after the post materials rendering stage.
RENDER_CALLBACK_BEGIN_POST_MATERIALS = 68	Callback before the post materials rendering stage.
RENDER_CALLBACK_END_CAMERA_EFFECTS = 67	Callback after the camera effects stage.
RENDER_CALLBACK_BEGIN_CAMERA_EFFECTS = 66	Callback before the camera effects stage.
RENDER_CALLBACK_END_TAA = 65	Callback after the Temporal Anti-Aliasing (TAA) pass.
RENDER_CALLBACK_BEGIN_TAA = 64	Callback before the Temporal Anti-Aliasing (TAA) pass.
RENDER_CALLBACK_END_SRGB_CORRECTION = 59	Callback after the sRGB correction stage.
RENDER_CALLBACK_BEGIN_SRGB_CORRECTION = 58	Callback before the sRGB correction stage.
RENDER_CALLBACK_BEGIN_TRANSPARENT = 42	Callback before the transparent objects rendering stage.
RENDER_CALLBACK_END_TRANSPARENT = 57	Callback after the transparent objects rendering stage.
RENDER_CALLBACK_BEGIN_WATER = 45	Callback before the water rendering stage.
RENDER_CALLBACK_END_WATER = 56	Callback after the water rendering stage.
RENDER_CALLBACK_END_WATER_ENVIRONMENT_PROBES = 53	Callback after the water environment probes rendering stage.
RENDER_CALLBACK_BEGIN_WATER_ENVIRONMENT_PROBES = 52	Callback before the water environment probes rendering stage.
RENDER_CALLBACK_BEGIN_WATER_VOXEL_PROBES = 50	Callback before the water voxel probes rendering stage.
RENDER_CALLBACK_END_WATER_VOXEL_PROBES = 51	Callback after the water voxel probes rendering stage.
RENDER_CALLBACK_BEGIN_WATER_LIGHTS = 48	Callback before the water lights rendering stage.
RENDER_CALLBACK_END_WATER_LIGHTS = 49	Callback after the water lights rendering stage.
RENDER_CALLBACK_BEGIN_WATER_DECALS = 46	Callback before the water decals rendering stage.
RENDER_CALLBACK_END_WATER_DECALS = 47	Callback after the water decals rendering stage.
RENDER_CALLBACK_BEGIN_CLOUDS = 43	Callback before the clouds rendering stage.
RENDER_CALLBACK_END_CLOUDS = 44	Callback after the clouds rendering stage.
RENDER_CALLBACK_BEGIN_COMPOSITE_DEFERRED = 40	Callback before the clouds deferred composite stage.
RENDER_CALLBACK_END_COMPOSITE_DEFERRED = 41	Callback after the clouds deferred composite stage.
RENDER_CALLBACK_BEGIN_SSGI = 38	Callback before the SSGI rendering stage.
RENDER_CALLBACK_END_SSGI = 39	Callback after the SSGI rendering stage.
RENDER_CALLBACK_BEGIN_SSAO = 36	Callback before the SSAO rendering stage.
RENDER_CALLBACK_END_SSAO = 37	Callback after the SSAO rendering stage.
RENDER_CALLBACK_BEGIN_SSR = 34	Callback before the SSR rendering stage.
RENDER_CALLBACK_END_SSR = 35	Callback after the SSR rendering stage.
RENDER_CALLBACK_BEGIN_TRANSPARENT_BLUR_BUFFER = 32	Callback before filling the transparent blur buffer.
RENDER_CALLBACK_END_TRANSPARENT_BLUR_BUFFER = 33	Callback after filling the transparent blur buffer.
RENDER_CALLBACK_BEGIN_REFRACTION_BUFFER = 30	Callback before filling the refraction buffer.
RENDER_CALLBACK_END_REFRACTION_BUFFER = 31	Callback after filling the refraction buffer.
RENDER_CALLBACK_BEGIN_AUXILIARY_BUFFER = 28	Callback before filling the auxiliary buffer.
RENDER_CALLBACK_END_AUXILIARY_BUFFER = 29	Callback after filling the auxiliary buffer.
RENDER_CALLBACK_END_WATER_PLANAR_PROBES = 55	Callback after the water planar probes rendering stage.
RENDER_CALLBACK_BEGIN_WATER_PLANAR_PROBES = 54	Callback before the water planar probes rendering stage.
RENDER_CALLBACK_END_OPACITY_PLANAR_PROBES = 27	Callback after the opacity planar probes rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_PLANAR_PROBES = 26	Callback before the opacity planar probes rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_ENVIRONMENT_PROBES = 24	Callback before the opacity environment probes rendering stage.
RENDER_CALLBACK_END_OPACITY_ENVIRONMENT_PROBES = 25	Callback after the opacity environment probes rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_VOXEL_PROBES = 22	Callback before the opacity voxel probes rendering stage.
RENDER_CALLBACK_END_OPACITY_VOXEL_PROBES = 23	Callback after the opacity voxel probes rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_LIGHTS = 20	Callback before the opacity lightgs rendering stage.
RENDER_CALLBACK_END_OPACITY_LIGHTS = 21	Callback after the opacity lightgs rendering stage.
RENDER_CALLBACK_BEGIN_SSRTGI = 18	Callback before the SSRTGI rendering stage.
RENDER_CALLBACK_END_SSRTGI = 19	Callback after the SSRTGI rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_DECALS = 12	Callback before the opacity decals rendering stage.
RENDER_CALLBACK_END_OPACITY_DECALS = 13	Callback after the opacity decals rendering stage.
RENDER_CALLBACK_BEGIN_OPACITY_GBUFFER = 10	Callback before filling the Gbuffer.
RENDER_CALLBACK_END_OPACITY_GBUFFER = 11	Callback after filling the Gbuffer.
RENDER_CALLBACK_BEGIN_ADAPTATION_COLOR = 62	Callback before the color adaptation rendering stage (automatic exposure and white balance correction).
RENDER_CALLBACK_END_ADAPTATION_COLOR = 63	Callback after the color adaptation rendering stage (automatic exposure and white balance correction).
RENDER_CALLBACK_BEGIN_ADAPTATION_COLOR_AVERAGE = 60	Callback before the calculation of automatic exposure and white balance correction.
RENDER_CALLBACK_END_ADAPTATION_COLOR_AVERAGE = 61	Callback after the calculation of automatic exposure and white balance correction.
RENDER_CALLBACK_BEGIN_CURVATURE_COMPOSITE = 16	Callback before the curvature rendering stage for the SSDirt effect.
RENDER_CALLBACK_END_CURVATURE_COMPOSITE = 17	Callback after the curvature rendering stage for the SSDirt effect.
RENDER_CALLBACK_BEGIN_CURVATURE = 14	Callback before the SSBevel effect rendering stage.
RENDER_CALLBACK_END_CURVATURE = 15	Callback after the SSBevel effect rendering stage.
RENDER_CALLBACK_END_SCREEN = 74	Callback after the stage of rendering each screen (a stereo image has 2 screens, while a cubemap will have 6).
RENDER_CALLBACK_BEGIN_SCREEN = 9	Callback before the stage of rendering each screen (a stereo image has 2 screens, while a cubemap will have 6).
RENDER_CALLBACK_END_SHADOWS = 8	Callback after the shadows rendering stage.
RENDER_CALLBACK_END_OMNI_SHADOW = 7	Callback after the stage of rendering shadows from Omni light sources.
RENDER_CALLBACK_BEGIN_OMNI_SHADOW = 6	Callback before the stage of rendering shadows from Omni light sources.
RENDER_CALLBACK_END_PROJ_SHADOW = 5	Callback after the stage of rendering shadows from Projected light sources.
RENDER_CALLBACK_BEGIN_PROJ_SHADOW = 4	Callback before the stage of rendering shadows from Projected light sources.
RENDER_CALLBACK_END_WORLD_SHADOW = 3	Callback after the stage of rendering shadows from World light sources.
RENDER_CALLBACK_BEGIN_WORLD_SHADOW = 2	Callback before the stage of rendering shadows from World light sources.
RENDER_CALLBACK_BEGIN_SHADOWS = 1	Callback before the shadows rendering stage.
STREAMING_FORCE = 1	Forced mode enabling force-loading of all meshes and/or textures required for each frame at once. Notice Can be used for grabbing frame sequences, rendering node previews, warmup, etc.
STREAMING_ASYNC = 0	Asynchronous streaming mode for meshes and textures.
RENDER_CORRECT_ROUGHNESS_DISABLED = 0	Disabled roughness correction.
RENDER_CORRECT_ROUGHNESS_LOW = 1	Roughness correction of minimum quality.
RENDER_CORRECT_ROUGHNESS_MEDIUM = 2	Roughness correction of medium quality.
RENDER_CORRECT_ROUGHNESS_HIGH = 3	Roughness correction of high quality.
RENDER_CORRECT_ROUGHNESS_ULTRA = 4	Roughness correction of ultra-high quality.
RENDER_VIEWPORT_MODE_DEFAULT = 0	Enables 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.
RENDER_VIEWPORT_MODE_PANORAMA_CURVED_180 = 1	Enables rendering of the viewport as a panorama with curved edges with an angle of 180 degrees.
RENDER_VIEWPORT_MODE_PANORAMA_CURVED_360 = 2	Enables rendering of the viewport as a panorama with curved edges with an angle of 360 degrees.
RENDER_VIEWPORT_MODE_PANORAMA_LINEAR_180 = 3	Enables rendering of the viewport as a linear panorama without distortion at the edges with an angle of 180 degrees.
RENDER_VIEWPORT_MODE_PANORAMA_LINEAR_360 = 4	Enables rendering of the viewport as a linear panorama without distortion at the edges with an angle of 360 degrees.
RENDER_VIEWPORT_MODE_PANORAMA_FISHEYE_ORTHOGRAPHIC = 5	Enables rendering of the viewport as an orthographic spherical panorama (fisheye).
RENDER_VIEWPORT_MODE_PANORAMA_FISHEYE_EQUDISTANT = 6	Enables rendering of the viewport as an equidistant spherical panorama (fisheye).
RENDER_VIEWPORT_MODE_PANORAMA_FISHEYE_STEREOGRAPHIC = 7	Enables rendering of the viewport as an stereographic spherical panorama (fisheye).
RENDER_VIEWPORT_MODE_PANORAMA_FISHEYE_EQUISOLID = 8	Enables rendering of the viewport as an equisolid spherical panorama (fisheye).
RENDER_VIEWPORT_MODE_STEREO_ANAGLYPH = 9	Enables the anaglyph stereo mode that is viewed with red-cyan anaglyph glasses.
RENDER_VIEWPORT_MODE_STEREO_INTERLACED = 10	Enables the interlaced stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
RENDER_VIEWPORT_MODE_STEREO_HORIZONTAL = 11	Enables the horizontal stereo mode that is supported on mobile devices.
RENDER_VIEWPORT_MODE_STEREO_VERTICAL = 12	Enables the vertical stereo mode that is supported on mobile devices.
RENDER_VIEWPORT_MODE_STEREO_SEPARATE = 13	Enables the replicate images stereo mode.
RENDER_VIEWPORT_MODE_STEREO_REPLICATE = 14	Enables 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).

Render Class

Members

void engine.render.setEnabled ( int arg1 ) #

Enables or disables the render.

Arguments

int arg1 - 1 to enable the render, 0 to disable it.

int engine.render.isEnabled ( ) #

Returns a value indicating if the render is enabled.

Return value

1 if the render is enabled; otherwise, 0.

int engine.render.isAPISupported ( int api ) #

Returns a value indicating if the specified graphics API (Null/OpenGL/DirectX) is currently supported.

Arguments

int api - Graphics API ID. One of the API_* values.

Return value

1 if the specified graphics API is currently supported; otherwise, 0.

void engine.render.beginDebugGroup ( string name ) #

Starts a GPU debug group with a specified name in Microprofiler.

Arguments

string name - Name of debug group.

void engine.render.endDebugGroup ( ) #

Ends a GPU debug group previously started via the beginDebugGroup() method.

void engine.render.destroyCacheTexture ( UGUID guid ) #

Deletes cache (images and metadata) stored on disk for the texture with the specified GUID. Corresponding files in the data/.cache_textures will be removed.

Arguments

UGUID guid - Texture file GUID.

void engine.render.createCacheTexture ( UGUID guid ) #

Generates cache for the texture with the specified GUID.

NoticeTexture cache generated by this method is incomplete, only images are created, as all metadata (flags, etc.) is stored in materials.

Arguments

UGUID guid - Texture file GUID.

void engine.render.destroyCacheTextures ( ) #

Console: render_streaming_textures_cache_destroy

Clears texture cache (images and metadata) stored on disk. All files in the data/.cache_textures will be removed.

void engine.render.unloadCacheTextures ( ) #

Console: render_streaming_textures_cache_unload

Unloads texture cache from the memory. This method does not delete files in the data/.cache_textures.

void engine.render.createCacheTextures ( ) #

Console: render_streaming_textures_cache_create

Generates texture cache for all textures used in the project.

NoticeTexture cache generated by this method is incomplete, only images are created, as all metadata (flags, etc.) is stored in materials.

void engine.render.loadCacheTextures ( ) #

Console: render_streaming_textures_cache_load

Loads texture cache from the disk. Texture cache always remains in memory after loading.

void engine.render.getScreenshot ( Image image ) #

Takes a screenshot and puts it to the specified image.

Arguments

Image image - Image to which the screenshot is to be saved.

int engine.render.getMaxTextureBufferSize ( ) #

Returns the maximum size of the texture buffer.

Return value

Maximum size of the texture buffer.

void engine.render.addScriptableMaterial ( Material material ) #

Adds a new global scriptable material. To apply a scriptable material per-camera or per-player, use the addScriptableMaterial() method of the Camera class or the same method of the Player class respectively. The order of execution for scripts assigned to scriptable materials is defined by material's number in the list of materials applied globally.

Notice

Scriptable materials applied globally have their expressions executed before the ones that are applied per-camera or per-player.

Arguments

Material material - Scriptable material to be applied globally.

void engine.render.insertScriptableMaterial ( int num, Material material ) #

Inserts a new global scriptable material to the list of globally applied scriptable materials. To apply a scriptable material per-camera or per-player, use the insertScriptableMaterial() method of the Camera class or the same method of the Player class respectively. The order of execution for scripts assigned to scriptable materials is defined by material's number in the list of materials applied globally.

Notice

Scriptable materials applied globally have their expressions executed before the ones that are applied per-camera or per-player.

Arguments

int num - Position at which a new scriptable material is to be inserted.
Material material - Scriptable material to be inserted into the list of globally applied scriptable materials.

void engine.render.removeScriptableMaterial ( int num ) #

Removes the global scriptable material with the specified number.

Arguments

int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

int engine.render.findScriptableMaterial ( Material material ) #

Returns the number of the specified scriptable material applied globally. This number determines the order in which the assigned expressions are executed.

Notice

Scriptable materials applied globally have their expressions executed before the ones that are applied per-camera or per-player.

Arguments

Material material - Scriptable material for which a number is to be found.

Return value

Scriptable material number in the range from 0 to the total number of scriptable materials, or -1 if the specified material was not found.

void engine.render.setScriptableMaterial ( int num, Material material ) #

Replaces the scriptable material with the specified number with the new scriptable material specified. The number of material determines the order in which the expressions assigned to it are executed.

Notice

Scriptable materials applied globally have their expressions executed before the ones that are applied per-camera or per-player.

Arguments

int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
Material material - New scriptable material to replace the one with the specified number.

Material engine.render.getScriptableMaterial ( int num ) #

Returns a scriptable material applied globally by its number.

Arguments

int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

Return value

Scriptable material applied globally with the specified number.

void engine.render.setScriptableMaterialEnabled ( int num, int enabled ) #

Enables or disables the scriptable material with the specified number. When a material is disabled (inactive), the scripts attached to it are not executed.

Arguments

int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
int enabled - 1 to enable the scriptable material with the specified number, 0 to disable it.

int engine.render.getScriptableMaterialEnabled ( int num ) #

Returns a value indicating if the scriptable material with the specified number is enabled (active). When a material is disabled (inactive), the scripts attached to it are not executed.

Arguments

int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

Return value

1 if the scriptable material with the specified number is enabled; otherwise, 0.

void engine.render.swapScriptableMaterials ( int num_0, int num_1 ) #

Swaps two scriptable materials with specified numbers. The number of material determines the order in which the expressions assigned to it are executed.

Notice

Scriptable materials applied globally have their expressions executed before the ones that are applied per-camera or per-player.

Arguments

int num_0 - Number of the first scriptable material in the range from 0 to the total number of scriptable materials.
int num_1 - Number of the second scriptable material in the range from 0 to the total number of scriptable materials.

void engine.render.clearScriptableMaterials ( ) #

Clears all global scriptable materials.

Texture engine.render.getTemporaryTexture ( int width, int height, int format, int flags = 0, string name = 0 ) #

Allocates a temporary render texture with the specified width, height, format, and flags. This function can be used when you need a quick render texture to perform some temporary calculations. Release it using releaseTemporaryTexture() as soon as you're done with it, so another call can start reusing it, if necessary. In any case, such texture shall be released automatically in the next frame.

UNIGINE keeps an internal pool of temporary render textures, so a call to this method most often just returns an already created one (if the size and format match). These temporary textures are actually destroyed when they aren't used for a couple of frames.

If you are doing a series of post-processing "blits", it's best for performance to get and release a temporary render texture for each blit, instead of getting one or two render textures upfront and reusing them.

NoticeYou can't depend on any particular contents of a temporary texture obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

It also automatically gives names to resources, which can be used for identification in debug.

Arguments

int width - Width of the texture, in pixels.
int height - Height of the texture, in pixels.
int format - Texture format: one of the TEXTURE_FORMAT_* values.
int flags - Texture flags.
string name - Name to be used for this temporary texture (optional).

Return value

Temporary texture.

Texture engine.render.getTemporaryTexture ( Texture texture ) #

NoticeYou can't depend on any particular contents of a temporary texture obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

It also automatically gives names to resources, which can be used for identification in debug.

Arguments

Texture texture - Source texture for which a temporary texture is to be allocated in the pool.

Return value

Temporary texture.

Texture engine.render.getTemporaryTexture ( Texture texture, string name = 0 ) #

Allocates a temporary render texture for the specified source texture (using all its parameters: resolution, flags, etc.). This function can be used when you need a quick render texture to perform some temporary calculations. Release it using releaseTemporaryTexture() as soon as you're done with it, so another call can start reusing it, if necessary. In any case, such texture shall be released automatically in the next frame.

NoticeYou can't depend on any particular contents of a temporary texture obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

It also automatically gives names to resources, which can be used for identification in debug.

Arguments

Texture texture - Source texture for which a temporary texture is to be allocated in the pool.
string name - Name to be used for this temporary texture (optional).

Return value

Temporary texture.

Texture engine.render.getTemporary2DArrayTexture ( int width, int height, int depth, int format, int flags = 0, string name = 0 ) #

Allocates a temporary 2D array texture with the specified width, height, number of layers, format, and flags. This function can be used when you need a quick render texture to perform some temporary calculations. Release it using releaseTemporaryTexture() as soon as you're done with it, so another call can start reusing it, if necessary. In any case, such texture shall be released automatically in the next frame.

NoticeYou can't depend on any particular contents of a temporary texture obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

Arguments

int width - Width of the 2D array texture, in pixels.
int height - Height of the 2D array texture, in pixels.
int depth - Number of layers in the 2D array texture.
int format - Texture format: one of the TEXTURE_FORMAT_* values.
int flags - Texture flags.
string name - Name to be used for this temporary 2D array texture (optional).

Return value

Temporary 2D array texture.

Texture engine.render.getTemporary3DTexture ( int width, int height, int depth, int format, int flags = 0, string name = 0 ) #

Allocates a temporary 3D texture with the specified width, height, depth, format, and flags. This function can be used when you need a quick render texture to perform some temporary calculations. Release it using releaseTemporaryTexture() as soon as you're done with it, so another call can start reusing it, if necessary. In any case, such texture shall be released automatically in the next frame.

NoticeYou can't depend on any particular contents of a temporary texture obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

Arguments

int width - Width of the 3D texture, in pixels.
int height - Height of the 3D texture, in pixels.
int depth - Depth of the 3D texture, in pixels.
int format - Texture format: one of the TEXTURE_FORMAT_* values.
int flags - Texture flags.
string name - Name to be used for this temporary 3D texture (optional).

Return value

Temporary 3D texture.

void engine.render.releaseTemporaryTexture ( Texture texture ) #

Releases the temporary texture previously obtained via getTemporaryTexture(), getTemporary2DArrayTexture(), or getTemporary3DTexture() method and returns it to the pool.

Arguments

Texture texture - Temporary texture or texture array to be returned to the pool.

RenderTarget engine.render.getTemporaryRenderTarget ( ) #

Allocates a temporary render target. This function can be used when you need a quick render target to perform some temporary calculations. Release it using releaseTemporaryRenderTarget() as soon as you're done with it, so another call can start reusing it if necessary. In any case such render target shall be released automatically in the next frame.

UNIGINE keeps an internal pool of temporary render targets, so a call to this method most often just returns an already created one (if the size and format matches). These temporary render targets are actually destroyed when they aren't used for a couple of frames.

If you are doing a series of post-processing "blits", it's best for performance to get and release a temporary render targets for each blit, instead of getting one or two render targets upfront and reusing them.

NoticeYou can't depend on any particular contents of a temporary render target obtained from this function: it might be garbage, or it might be cleared to some color, depending on the platform.

Return value

Temporary render target.

void engine.render.releaseTemporaryRenderTarget ( RenderTarget render_target ) #

Releases the temporary render target previously obtained via getTemporaryRenderTarget() method and returns it to the pool.

Arguments

RenderTarget render_target - Temporary render target to be returned to the pool.

int engine.render.compressImage ( Image & image, int quality = 1, int new_image_format = -1, int use_mip_maps = -1 ) #

Converts the image to a specified compressed format. If compression by the GPU is not supported, the Image::compress() method will be called instead.

Arguments

Image & image - Image to compress.
int quality - Compression quality:
- 0 - fast compression, low compressed image quality.
- 1 - high compressed image quality, slow compression (by default).
int new_image_format - Compressed texture format: one of the TEXTURE_FORMAT_* variables. This is an optional argument. If no format is specified, default conversion will be performed (depending on the type of the source image).
int use_mip_maps - Flag indicating whether texture mipmaps should be generated for the compressed image: 1 to generate mipmaps, 0 not to generate. This is an optional argument. If no value is specified, mipmaps will be generated only if the source image has the mipmaps.

Return value

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

int engine.render.compressTexture ( Texture texture, Image & destination, int quality = 1, int new_texture_format = -1, int use_mip_maps = -1 ) #

Compresses the given texture to the specified format.

Notice

Only 2d and 2d array textures can be compressed.

Arguments

Texture texture - Source texture to compress.
Image & destination - Image into which the compressed texture will be saved.
int quality - Compression quality:
- 0 - fast compression, low compressed image quality.
- 1 - high compressed image quality, slow compression (by default).
int new_texture_format - Compressed texture format: one of the TEXTURE_FORMAT_* variables. This is an optional argument. If no format is specified, default conversion will be performed (depending on the type of the source image).
int use_mip_maps - Flag indicating whether texture mipmaps should be generated for the compressed image: 1 to generate mipmaps, 0 not to generate. This is an optional argument. If no value is specified, mipmaps will be generated only if the source image has the mipmaps.

Return value

1 if the texture has been compressed successfully; otherwise, 0.

void engine.render.convertColorSpecularToMetalness ( vec4 & diffuse, vec4 & specular, vec4 & albedo, vec4 & shading ) #

Performs color conversion from the specular workflow (diffuse, specular) to the metalness workflow (albedo, shading).

Arguments

vec4 & diffuse - Input diffuse color.
vec4 & specular - Input specular color.
vec4 & albedo - Output albedo color.
vec4 & shading - Output shading color.

void engine.render.convertImageSpecularToMetalness ( Image diffuse, Image specular, Image & albedo, Image & shading ) #

Performs texture conversion from the specular workflow (diffuse, specular) to the metalness workflow (albedo, shading).

Arguments

Image diffuse - Input diffuse texture.
Image specular - Input specular texture.
Image & albedo - Output albedo texture.
Image & shading - Output shading texture.

int engine.render.createMipmapsCubeGGXImage ( Image image, float quality ) #

Generates mipmaps for a cubemap image using GGX BRDF microfacet model.

Arguments

Image image - Cubemap image. IMAGE_CUBE or IMAGE_CUBE_ARRAY types are accepted.
float quality - Quality value within the [0.0f; 1.0f] range.

int engine.render.createMipmapsCubeGGXTexture ( Texture texture, float quality ) #

Generates mipmaps for a cubemap texture using GGX BRDF microfacet model.

Arguments

Texture texture - Cubemap texture. TEXTURE_CUBE or TEXTURE_CUBE_ARRAY types are accepted.
float quality - Quality value within the [0.0f; 1.0f] range.

int engine.render.createShorelineDistanceField ( Image image, Image mask, int shoreline_radius, int blur_radius, int downsample_resolution ) #

Grabs a shoreline distance field texture with the specified parameters.

Arguments

Image image - Image to grab a shoreline texture to.
Image mask - An R16 mask texture Image. Each pixel of the mask has the following color value:0 if water level at this point of the grid is above the terrain level; otherwise, 65535.
int shoreline_radius - Shoreline radius value within the [4; 128] range. Padding distance (from the shore to the beginning of swash zone).
int blur_radius - Blur radius value within the [0; 32] range. Higher values make shoreline smoother.
int downsample_resolution - Texture resolution value, can be one of the following: 16, 32, 64, 128, 256, 512, 1024, 2048.

Return value

1 if the shoreline distance field texture is grabbed successfully; otherwise, 0.

int engine.render.setColorCorrectionLUTImage ( Image image ) #

Sets a new color transformation image (LUT). This function resets a LUT texture name to null if it has been previously set via setColorCorrectionLUTPath().

Source code (UnigineScript)

Image lut;
Image lut_0;
Image lut_1;

if(lut == NULL) {
	lut = new Image();
	lut_0 = new Image("unigine_project/textures/lookup_first.dds");
	lut_1 = new Image("unigine_project/textures/lookup_second.dds");
}

float k = sin(engine.game.getTime() * 2.0f) * 0.5f + 0.5f;

lut.copy(lut_0);
lut.blend(lut_1,0,0,0,0,lut.getWidth(),lut.getHeight(),k);

engine.render.setColorCorrectionLUTImage(lut);

Arguments

Image image - Color transformation image.

Return value

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

int engine.render.getColorCorrectionLUTImage ( Image image ) #

Return the current color transformation image (LUT).

Arguments

Image image - Image to store the color transformation texture in.

Return value

1 if an image is successfully received; otherwise, 0.

void engine.render.resetColorCorrectionCurve ( ) #

Resets the Color Correction curve to the default value.

void engine.render.resetColorCorrectionSaturationCurve ( ) #

Resets the Saturation Correction curve to the default value.

int engine.render.loadSettings ( string file, int clear = false ) #

Loads render settings from a given file.

Arguments

string file - Path to an XML file with desired settings.
int clear - Clear flag. Set 1 to clear settings before loading (new settings shall be applied right after loading them), or 0 not to clear.

Return value

1 if the settings are loaded successfully; otherwise, 0.

int engine.render.loadWorld ( Xml xml ) #

Loads render state from the Xml.

Arguments

Xml xml - Xml node.

Return value

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

void engine.render.renderImage2D ( Camera camera, Image image, int skip_flags ) #

Renders the scene into a 2D image in accordance with the specified parameters. The viewport position is taken from the camera created via Camera class.

Arguments

Camera camera - Camera to be used.
Image image - Image to save the result to.
int skip_flags - Skip the effects:
- VIEWPORT_SKIP_SHADOWS
- VIEWPORT_SKIP_VISUALIZER
- VIEWPORT_SKIP_SRGB
- VIEWPORT_SKIP_POSTEFFECTS
- VIEWPORT_SKIP_VELOCITY
- VIEWPORT_SKIP_DYNAMIC_REFLECTIONS
0 enables all the effects.

void engine.render.renderImage2D ( Camera camera, Image image, int width, int height, int hdr, int skip_flags ) #

Renders the scene into a 2D image of the given size in accordance with the specified parameters. The viewport position is taken from the camera created via Camera class.

Arguments

Camera camera - Camera to be used.
Image image - Image to save the result to.
int width - Width of the projected image, in units.
int height - Height of the projected image, in units.
int hdr - 1 - enable HDR, 0 - disable HDR.
int skip_flags - Skip the effects:
- VIEWPORT_SKIP_SHADOWS
- VIEWPORT_SKIP_VISUALIZER
- VIEWPORT_SKIP_SRGB
- VIEWPORT_SKIP_POSTEFFECTS
- VIEWPORT_SKIP_VELOCITY
- VIEWPORT_SKIP_DYNAMIC_REFLECTIONS
0 enables all the effects.

void engine.render.renderImageCube ( Camera camera, Image image, int skip_flags ) #

Renders the scene into a cube map image in accordance with the specified parameters.

Arguments

Camera camera - Camera to be used.
Image image - Image to save the result to.
int skip_flags - Skip the effects:
- VIEWPORT_SKIP_SHADOWS
- VIEWPORT_SKIP_VISUALIZER
- VIEWPORT_SKIP_SRGB
- VIEWPORT_SKIP_POSTEFFECTS
- VIEWPORT_SKIP_VELOCITY
- VIEWPORT_SKIP_DYNAMIC_REFLECTIONS
0 enables all the effects.

void engine.render.renderImageCube ( Camera camera, Image image, int size, int hdr, int skip_flags, int local_space = 0 ) #

Renders the scene into a cube map in accordance with the specified parameters. The viewport position is taken from the camera created via Camera class.

Arguments

Camera camera - Camera to be used.
Image image - Image to save the result to.
int size - Texture dimensions (cube map edge size).
int hdr - 1 - enable HDR; 0 - disable HDR.
int skip_flags - Skip the effects:
- VIEWPORT_SKIP_SHADOWS
- VIEWPORT_SKIP_VISUALIZER
- VIEWPORT_SKIP_SRGB
- VIEWPORT_SKIP_POSTEFFECTS
- VIEWPORT_SKIP_VELOCITY
- VIEWPORT_SKIP_DYNAMIC_REFLECTIONS
0 enables all the effects.
int local_space - 1 - local space coordinates; 0 - world space coordinates.

void engine.render.renderNodeImage2D ( Camera camera, Node node, Image image, int skip_flags, int light_usage, string environment_texture_name ) #

Renders the given node into a 2D image in accordance with the specified parameters. The viewport position is taken from the camera created via Camera class. The node can be rendered using the specific type of lighting and environment cubemap.

Arguments

Camera camera - Camera to be used.
Node node - Node to be rendered.
Image image - Image to save the result to.
int skip_flags - Skip the effects. One of the SKIP_* variables should be specified. 0 enables all the effects.
int light_usage - Sets the light sources that will affect the node (one of the USAGE_*_LIGHTING Viewport class variables.)
string environment_texture_name - Path to the environment cubemap to be used. Takes effect if the first (auxiliary light) or second (node light) lighting mode is used (see the light_usage argument above). In case LightWorld is used (zero mode), the environment cubemap used for the current world will be used.

void engine.render.renderNodeImage2D ( Camera camera, Node node, Image image, int width, int height, int hdr, int skip_flags, int light_usage, string environment_texture_name ) #

Renders the 2D image of the given node in accordance with the specified parameters. The viewport position is taken from the camera created via Camera class. The node can be rendered using the specific type of lighting and environment cubemap.

Arguments

Camera camera - Camera to be used.
Node node - Node to be rendered.
Image image - Image to save the result to.
int width - Width of the image, in units.
int height - Height of the image, in units.
int hdr - HDR flag. This parameter determines the format of the 2D image:
- 1 - image format will be set to RGBA16F. It means that the HDR image buffer will store pixel values outside the [0;1] range (i.e. both negative and positive values).
- 0 - image format will be set to RGBA8.
int skip_flags - Skip the effects. One of the SKIP_* variables should be specified. 0 enables all the effects.
int light_usage - Sets the light sources that will affect the node (one of the USAGE_*_LIGHTING Viewport class variables).
string environment_texture_name - Path to the environment cubemap to be used. Takes effect if the first (auxiliary light) or second (node light) lighting mode is used (see the light_usage argument above). In case LightWorld is used (zero mode), the environment cubemap used for the current world will be used.

void engine.render.renderScreenMaterial ( string material_name ) #

Arguments

string material_name - Material name.

void engine.render.renderScreenMaterial ( string material_name, Texture color_texture ) #

Arguments

string material_name - Material name.
Texture color_texture - Color texture.

void engine.render.renderScreenMaterial ( string material_name, string texture_name, Texture texture ) #

Arguments

string material_name - Material.
string texture_name - Material texture name.
Texture texture - Texture.

int engine.render.saveSettings ( string file ) #

Saves the current renderer settings to a given file.

Arguments

string file - Path to a target file.

Return value

1 if the settings are saved successfully; otherwise, 0.

int engine.render.saveState ( Stream stream ) #

Saves a render state into the stream.

Saving into the stream requires creating a blob to save into. To restore the saved state the restoreState() method is used:

Source code (UnigineScript)

// set state
engine.render.setCloudsInterleavedRendering(0); // interleave = 0
	
// save state
Blob blob_state = new Blob();
engine.render.saveState(blob_state);
	
// change state
engine.render.setCloudsInterleavedRendering(2); // now interleave = 2
	
// restore state
blob_state->seekSet(0);			// returning the carriage to the start of the blob
engine.render.restoreState(blob_state); // restore interleave = 0

Arguments

Stream stream - Stream to save a state into.

Return value

1 if the state is saved successfully; otherwise, 0.

int engine.render.restoreState ( Stream stream ) #

Restores a render state from the stream.

Restoring from the stream requires creating a blob to save into and saving the state using the saveState() method:

Source code (UnigineScript)

// set state
engine.render.setCloudsInterleavedRendering(0); // interleave = 0
	
// save state
Blob blob_state = new Blob();
engine.render.saveState(blob_state);
	
// change state
engine.render.setCloudsInterleavedRendering(2); // now interleave = 2
	
// restore state
blob_state->seekSet(0);			// returning the carriage to the start of the blob
engine.render.restoreState(blob_state); // restore interleave = 0

Arguments

Stream stream - Stream to restore a state from.

Return value

1 if the state is restored successfully; otherwise, 0.

int engine.render.saveWorld ( Xml xml ) #

Saves the render state into the given Xml node.

Arguments

Xml xml - Xml node.

Return value

1 if the state is saved successfully; otherwise, 0.

RenderEnvironmentPreset engine.render.getEnvironmentPreset ( int num ) #

Returns the environment preset of the given number.

Source code (UnigineScript)

// get the second environment preset
RenderEnvironmentPreset preset = engine.render.getEnvironmentPreset(1);
// print the sky intensity of the obtained preset
log.message("%f\n", preset.getSkyIntensity());

Arguments

int num - The number of the environment preset. The value is clamped to the [0;2] range.

Return value

Environment preset.

string engine.render.getCloudsQualityPresetName ( int num ) #

Returns the Clouds Quality preset name by given index.

Arguments

int num - Clouds Quality preset index.

Return value

Clouds Quality preset name.

string engine.render.getAAPresetName ( int num ) #

Returns the AA (Anti-Aliasing) preset name by given index.

Arguments

int num - AA preset index.

Return value

AA preset name.

string engine.render.getTAAPresetName ( int num ) #

Returns the TAA (Temporal Anti-Aliasing) preset name by given index.

Arguments

int num - TAA preset index.

Return value

TAA preset name.

string engine.render.getGIPresetName ( int num ) #

Returns the GI (Global Illumination) preset name by given index.

Arguments

int num - GI preset index.

Return value

GI preset name.

string engine.render.getSSRTGIPresetName ( int num ) #

Returns the SSRTGI (Screen-Space Ray-Traced Global Illumination) preset name by given index.

Arguments

int num - SSRTGI preset index.

Return value

SSRTGI preset name.

string engine.render.getSSAOPresetName ( int num ) #

Returns the SSAO (Screen Space Ambient Occlusion) preset name by given index.

Arguments

int num - SSAO preset index.

Return value

SSAO preset name.

string engine.render.getSSGIPresetName ( int num ) #

Returns the SSGI (Screen-Space Global Illumination) preset name by given index.

Arguments

int num - SSGI preset index.

Return value

SSGI preset name.

string engine.render.getBentNormalPresetName ( int num ) #

Returns the Bent Normal preset name by given index.

Arguments

int num - Bent Normal preset index.

Return value

Bent Normal preset name.

string engine.render.getSSRPresetName ( int num ) #

Returns the SSR preset name by given index.

Arguments

int num - SSR preset index.

Return value

SSR preset name.

string engine.render.getSSSSSPresetName ( int num ) #

Returns the SSSSS preset name by given index.

Arguments

int num - SSSSS preset index.

Return value

SSSSS preset name.

string engine.render.getMotionBlurPresetName ( int num ) #

Returns the Motion Blur preset name by given index.

Arguments

int num

Return value

Motion Blur preset name.

string engine.render.getDOFPresetName ( int num ) #

Returns the DOF preset name by given index.

Arguments

int num

Return value

DOF preset name.

string engine.render.getLandscapeTerrainGeometryPresetName ( int num ) #

Returns the Landscape Terrain Geometry preset name by given index.

Arguments

int num - Landscape Terrain Geometry preset index.

Return value

Landscape Terrain Geometry preset name.

string engine.render.getLandscapeTerrainStreamingPresetName ( int num ) #

Returns the Landscape Terrain Streaming preset name by given index.

Arguments

int num - Landscape Terrain Streaming preset index.

Return value

Landscape Terrain Streaming preset name.

string engine.render.getWaterGeometryPresetName ( int num ) #

Returns the Global Water Geometry preset name by given index.

Arguments

int num - Global Water Geometry preset index.

Return value

Global Water Geometry preset name.

int engine.render.isViewportModeStereo ( int mode ) #

Returns a value indicating if the specified mode is one of the stereo rendering modes.

Arguments

int mode - Viewport mode to be checked. One of the VIEWPORT_MODE_* values.

Return value

1 if the specified mode is one of the stereo rendering modes; otherwise 0.

int engine.render.isViewportModePanorama ( int mode ) #

Returns a value indicating if the specified mode is one of the panorama rendering modes.

Arguments

int mode - Viewport mode to be checked. One of the VIEWPORT_MODE_* values.

Return value

1 if the specified mode is one of the panorama rendering modes; otherwise 0.

void engine.render.clearDebugMaterials ( ) #

Clears all global debug materials.

void engine.render.setDebugMaterial ( int num, Material material ) #

Replaces the debug material with the specified number with the new debug material specified. The number of material determines the order in which the expressions assigned to it are executed.

Arguments

int num - Debug material number in the range from 0 to the total number of debug materials.
Material material - New debug material to replace the one with the specified number.

Material engine.render.getDebugMaterial ( int num ) #

Returns a debug material applied globally by its number.

Arguments

int num - Debug material number in the range from 0 to the total number of debug materials.

Return value

Debug material applied globally with the specified number.

void engine.render.insertDebugMaterial ( int num, Material material ) #

Inserts a new global debug material to the list of globally applied debug materials.

Arguments

int num - Position at which a new debug material is to be inserted.
Material material - Debug material to be inserted into the list of globally applied debug materials.

int engine.render.findDebugMaterial ( Material material ) #

Returns the number of the specified debug material applied globally. This number determines the order in which the assigned expressions are executed.

Arguments

Material material - Debug material for which a number is to be found.

Return value

Debug material number in the range from 0 to the total number of debug materials, or -1 if the specified material was not found.

void engine.render.addDebugMaterial ( Material material ) #

Adds a new global debug material.

Arguments

Material material - Debug material to be applied globally.

void engine.render.removeDebugMaterial ( int num ) #

Removes the global debug material with the specified number.

Arguments

int num - Debug material number in the range from 0 to the total number of debug materials.

void engine.render.swapDebugMaterials ( int num_0, int num_1 ) #

Swaps two debug materials with specified numbers. The number of material determines the order in which the expressions assigned to it are executed.

Arguments

int num_0 - Number of the first debug material in the range from 0 to the total number of debug materials.
int num_1 - Number of the second debug material in the range from 0 to the total number of debug materials.

void engine.render.setDebugMaterialEnabled ( int num, int enabled ) #

Enables or disables the debug material with the specified number. When a material is disabled (inactive), the scripts attached to it are not executed.

Arguments

int num - Debug material number in the range from 0 to the total number of debug materials.
int enabled - 1 to enable the debug material with the specified number, 0 to disable it.

int engine.render.getDebugMaterialEnabled ( int num ) #

Returns a value indicating if the debug material with the specified number is enabled (active). When a material is disabled (inactive), the scripts attached to it are not executed.

Arguments

int num - Debug material number in the range from 0 to the total number of debug materials.

Return value

1 if the debug material with the specified number is enabled; otherwise, 0.

Texture engine.render.getCacheTexture ( UGUID guid ) #

Arguments

UGUID guid

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

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

engine.render Functions

See Also#

Methods:

Variables:

Render Class

Members

void engine.render.setEnabled ( int arg1 ) #

Arguments

int engine.render.isEnabled ( ) #

Return value

int engine.render.isAPISupported ( int api ) #

Arguments

Return value

void engine.render.beginDebugGroup ( string name ) #

Arguments

void engine.render.endDebugGroup ( ) #

void engine.render.destroyCacheTexture ( UGUID guid ) #

Arguments

void engine.render.createCacheTexture ( UGUID guid ) #

Arguments

void engine.render.destroyCacheTextures ( ) #

void engine.render.unloadCacheTextures ( ) #

void engine.render.createCacheTextures ( ) #

void engine.render.loadCacheTextures ( ) #

void engine.render.getScreenshot ( Image image ) #

Arguments

int engine.render.getMaxTextureBufferSize ( ) #

Return value

void engine.render.addScriptableMaterial ( Material material ) #

Arguments

void engine.render.insertScriptableMaterial ( int num, Material material ) #

Arguments

void engine.render.removeScriptableMaterial ( int num ) #

Arguments

int engine.render.findScriptableMaterial ( Material material ) #

Arguments

Return value

void engine.render.setScriptableMaterial ( int num, Material material ) #

Arguments

Material engine.render.getScriptableMaterial ( int num ) #

Arguments

Return value

void engine.render.setScriptableMaterialEnabled ( int num, int enabled ) #

Arguments

int engine.render.getScriptableMaterialEnabled ( int num ) #

Arguments

Return value

void engine.render.swapScriptableMaterials ( int num_0, int num_1 ) #

Arguments

void engine.render.clearScriptableMaterials ( ) #

Texture engine.render.getTemporaryTexture ( int width, int height, int format, int flags = 0, string name = 0 ) #

Arguments

Return value

Texture engine.render.getTemporaryTexture ( Texture texture ) #

Arguments

Return value

Texture engine.render.getTemporaryTexture ( Texture texture, string name = 0 ) #

Arguments

Return value

Texture engine.render.getTemporary2DArrayTexture ( int width, int height, int depth, int format, int flags = 0, string name = 0 ) #

Arguments

Return value

Texture engine.render.getTemporary3DTexture ( int width, int height, int depth, int format, int flags = 0, string name = 0 ) #

Arguments

Return value

void engine.render.releaseTemporaryTexture ( Texture texture ) #

Arguments

RenderTarget engine.render.getTemporaryRenderTarget ( ) #

Return value

void engine.render.releaseTemporaryRenderTarget ( RenderTarget render_target ) #

Arguments

int engine.render.compressImage ( Image & image, int quality = 1, int new_image_format = -1, int use_mip_maps = -1 ) #

Arguments

Return value

int engine.render.compressTexture ( Texture texture, Image & destination, int quality = 1, int new_texture_format = -1, int use_mip_maps = -1 ) #

Arguments

Return value

void engine.render.convertColorSpecularToMetalness ( vec4 & diffuse, vec4 & specular, vec4 & albedo, vec4 & shading ) #

Arguments

void engine.render.convertImageSpecularToMetalness ( Image diffuse, Image specular, Image & albedo, Image & shading ) #