API Reference

Class TEnvironmentNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TEnvironmentNode = class(TAbstractBindableNode)

Description

Not implemented: Bindable node to setup rendering and culling parameters.

Compatible with X3DOM. Not implemented in Castle Game Engine yet, we merely parse it now, but don't do anything with obtained information.

See https://doc.x3dom.org/author/EnvironmentalEffects/Environment.html

Hierarchy

Overview

Methods

Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;

Properties

Public property FdEnableARC: TSFBool read FFdEnableARC;
Public property EnableARC: Boolean read GetEnableARC write SetEnableARC;
Public property FdFrustumCulling: TSFBool read FFdFrustumCulling;
Public property FrustumCulling: Boolean read GetFrustumCulling write SetFrustumCulling;
Public property FdGammaCorrectionDefault: TSFString read FFdGammaCorrectionDefault;
Public property GammaCorrectionDefault: String read GetGammaCorrectionDefault write SetGammaCorrectionDefault;
Public property FdLowPriorityCulling: TSFBool read FFdLowPriorityCulling;
Public property LowPriorityCulling: Boolean read GetLowPriorityCulling write SetLowPriorityCulling;
Public property FdLowPriorityFactor: TSFFloat read FFdLowPriorityFactor;
Public property LowPriorityFactor: Single read GetLowPriorityFactor write SetLowPriorityFactor;
Public property FdLowPriorityThreshold: TSFFloat read FFdLowPriorityThreshold;
Public property LowPriorityThreshold: Single read GetLowPriorityThreshold write SetLowPriorityThreshold;
Public property FdMaxFrameRate: TSFFloat read FFdMaxFrameRate;
Public property MaxFrameRate: Single read GetMaxFrameRate write SetMaxFrameRate;
Public property FdMinFrameRate: TSFFloat read FFdMinFrameRate;
Public property MinFrameRate: Single read GetMinFrameRate write SetMinFrameRate;
Public property FdOcclusionCulling: TSFBool read FFdOcclusionCulling;
Public property OcclusionCulling: Boolean read GetOcclusionCulling write SetOcclusionCulling;
Public property FdOcclusionVisibilityFactor: TSFFloat read FFdOcclusionVisibilityFactor;
Public property OcclusionVisibilityFactor: Single read GetOcclusionVisibilityFactor write SetOcclusionVisibilityFactor;
Public property FdOcclusionVisibilityThreshold: TSFFloat read FFdOcclusionVisibilityThreshold;
Public property OcclusionVisibilityThreshold: Single read GetOcclusionVisibilityThreshold write SetOcclusionVisibilityThreshold;
Public property FdShadowExcludeTransparentObjects: TSFBool read FFdShadowExcludeTransparentObjects;
Public property ShadowExcludeTransparentObjects: Boolean read GetShadowExcludeTransparentObjects write SetShadowExcludeTransparentObjects;
Public property FdSmallFeatureCulling: TSFBool read FFdSmallFeatureCulling;
Public property SmallFeatureCulling: Boolean read GetSmallFeatureCulling write SetSmallFeatureCulling;
Public property FdSmallFeatureFactor: TSFFloat read FFdSmallFeatureFactor;
Public property SmallFeatureFactor: Single read GetSmallFeatureFactor write SetSmallFeatureFactor;
Public property FdSmallFeatureThreshold: TSFFloat read FFdSmallFeatureThreshold;
Public property SmallFeatureThreshold: Single read GetSmallFeatureThreshold write SetSmallFeatureThreshold;
Public property FdSortTrans: TSFBool read FFdSortTrans;
Public property SortTrans: Boolean read GetSortTrans write SetSortTrans;
Public property FdSSAO: TSFBool read FFdSSAO;
Public property SSAO: Boolean read GetSSAO write SetSSAO;
Public property FdSSAOamount: TSFFloat read FFdSSAOamount;
Public property SSAOamount: Single read GetSSAOamount write SetSSAOamount;
Public property FdSSAOblurDepthTreshold: TSFFloat read FFdSSAOblurDepthTreshold;
Public property SSAOblurDepthTreshold: Single read GetSSAOblurDepthTreshold write SetSSAOblurDepthTreshold;
Public property FdSSAOradius: TSFFloat read FFdSSAOradius;
Public property SSAOradius: Single read GetSSAOradius write SetSSAOradius;
Public property FdSSAOrandomTextureSize: TSFFloat read FFdSSAOrandomTextureSize;
Public property SSAOrandomTextureSize: Single read GetSSAOrandomTextureSize write SetSSAOrandomTextureSize;
Public property FdTessellationDetailCulling: TSFBool read FFdTessellationDetailCulling;
Public property TessellationDetailCulling: Boolean read GetTessellationDetailCulling write SetTessellationDetailCulling;
Public property FdTessellationErrorFactor: TSFFloat read FFdTessellationErrorFactor;
Public property TessellationErrorFactor: Single read GetTessellationErrorFactor write SetTessellationErrorFactor;
Public property FdTessellationErrorThreshold: TSFFloat read FFdTessellationErrorThreshold;
Public property TessellationErrorThreshold: Single read GetTessellationErrorThreshold write SetTessellationErrorThreshold;
Public property FdTonemapping: TSFStringEnum read FFdTonemapping;
Public property Tonemapping: TToneMapping read GetTonemapping write SetTonemapping;
Public property FdUserDataFactor: TSFFloat read FFdUserDataFactor;
Public property UserDataFactor: Single read GetUserDataFactor write SetUserDataFactor;

Description

Methods

Public procedure CreateNode; override;

Create node fields and events.

Public class function ClassX3DType: String; override;

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Properties

Public property FdEnableARC: TSFBool read FFdEnableARC;

Internal wrapper for property EnableARC. This wrapper API may change, we advise to access simpler EnableARC instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property EnableARC: Boolean read GetEnableARC write SetEnableARC;

Experimental: If true ARC adjusts rendering parameters

Public property FdFrustumCulling: TSFBool read FFdFrustumCulling;

Internal wrapper for property FrustumCulling. This wrapper API may change, we advise to access simpler FrustumCulling instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property FrustumCulling: Boolean read GetFrustumCulling write SetFrustumCulling;

If TRUE, objects outside the viewing frustum are ignored

Public property FdGammaCorrectionDefault: TSFString read FFdGammaCorrectionDefault;

Internal wrapper for property GammaCorrectionDefault. This wrapper API may change, we advise to access simpler GammaCorrectionDefault instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property GammaCorrectionDefault: String read GetGammaCorrectionDefault write SetGammaCorrectionDefault;

The gamma correction to apply by default, see lighting and gamma tutorial

Public property FdLowPriorityCulling: TSFBool read FFdLowPriorityCulling;

Internal wrapper for property LowPriorityCulling. This wrapper API may change, we advise to access simpler LowPriorityCulling instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property LowPriorityCulling: Boolean read GetLowPriorityCulling write SetLowPriorityCulling;

If TRUE and occlusion culling supported, only threshold fraction of objects, sorted by their screen space coverage, are rendered

Public property FdLowPriorityFactor: TSFFloat read FFdLowPriorityFactor;

Internal wrapper for property LowPriorityFactor. This wrapper API may change, we advise to access simpler LowPriorityFactor instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property LowPriorityFactor: Single read GetLowPriorityFactor write SetLowPriorityFactor;

Experimenal: Factor of low priority culling for controlling speed-performance trade-off

Public property FdLowPriorityThreshold: TSFFloat read FFdLowPriorityThreshold;

Internal wrapper for property LowPriorityThreshold. This wrapper API may change, we advise to access simpler LowPriorityThreshold instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property LowPriorityThreshold: Single read GetLowPriorityThreshold write SetLowPriorityThreshold;

Only threshold fraction of objects, sorted by their screen space coverage, are rendered

Public property FdMaxFrameRate: TSFFloat read FFdMaxFrameRate;

Internal wrapper for property MaxFrameRate. This wrapper API may change, we advise to access simpler MaxFrameRate instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MaxFrameRate: Single read GetMaxFrameRate write SetMaxFrameRate;

Experimental: Define maximal target frame-rate for dynamic moments and quality-speed trade-off

Public property FdMinFrameRate: TSFFloat read FFdMinFrameRate;

Internal wrapper for property MinFrameRate. This wrapper API may change, we advise to access simpler MinFrameRate instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MinFrameRate: Single read GetMinFrameRate write SetMinFrameRate;

Experimental: Define minimal target frame-rate for static moments and quality-speed trade-off

Public property FdOcclusionCulling: TSFBool read FFdOcclusionCulling;

Internal wrapper for property OcclusionCulling. This wrapper API may change, we advise to access simpler OcclusionCulling instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property OcclusionCulling: Boolean read GetOcclusionCulling write SetOcclusionCulling;

If TRUE and occlusion culling supported, objects occluding less than the threshold below are ignored

Public property FdOcclusionVisibilityFactor: TSFFloat read FFdOcclusionVisibilityFactor;

Internal wrapper for property OcclusionVisibilityFactor. This wrapper API may change, we advise to access simpler OcclusionVisibilityFactor instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property OcclusionVisibilityFactor: Single read GetOcclusionVisibilityFactor write SetOcclusionVisibilityFactor;

Experimenal: Factor of occlusion culling for controlling speed-performance trade-off

Public property FdOcclusionVisibilityThreshold: TSFFloat read FFdOcclusionVisibilityThreshold;

Internal wrapper for property OcclusionVisibilityThreshold. This wrapper API may change, we advise to access simpler OcclusionVisibilityThreshold instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property OcclusionVisibilityThreshold: Single read GetOcclusionVisibilityThreshold write SetOcclusionVisibilityThreshold;

Objects occluding less than the threshold below are ignored

Public property FdShadowExcludeTransparentObjects: TSFBool read FFdShadowExcludeTransparentObjects;

Internal wrapper for property ShadowExcludeTransparentObjects. This wrapper API may change, we advise to access simpler ShadowExcludeTransparentObjects instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property ShadowExcludeTransparentObjects: Boolean read GetShadowExcludeTransparentObjects write SetShadowExcludeTransparentObjects;

Transparent objects like glass do not throw much shadow, enable this IR convenience flag with TRUE

Public property FdSmallFeatureCulling: TSFBool read FFdSmallFeatureCulling;

Internal wrapper for property SmallFeatureCulling. This wrapper API may change, we advise to access simpler SmallFeatureCulling instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SmallFeatureCulling: Boolean read GetSmallFeatureCulling write SetSmallFeatureCulling;

If TRUE, objects smaller than the threshold below are ignored

Public property FdSmallFeatureFactor: TSFFloat read FFdSmallFeatureFactor;

Internal wrapper for property SmallFeatureFactor. This wrapper API may change, we advise to access simpler SmallFeatureFactor instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SmallFeatureFactor: Single read GetSmallFeatureFactor write SetSmallFeatureFactor;

Experimenal: Factor of small feature culling for controlling speed-performance trade-off

Public property FdSmallFeatureThreshold: TSFFloat read FFdSmallFeatureThreshold;

Internal wrapper for property SmallFeatureThreshold. This wrapper API may change, we advise to access simpler SmallFeatureThreshold instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SmallFeatureThreshold: Single read GetSmallFeatureThreshold write SetSmallFeatureThreshold;

Objects smaller than the threshold below are ignored

Public property FdSortTrans: TSFBool read FFdSortTrans;

Internal wrapper for property SortTrans. This wrapper API may change, we advise to access simpler SortTrans instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SortTrans: Boolean read GetSortTrans write SetSortTrans;

If TRUE, transparent objects are sorted from back to front (allows explicitly disabling sorting)

Public property FdSSAO: TSFBool read FFdSSAO;

Internal wrapper for property SSAO. This wrapper API may change, we advise to access simpler SSAO instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SSAO: Boolean read GetSSAO write SetSSAO;

Flag to enable Screen Space Ambient Occlusion

Public property FdSSAOamount: TSFFloat read FFdSSAOamount;

Internal wrapper for property SSAOamount. This wrapper API may change, we advise to access simpler SSAOamount instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SSAOamount: Single read GetSSAOamount write SetSSAOamount;

Value that determines the amount of contribution of SSAO (from 0 to 1)

Public property FdSSAOblurDepthTreshold: TSFFloat read FFdSSAOblurDepthTreshold;

Internal wrapper for property SSAOblurDepthTreshold. This wrapper API may change, we advise to access simpler SSAOblurDepthTreshold instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SSAOblurDepthTreshold: Single read GetSSAOblurDepthTreshold write SetSSAOblurDepthTreshold;

Value that determines the maximum depth difference for the SSAO blurring pass. Pixels with higher depth difference to the filer kernel center are not incorporated into the average.

Public property FdSSAOradius: TSFFloat read FFdSSAOradius;

Internal wrapper for property SSAOradius. This wrapper API may change, we advise to access simpler SSAOradius instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SSAOradius: Single read GetSSAOradius write SetSSAOradius;

Value that determines the radius in which the SSAO is sampled in world space

Public property FdSSAOrandomTextureSize: TSFFloat read FFdSSAOrandomTextureSize;

Internal wrapper for property SSAOrandomTextureSize. This wrapper API may change, we advise to access simpler SSAOrandomTextureSize instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property SSAOrandomTextureSize: Single read GetSSAOrandomTextureSize write SetSSAOrandomTextureSize;

Value that determines the size of the random texture used for sparse sampling of SSAO

Public property FdTessellationDetailCulling: TSFBool read FFdTessellationDetailCulling;

Internal wrapper for property TessellationDetailCulling. This wrapper API may change, we advise to access simpler TessellationDetailCulling instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property TessellationDetailCulling: Boolean read GetTessellationDetailCulling write SetTessellationDetailCulling;

If TRUE, shape tesselation is lowered as long as resulting error is lower than threshold

Public property FdTessellationErrorFactor: TSFFloat read FFdTessellationErrorFactor;

Internal wrapper for property TessellationErrorFactor. This wrapper API may change, we advise to access simpler TessellationErrorFactor instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property TessellationErrorFactor: Single read GetTessellationErrorFactor write SetTessellationErrorFactor;

Experimenal: Factor of tesselation error for controlling speed-performance trade-off

Public property FdTessellationErrorThreshold: TSFFloat read FFdTessellationErrorThreshold;

Internal wrapper for property TessellationErrorThreshold. This wrapper API may change, we advise to access simpler TessellationErrorThreshold instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property TessellationErrorThreshold: Single read GetTessellationErrorThreshold write SetTessellationErrorThreshold;

Shape tesselation is lowered as long as resulting error is lower than threshold

Public property FdTonemapping: TSFStringEnum read FFdTonemapping;

Internal wrapper for property Tonemapping. This wrapper API may change, we advise to access simpler Tonemapping instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Tonemapping: TToneMapping read GetTonemapping write SetTonemapping;

Specifies the used tonemapping operator. Note that X3DOM and Castle Game Engine support a bit different tone mapping options.

Public property FdUserDataFactor: TSFFloat read FFdUserDataFactor;

Internal wrapper for property UserDataFactor. This wrapper API may change, we advise to access simpler UserDataFactor instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property UserDataFactor: Single read GetUserDataFactor write SetUserDataFactor;

Experimenal: Factor of user data for controlling speed-performance trade-off

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.