CFx SDK Documentation 2024 SP0
|
#include <GiEnvironment.h>
Public Member Functions | |
ODRX_DECLARE_MEMBERS (OdGiMentalRayRenderSettingsTraits) | |
virtual void | setSampling (int min, int max)=0 |
virtual void | sampling (int &min, int &max) const =0 |
virtual void | setSamplingFilter (OdGiMrFilter filter, double width, double height)=0 |
virtual void | SamplingFilter (OdGiMrFilter &filter, double &width, double &height) const =0 |
virtual void | setSamplingContrastColor (float r, float g, float b, float a)=0 |
virtual void | samplingContrastColor (float &r, float &g, float &b, float &a) const =0 |
virtual void | setShadowMode (OdGiMrShadowMode mode)=0 |
virtual OdGiMrShadowMode | shadowMode () const =0 |
virtual void | setShadowMapEnabled (bool enabled)=0 |
virtual bool | shadowMapEnabled () const =0 |
virtual void | setRayTraceEnabled (bool enabled)=0 |
virtual bool | rayTraceEnabled () const =0 |
virtual void | setRayTraceDepth (int reflection, int refraction, int sum)=0 |
virtual void | rayTraceDepth (int &reflection, int &refraction, int &sum) const =0 |
virtual void | setGlobalIlluminationEnabled (bool enabled)=0 |
virtual bool | globalIlluminationEnabled () const =0 |
virtual void | setGISampleCount (int num)=0 |
virtual int | giSampleCount () const =0 |
virtual void | setGISampleRadiusEnabled (bool enabled)=0 |
virtual bool | giSampleRadiusEnabled () const =0 |
virtual void | setGISampleRadius (double radius)=0 |
virtual double | giSampleRadius () const =0 |
virtual void | setGIPhotonsPerLight (int num)=0 |
virtual int | giPhotonsPerLight () const =0 |
virtual void | setPhotonTraceDepth (int reflection, int refraction, int sum)=0 |
virtual void | photonTraceDepth (int &reflection, int &refraction, int &sum) const =0 |
virtual void | setFinalGatheringEnabled (bool enabled)=0 |
virtual bool | finalGatheringEnabled () const =0 |
virtual void | setFGRayCount (int num)=0 |
virtual int | fgRayCount () const =0 |
virtual void | setFGRadiusState (bool bMin, bool bMax, bool bPixels)=0 |
virtual void | fgSampleRadiusState (bool &bMin, bool &bMax, bool &bPixels)=0 |
virtual void | setFGSampleRadius (double min, double max)=0 |
virtual void | fgSampleRadius (double &min, double &max) const =0 |
virtual void | setLightLuminanceScale (double luminance)=0 |
virtual double | lightLuminanceScale () const =0 |
virtual void | setDiagnosticMode (OdGiMrDiagnosticMode mode)=0 |
virtual OdGiMrDiagnosticMode | diagnosticMode () const =0 |
virtual void | setDiagnosticGridMode (OdGiMrDiagnosticGridMode mode, float fSize)=0 |
virtual void | diagnosticGridMode (OdGiMrDiagnosticGridMode &mode, float &fSize) const =0 |
virtual void | setDiagnosticPhotonMode (OdGiMrDiagnosticPhotonMode mode)=0 |
virtual OdGiMrDiagnosticPhotonMode | diagnosticPhotonMode () const =0 |
virtual void | setDiagnosticBSPMode (OdGiMrDiagnosticBSPMode mode)=0 |
virtual OdGiMrDiagnosticBSPMode | diagnosticBSPMode () const =0 |
virtual void | setExportMIEnabled (bool enabled)=0 |
virtual bool | exportMIEnabled () const =0 |
virtual void | setExportMIFileName (const OdString &miName)=0 |
virtual OdString | exportMIFileName () const =0 |
virtual void | setTileSize (int size)=0 |
virtual int | tileSize () const =0 |
virtual void | setTileOrder (OdGiMrTileOrder order)=0 |
virtual OdGiMrTileOrder | tileOrder () const =0 |
virtual void | setMemoryLimit (int limit)=0 |
virtual int | memoryLimit () const =0 |
virtual void | setEnergyMultiplier (float fScale)=0 |
virtual float | energyMultiplier () const =0 |
virtual void | setProgressMonitor (void *pMonitor)=0 |
virtual const void * | progressMonitor () const =0 |
virtual void | setExposureType (OdGiMrExposureType type)=0 |
virtual OdGiMrExposureType | exposureType () const =0 |
virtual void | setFinalGatheringMode (OdGiMrFinalGatheringMode mode)=0 |
virtual OdGiMrFinalGatheringMode | finalGatheringMode () const =0 |
virtual void | setShadowSamplingMultiplier (double multiplier)=0 |
virtual double | shadowSamplingMultiplier () const =0 |
virtual void | setExportMIMode (OdGiMrExportMIMode mode)=0 |
virtual OdGiMrExportMIMode | exportMIMode () const =0 |
Public Member Functions inherited from OdGiRenderSettingsTraits | |
ODRX_DECLARE_MEMBERS (OdGiRenderSettingsTraits) | |
virtual void | setMaterialEnabled (bool enabled)=0 |
virtual bool | materialEnabled () const =0 |
virtual void | setTextureSampling (bool enabled)=0 |
virtual bool | textureSampling () const =0 |
virtual void | setBackFacesEnabled (bool enabled)=0 |
virtual bool | backFacesEnabled () const =0 |
virtual void | setShadowsEnabled (bool enabled)=0 |
virtual bool | shadowsEnabled () const =0 |
virtual void | setDiagnosticBackgroundEnabled (bool enabled)=0 |
virtual bool | diagnosticBackgroundEnabled () const =0 |
virtual void | setModelScaleFactor (double scaleFactor)=0 |
virtual double | modelScaleFactor () const =0 |
Public Member Functions inherited from OdGiDrawableTraits | |
ODRX_DECLARE_MEMBERS (OdGiDrawableTraits) | |
Public Member Functions inherited from OdRxObject | |
ODRX_HEAP_OPERATORS () | |
OdRxObject () | |
virtual | ~OdRxObject () |
virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
virtual OdRxObject * | x (const OdRxClass *pClass) const |
virtual OdRxClass * | isA () const |
virtual void | addRef ()=0 |
virtual void | release ()=0 |
virtual long | numRefs () const |
bool | isKindOf (const OdRxClass *pClass) const |
virtual OdRxObjectPtr | clone () const |
virtual void | copyFrom (const OdRxObject *pSource) |
virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
virtual bool | isEqualTo (const OdRxObject *pOther) const |
Additional Inherited Members | |
Static Public Member Functions inherited from OdRxObject | |
static OdRxObjectPtr | cast (const OdRxObject *pointer) |
static OdRxClass * | desc () |
Represents settings that are specific to the mental ray render.
Corresponding C++ library: TD_Gi <group OdGi_Classes>
Definition at line 408 of file GiEnvironment.h.
|
pure virtual |
Retrieves the type of BSP information to render images within the BSP diagnostic mode.
|
pure virtual |
Retrieves the coordinate system for the diagnostic grid and the distance between grid lines (size).
mode | [out] Receives the type of a diagnostic grid. |
fSize | [out] Receives the distance between grid lines. Must be greater than 0. |
|
pure virtual |
Retrieves a mode used to process diagnostic images.
|
pure virtual |
Retrieves the type of photon information to render images within the photon diagnostic mode.
|
pure virtual |
Receives the energy multiplier to control the magnitude of indirect illumination.
|
pure virtual |
Checks whether MI file is enabled after image rendering.
|
pure virtual |
Retrieves a file name for an exported MI file.
|
pure virtual |
Retrieves an export type for MI file.
|
pure virtual |
Retrieves the exposure type.
|
pure virtual |
Retrieves the amount of final gather rays used for each final gather point.
|
pure virtual |
Retrieves the minimum and maximum radii of the area used to sample final gather points to process indirect illumination.
min | [out] Receives minimum final gather sample radius. Measurement units for this parameter can be retrieved using the setFGRadiusState() method. |
max | [out] Receives maximum final gather sample radius. Measurement units for this parameter can be retrieved using the setFGRadiusState() method. |
|
pure virtual |
Checks whether user-defined radii are used for final gathering and their measurement units.
bMin | [out] Flag that shows whether the user-defined minimum radius is used. If set to false, a default radius is used. |
bMax | [out] Flag that shows whether the user-defined maximum radius is used. If set to false, a default radius is used. |
bPixels | [out] Flag that shows whether the user-defined radii are measured in pixel units. |
|
pure virtual |
Checks whether final gathering is enabled.
|
pure virtual |
Retrieves the final gathering mode.
|
pure virtual |
Retrieves the average number of photons that are emitted for each light source.
|
pure virtual |
Retrieves the maximum number of photons surrounding a render sample point to use for calculation of global illumination.
|
pure virtual |
Retrieves the radius of the sample area of photons used for global illumination.
|
pure virtual |
Checks whether user-defined photon radius is enabled.
|
pure virtual |
Checks whether global illumination effects are enabled.
|
pure virtual |
Retrieves the physical luminance of a light with intensity 1.0 (in candelas).
|
pure virtual |
Retrieves the maximum amount of memory that can be allocated for rendering.
OdGiMentalRayRenderSettingsTraits::ODRX_DECLARE_MEMBERS | ( | OdGiMentalRayRenderSettingsTraits | ) |
|
pure virtual |
Retrieves the maximum depth (recursion depth) for traced photons.
reflection | [out] Maximum recursion level of reflection photons, greater than or equal to 0. |
refraction | [out] Maximum recursion level of refraction photons, greater than or equal to 0. |
sum | [out] Maximum recursion level of reflection and refraction photons, combined. |
|
pure virtual |
Retrieves a pointer to the progress monitor.
|
pure virtual |
Retrieves the maximum depth (recursion depth) for traced rays.
reflection | [out] Maximum recursion level of reflection rays, greater than or equal to 0. |
refraction | [out] Maximum recursion level of refraction rays, greater than or equal to 0. |
sum | [out] Maximum recursion level of reflection and refraction rays, combined. |
|
pure virtual |
Checks whether ray tracing is enabled.
|
pure virtual |
Retrieves the minimum and maximum numbers of samples that are used for pixel shading process during rendering.
min | [out] Minimum sampling rate [-3..5]. Values less than zero enable subsampling. -3 corresponds to one sample for every 64 pixel (1/64) and 5 corresponds to 1024 samples per pixel. This parameter cannot be greater than the max parameter. |
max | [out] Maximal sampling rate [-3..5]. This parameter cannot be less than the min parameter. |
|
pure virtual |
Retrieves the threshold values for color channels below which further samples are not accepted.
r | [out] Red channel. |
g | [out] Green channel. |
b | [out] Blue channel. |
a | [out] Alpha (transparency) channel. |
|
pure virtual |
Retrieves the filtering parameters for merging multiple samples into a pixel color.
filter | [out] Filtering parameters for merging multiple samples into a pixel color. |
width | [out] Width of a filter area for neighboring pixels in the range of [0..8]. |
height | [out] Width of a filter area for neighboring pixels in the range of [0..8]. |
|
pure virtual |
Specifies the type of BSP information to render images within the BSP diagnostic mode.
mode | [in] BSP diagnostic mode. |
|
pure virtual |
Specifies the coordinate system for the diagnostic grid and the distance between grid lines (size).
mode | [in] Type of a diagnostic grid. |
fSize | [in] Distance between grid lines. Must be greater than 0. |
|
pure virtual |
Specifies a mode used to process diagnostic images.
mode | [in] Mode used to process diagnostic images. |
|
pure virtual |
Specifies the type of photon information to render images within the photon diagnostic mode.
mode | [in] Photon diagnostic mode. |
|
pure virtual |
Specifies the energy multiplier to control the magnitude of indirect illumination.
fScale | [in] Scale factor. |
|
pure virtual |
Specifies whether to export MI file after image is rendered.
mode | [in] Flag that specifies whether to export MI file after image is rendered. |
|
pure virtual |
Specifies a file name for an exported MI file.
miName | [in] Name for an exported MI file. |
|
pure virtual |
Specifies an export type for MI file.
mode | [in] Defines export mode for MI files. |
|
pure virtual |
Specifies the exposure type.
type | [in] Exposure type. |
|
pure virtual |
Specifies whether user-defined radii are used for final gathering and the measurement units for the radii.
bMin | [in] Flag that specifies whether the user-defined minimum radius is used. If set to false, a default radius is used. |
bMax | [in] Flag that specifies whether the user-defined maximum radius is used. If set to false, a default radius is used. |
bPixels | [in] Flag that specifies whether the user-defined radii are measured in pixel units. |
|
pure virtual |
Specifies the amount of final gather rays to use for each final gather point.
enabled | [in] Amount of final gather rays to use for each final gather point. Must be greater than 0. |
|
pure virtual |
Specifies the minimum and maximum radii of the area used to sample final gather points to process indirect illumination.
min | [in] Minimum final gather sample radius. To define measurement units for this parameter, use the setFGRadiusState() method. Must be greater than 0 but less than or equal to the max parameter. |
max | [in] Maximum final gather sample radius. To define measurement units for this parameter, use the setFGRadiusState() method. Must be greater than 0 and greater than or equal to the min parameter. |
|
pure virtual |
Specifies whether final gathering should be enabled.
enabled | [in] Flag that specifies whether global illumination should be enabled. |
|
pure virtual |
Specifies the final gathering mode.
mode | [in] Final gathering mode. |
|
pure virtual |
Specifies the average number of photons to emit for each light source.
num | [in] Average number of photons to emit for each light. Must be greater than 0. |
|
pure virtual |
Specifies the maximum number of photons surrounding a render sample point to use for calculation of global illumination.
sum | [in] Number of photons around each render sample. Must be greater than zero. |
|
pure virtual |
Specifies the radius of the sample area of photons used for global illumination.
radius | [in] Radius in model units. Must be greater than or equal to zero. |
|
pure virtual |
Specifies whether user-defined photon radius should be used.
enabled | [in] Flag that specifies whether to enable user-defined photon sampling radius. |
|
pure virtual |
Specifies whether global illumination effects (for example, color bleeding) should be enabled.
enabled | [in] Flag that specifies whether global illumination should be enabled. |
|
pure virtual |
Specifies the physical luminance of a light with intensity 1.0 (in candelas).
luminance | [in] Physical luminance of a light with intensity 1.0 (in candelas), used as a physical scaling factor. |
|
pure virtual |
Specifies the maximum amount of memory that can be allocated for rendering.
limit | [in] maximum amount of memory for rendering in MB. |
|
pure virtual |
Specifies the maximum depth (recursion level) for traced photons.
reflection | [in] Maximum recursion level of reflection photons, greater than or equal to 0. |
refraction | [in] Maximum recursion level of refraction photons, greater than or equal to 0. |
sum | [in] Maximum recursion level of reflection and refraction photons, combined. |
Specifies the interface pointer for the render driver to callback.
pMonitor | [in] Void pointer that caller provides for the render driver to callback. |
|
pure virtual |
Specifies the maximum depth (recursion depth) for traced rays.
reflection | [in] Maximum recursion level of reflection rays, greater than or equal to 0. |
refraction | [in] Maximum recursion level of refraction rays, greater than or equal to 0. |
sum | [in] Maximum recursion level of reflection and refraction rays, combined. |
|
pure virtual |
Specifies whether ray tracing should be enabled.
enabled | [in] Flag that specifies whether ray tracing should be enabled. |
|
pure virtual |
Specifies the minimum and maximum numbers of samples that are used for pixel shading process during rendering.
min | [in] Minimum sampling rate [-3..5]. Values less than zero enable subsampling. -3 corresponds to one sample for every 64 pixel (1/64) and 5 corresponds to 1024 samples per pixel. This parameter must be less or equal to the max parameter. |
max | [in] Maximal sampling rate [-3..5]. This parameter must be equal or greater than to the mix parameter. |
|
pure virtual |
Specifies the threshold values for color channels below which further samples are not accepted.
r | [in] Red channel. |
g | [in] Green channel. |
b | [in] Blue channel. |
a | [in] Alpha (transparency) channel. |
|
pure virtual |
Specifies the filtering parameters for merging multiple samples into a pixel color.
filter | [in] Filtering parameters for merging multiple samples into a pixel color. |
width | [in] Width of a filter area for neighboring pixels in the range of [0..8]. |
height | [in] Width of a filter area for neighboring pixels in the range of [0..8]. |
|
pure virtual |
Specifies whether shadow maps should be enabled. Affects only lights using mapped shadows.
enabled | [in] Flag that specifies whether shadow maps should be enabled. |
|
pure virtual |
Specifies the method used to compute ray-traced shadows. Affects only lights using ray-traced shadows.
mode | [in] Shadow mode. |
|
pure virtual |
Specifies shadow sampling multiplier value.
multiplier | [in] Multiplier value for shadows. |
|
pure virtual |
Specifies the order used to render image tiles.
order | [in] Order used to render image tiles. |
|
pure virtual |
Specifies the size of the image tiles used during rendering.
size | [in] Size of image tiles used during rendering. |
|
pure virtual |
Checks whether shadow maps is enabled.
|
pure virtual |
Retrieves the method used to compute ray-traced shadows.
|
pure virtual |
Retrieves shadow sampling multiplier value.
|
pure virtual |
Retrieves the order used to render image tiles.
|
pure virtual |
Retrieves the size of the image tiles used during rendering.