CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
GiEnvironment.h File Reference
#include "Gi.h"
#include "GiMaterial.h"

Go to the source code of this file.

Classes

class  OdGiRenderEnvironmentTraits
 
class  OdGiRenderSettingsTraits
 
class  OdGiMentalRayRenderSettingsTraits
 
class  OdGiRapidRTRenderSettingsTraits
 
class  OdGiSolidBackgroundTraits
 
class  OdGiGradientBackgroundTraits
 
class  OdGiImageBackgroundTraits
 
class  OdGiGroundPlaneBackgroundTraits
 
class  OdGiSkyBackgroundTraits
 
class  OdGiIBLBackgroundTraits
 
class  OdGiEnvironmentBackgroundTraits
 
class  OdGiCustomBackgroundTraits
 

Typedefs

typedef OdSmartPtr< OdGiRenderEnvironmentTraitsOdGiRenderEnvironmentTraitsPtr
 
typedef OdSmartPtr< OdGiRenderSettingsTraitsOdGiRenderSettingsTraitsPtr
 
typedef enum OdGiMrFilter_ OdGiMrFilter
 
typedef enum OdGiMrShadowMode_ OdGiMrShadowMode
 
typedef enum OdGiMrDiagnosticMode_ OdGiMrDiagnosticMode
 
typedef enum OdGiMrDiagnosticGridMode_ OdGiMrDiagnosticGridMode
 
typedef enum OdGiMrDiagnosticPhotonMode_ OdGiMrDiagnosticPhotonMode
 
typedef enum OdGiMrDiagnosticBSPMode_ OdGiMrDiagnosticBSPMode
 
typedef enum OdGiMrTileOrder_ OdGiMrTileOrder
 
typedef enum OdGiMrExposureType_ OdGiMrExposureType
 
typedef enum OdGiMrFinalGatheringMode_ OdGiMrFinalGatheringMode
 
typedef enum OdGiMrExportMIMode_ OdGiMrExportMIMode
 
typedef OdSmartPtr< OdGiMentalRayRenderSettingsTraitsOdGiMentalRayRenderSettingsTraitsPtr
 
typedef enum OdGiQuitCondition_ OdGiQuitCondition
 
typedef enum OdGiLightingMode_ OdGiLightingMode
 
typedef enum OdGiFilterType_ OdGiFilterType
 
typedef OdSmartPtr< OdGiRapidRTRenderSettingsTraitsOdGiRapidRTRenderSettingsTraitsPtr
 
typedef OdSmartPtr< OdGiSolidBackgroundTraitsOdGiSolidBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiGradientBackgroundTraitsOdGiGradientBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiImageBackgroundTraitsOdGiImageBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiGroundPlaneBackgroundTraitsOdGiGroundPlaneBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiSkyBackgroundTraitsOdGiSkyBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiIBLBackgroundTraitsOdGiIBLBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiEnvironmentBackgroundTraitsOdGiEnvironmentBackgroundTraitsPtr
 
typedef OdSmartPtr< OdGiCustomBackgroundTraitsOdGiCustomBackgroundTraitsPtr
 

Enumerations

enum  OdGiMrFilter_ {
  krBox = 0 , krTriangle = 1 , krGauss = 2 , krMitchell = 3 ,
  krLanczos = 4
}
 
enum  OdGiMrShadowMode_ { krSimple = 0 , krSorted = 1 , krSegments = 2 }
 
enum  OdGiMrDiagnosticMode_ {
  krOff = 0 , krGrid = 1 , krPhoton = 2 , krSamples = 3 ,
  krBSP = 4
}
 
enum  OdGiMrDiagnosticGridMode_ { krObject = 0 , krWorld = 1 , krCamera = 2 }
 
enum  OdGiMrDiagnosticPhotonMode_ { krDensity = 0 , krIrradiance = 1 }
 
enum  OdGiMrDiagnosticBSPMode_ { krDepth = 0 , krSize = 1 }
 
enum  OdGiMrTileOrder_ {
  krHilbert = 0 , krSpiral = 1 , krLeftToRight = 2 , krRightToLeft = 3 ,
  krTopToBottom = 4 , krBottomToTop = 5
}
 
enum  OdGiMrExposureType_ { krAutomatic = 0 , krLogarithmic = 1 }
 
enum  OdGiMrFinalGatheringMode_ { krFinalGatherOff = 0 , krFinalGatherOn = 1 , krFinalGatherAuto = 2 }
 
enum  OdGiMrExportMIMode_ { krExportMIOff = 0 , krExportMIWithRender = 1 , krExportMIOnly = 2 }
 
enum  OdGiQuitCondition_ { krEQuitByRenderLevel = 0 , krEQuitByRenderTime = 1 }
 
enum  OdGiLightingMode_ { krESimplistic = 0 , krEBasic = 1 , krEAdvanced = 2 }
 
enum  OdGiFilterType_ {
  krEBox = 0 , krETriangle = 1 , krEGaussian = 2 , krELanczos = 3 ,
  krEMitchell = 4
}
 

Typedef Documentation

◆ OdGiCustomBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiCustomBackgroundTraits object pointers.

Definition at line 1916 of file GiEnvironment.h.

◆ OdGiEnvironmentBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiEnvironmentBackgroundTraits object pointers.

Definition at line 1880 of file GiEnvironment.h.

◆ OdGiFilterType

◆ OdGiGradientBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiGradientBackgroundTraits object pointers.

Definition at line 1393 of file GiEnvironment.h.

◆ OdGiGroundPlaneBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiGroundPlaneBackgroundTraits object pointers.

Definition at line 1669 of file GiEnvironment.h.

◆ OdGiIBLBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiIBLBackgroundTraits object pointers.

Definition at line 1802 of file GiEnvironment.h.

◆ OdGiImageBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiImageBackgroundTraits object pointers.

Definition at line 1551 of file GiEnvironment.h.

◆ OdGiLightingMode

◆ OdGiMentalRayRenderSettingsTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiMentalRayRenderSettingsTraits object pointers.

Definition at line 1029 of file GiEnvironment.h.

◆ OdGiMrDiagnosticBSPMode

◆ OdGiMrDiagnosticGridMode

◆ OdGiMrDiagnosticMode

◆ OdGiMrDiagnosticPhotonMode

◆ OdGiMrExportMIMode

◆ OdGiMrExposureType

◆ OdGiMrFilter

◆ OdGiMrFinalGatheringMode

◆ OdGiMrShadowMode

◆ OdGiMrTileOrder

◆ OdGiQuitCondition

◆ OdGiRapidRTRenderSettingsTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiRapidRTRenderSettingsTraits object pointers.

Definition at line 1229 of file GiEnvironment.h.

◆ OdGiRenderEnvironmentTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiRenderEnvironmentTraits object pointers.

Definition at line 167 of file GiEnvironment.h.

◆ OdGiRenderSettingsTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiRenderSettingsTraits object pointers.

Definition at line 284 of file GiEnvironment.h.

◆ OdGiSkyBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiSkyBackgroundTraits object pointers.

Definition at line 1701 of file GiEnvironment.h.

◆ OdGiSolidBackgroundTraitsPtr

This template class is a specialization of the OdSmartPtr class for OdGiSolidBackgroundTraits object pointers.

Definition at line 1262 of file GiEnvironment.h.

Enumeration Type Documentation

◆ OdGiFilterType_

Enumerator
krEBox 

Box filter type.

krETriangle 

Triangle filter type.

krEGaussian 

Gaussian filter type.

krELanczos 

Lanczos filter type.

krEMitchell 

Mitchell filter type.

Definition at line 1052 of file GiEnvironment.h.

◆ OdGiLightingMode_

Enumerator
krESimplistic 

Global illumination and Glossy reflection/refraction is turned off. The most simple way to reduce noise.

krEBasic 

Ambient Occlusion and a simpler model for ambient light and image-based lighting (IBL) are introduced. Provides faster results.

krEAdvanced 

Full Global Illumination and a more advanced model for ambient light and IBL are introduced. Provides more realistic results.

Definition at line 1041 of file GiEnvironment.h.

◆ OdGiMrDiagnosticBSPMode_

Enumerator
krDepth 

BSP depth: the depth of the BSP tree reached.

krSize 

BSP leaf size: the leaf size in the BSP tree reached.

Definition at line 348 of file GiEnvironment.h.

◆ OdGiMrDiagnosticGridMode_

Enumerator
krObject 

Object-space coordinate system.

krWorld 

World-space coordinate system.

krCamera 

Camera-space (view-space) coordinate system.

Definition at line 328 of file GiEnvironment.h.

◆ OdGiMrDiagnosticMode_

Enumerator
krOff 

Render normally.

krGrid 

Render a grid on top of all objects in the scene, in the coordinate system specified with a value from OdGiMrDiagnosticGridMode enum.

krPhoton 

Render a false-color image of photon density or photon irradiance on all surfaces, as specified with value from OdGiMrDiagnosticPhotonMode enum. Higher density or irradiance is shown red, and lower values are represented with blue.

krSamples 

Render a grayscale image illustrating sample density, which is controlled with the OdGiMentalRayRenderSettingsTraits::setSampling() method. Higher levels of sampling are shown with brighter shades of gray.

krBSP 

Render a false-color image illustrating the cost of creating and traversing the BSP tree used for ray-tracing. Both the depth and the leaf size can be visualized, as specified with value from OdGiMrDiagnosticBSPMode enum.

Definition at line 313 of file GiEnvironment.h.

◆ OdGiMrDiagnosticPhotonMode_

Enumerator
krDensity 

Photon density is displayed, where higher density values are shown red and lower values are shown in red

krIrradiance 

Photon irradiance is displayed, where higher irradiance values are shown red and lower values are shown in red.

Definition at line 339 of file GiEnvironment.h.

◆ OdGiMrExportMIMode_

Enumerator
krExportMIOff 

Mi file is not exported.

krExportMIWithRender 

Mi file is exported and rendered.

krExportMIOnly 

Mi file is exported but not rendered.

Definition at line 394 of file GiEnvironment.h.

◆ OdGiMrExposureType_

Enumerator
krAutomatic 

The exposure type is determined with an automatic exposure.

krLogarithmic 

The exposure type is determined on a logarithmic scale.

Definition at line 374 of file GiEnvironment.h.

◆ OdGiMrFilter_

Enumerator
krBox 

Box filter.

krTriangle 

Triangle filter.

krGauss 

Gauss filter.

krMitchell 

Mitchell filter.

krLanczos 

Lanczos filter.

Definition at line 287 of file GiEnvironment.h.

◆ OdGiMrFinalGatheringMode_

Enumerator
krFinalGatherOff 

Final gathering is off.

krFinalGatherOn 

Final gathering is on.

krFinalGatherAuto 

Final gathering usage is defined automatically.

Definition at line 383 of file GiEnvironment.h.

◆ OdGiMrShadowMode_

Enumerator
krSimple 

Simple shadows, no sorting of shadow rays is performed.

krSorted 

Shadow sorting is performed, from sample point to light.

krSegments 

Shadow segmenting is performed, from light to sample point.

Definition at line 302 of file GiEnvironment.h.

◆ OdGiMrTileOrder_

Enumerator
krHilbert 

Hilbert order.

krSpiral 

Spiral order.

krLeftToRight 

Left-to-right order.

krRightToLeft 

Right-to-left order.

krTopToBottom 

Top-to-bottom order.

krBottomToTop 

Bottom-to-top order.

Definition at line 357 of file GiEnvironment.h.

◆ OdGiQuitCondition_

Enumerator
krEQuitByRenderLevel 

Quit by render level.

krEQuitByRenderTime 

Quit by exceeding render time limit.

Definition at line 1032 of file GiEnvironment.h.