REDsdk 5.3 API Changes

File name

“Change details”

ARTFactory.h

Updated class IDs.

ARTIAssetManager.h

New methods

  • ART::IAssetManager::AddGeometryPart / RemoveGeometryPart: Enhanced geometry control.

  • Entity control API.

Modified methods

  • ART::IAssetManager::CreateGeometry: Option to create an atlas or not, skinned mesh option.

  • ART::IAssetManager::BuildGeometryREDGraph: Added sharing capability to the method with pre-existing REDsdk materials. Created images retrieval.

  • ART::IAssetManager::GenerateGeometryVertexAO becomes ART::IAssetManager::GenerateGeometryVertexGI, generating both GI and AO. Related methods modified accordingly.

Removed methods

  • Ground field methods. Replaced with decals from the editor.

ARTIAtlas.h

New file with atmospheric control API.

ARTIEntity.h

New methods

  • Animation control API.

ARTIGeometry.h

Modified methods

  • ART::IGeometry::SetVertexAO: Added PBR mesh entry.

New methods

  • ART::IGeometry::RefreshMaterial.

  • ART::IGeometry::GetVertexGI and GetVertexAO: Missing accessors.

Removed methods

  • ART::IGeometry::SetGroundElevation. Elevation sculpting is now performed using editor decals.

ARTIMaterial.h

New methods

  • New water material parameters API.

  • IOR and glossiness control.

  • Emissive material control methods.

  • PBR material control methods.

ARTIObserver.h

New methods

  • ART::IObserver::GetGPSPosition: GPS conversion query.

ARTIOptions.h

Modified methods

  • ART::IOptions::SetPlanetGeometricalOpsPerFrame becomes ART::IOptions::SetPlanetLandscapeOpsTime.

Removed methods

  • ART::IOptions::GetAtlasPrismsDensityRatio and corresponding Set method.

ARTIPlanet.h

Modified method

  • ART::IPlanet::SetEnvironment: Added an environment intensity scaling factor and corresponding accessors.

  • Fixed some API constness mistakes.

New methods

  • Wind API: ART::IPlanet::SetWindDirection and other wind control methods.

  • Geometry lazy ground updates control API: API that allow a geometry that has to modify the ground to retain its action until a flush command is issued.

  • ART::IPlanet::GetLandscapeRealHeight: query with optional geometry filtering parameters.

ARTIReflectionProbe.h

New methods

  • ART::IReflectionProbe::SetRenderPlanar / GetRenderPlanar / InitializePlanar: Planar probes control methods.

Modified methods

  • ART::IReflectionProbe::SetCameraPosition renamed into ART::IReflectionProbe::SetCameraPositionOffset (same for the Get accessor).

ARTIStatistics.h

New methods

  • Auxiliary rendering time queries (for planar reflections).

ARTIWorld.h

New methods

  • ART::IWorld::SetSimulationElapsedTime: Override of simulation timers.

Modified methods

  • ART::IWorld::PickGeometry: Added picked normal to result.

RED.h

New error codes

  • RED_OPEN_IMAGE_DENOISE_DLL_ERROR, RED_OPEN_IMAGE_DENOISE_DLL_NOT_FOUND, RED_OPEN_IMAGE_DENOISE_EXECUTION_ERROR: Intel denoiser specific error codes.

  • RED_SCG_IMAGE_STILL_IN_USE: Multi-threaded image control error code.

REDImageTools.h

New methods

  • RED::ImageTools::GetMeanColor: Get the mean color of a 2D image.

  • RED::ImageTools::CopyFrom: Copy an image from a source.

Modified methods

  • RED::ImageTools::ConvertMetallicToRealisticMaterial: Added IOR map support.

REDIGeometryDatabase.h

New method

  • RED::IGeometryDatabase::GetGIDiffuseColor: Get the GI color at a hit object.

REDIMeshShape.h

New methods

  • RED::IMeshShape::GetSkinBonesCount and other bone control / query methods for animated meshes.

REDITransformShape.h

New method

  • RED::ITransformShape::BuildHLRLegacy: Old version REDsdk HLR method for backward compatibility on old scenes.

REDIViewpointRenderList.h

New method

  • RED::IViewpointRenderList::InsertViewpoint: New method with a fixed position insertion.

REDNoise.h

Fixed API constness mistakes.

REDOptionList.h

New option

  • RED::OPTIONS_RAY_ENABLE_OPEN_IMAGE_DENOISE: Turn on or off the Intel denoiser.

REDSoftShaderCallback.h

New parameter

  • RED::SoftFrameBufferSample::_out_bsdf_matte_shadow for the support of path tracing with the matte shadow material.

REDWindowRenderInfo.h

New methods

  • RED::WindowRenderInfo::IsContextSharing: Check how REDsdk will behave about external context sharing (Windows only).

Modified methods

  • RED::WindowRenderInfo::SetHostingContext: Added a context sharing option (enabled by default - behavior unchanged).