Class TCastleRenderOptions
Unit
Declaration
type TCastleRenderOptions = class(TCastleComponent)
Description
Options that control rendering, available at every scene through TCastleScene.RenderOptions.
Source: src/base/castlerenderoptions_renderoptions.inc (line 26).
Hierarchy
- TObject
- TPersistent
- TComponent
- TCastleComponent
- TCastleRenderOptions
Overview
Fields
![]() |
nested const DefaultPointSize = 3.0; |
![]() |
nested const DefaultLineWidth = 2.0; |
![]() |
nested const DefaultBumpMapping = bmBasic; |
![]() |
nested const DefaultBumpMappingParallaxHeight = 0.01; |
![]() |
nested const DefaultPhongShading = true; |
![]() |
nested const DefaultMaxLightsPerShape = 64; |
![]() |
nested const DefaultBlendingSourceFactor = bsSrcAlpha; |
![]() |
nested const DefaultBlendingDestinationFactor = bdOneMinusSrcAlpha; |
![]() |
nested const DefaultWireframeColor: TCastleColorRGB = (X: 0; Y: 0; Z: 0); |
![]() |
nested const DefaultSolidWireframeScale = 1; |
![]() |
nested const DefaultSolidWireframeBias = 1; |
![]() |
nested const DefaultSilhouetteScale = 5; |
![]() |
nested const DefaultSilhouetteBias = 5; |
![]() |
nested const DefaultShadowSampling = ssPCF16; |
![]() |
class var DefaultMinificationFilter: TMinificationFilter; |
![]() |
DefaultMagnificationFilter: TMagnificationFilter; |
![]() |
OnCreate: TCastleRenderOptionsEvent; |
Methods
![]() |
procedure ReleaseCachedResources; virtual; |
![]() |
constructor Create(AOwner: TComponent); override; |
![]() |
destructor Destroy; override; |
![]() |
procedure CustomSerialization(const SerializationProcess: TSerializationProcess); override; |
![]() |
function PropertySections(const PropertyName: String): TPropertySections; override; |
![]() |
procedure Assign(Source: TPersistent); override; |
![]() |
function Equals(Obj: TObject): Boolean; override; |
Properties
![]() |
property Mode: TRenderingMode read FMode write SetMode default rmFull; |
![]() |
property DepthTest: boolean read FDepthTest write SetDepthTest default true; |
![]() |
property SolidColor: TCastleColorRGB read FSolidColor write SetSolidColor; |
![]() |
property WireframeColor: TCastleColorRGB
read FWireframeColor write SetWireframeColor; |
![]() |
property InternalColorChannels: TColorChannels
read FColorChannels write SetColorChannels default AllColorChannels; |
![]() |
property Lighting: boolean read FLighting write SetLighting default true; |
![]() |
property ReceiveSceneLights: boolean
read FReceiveSceneLights write SetReceiveSceneLights default true; |
![]() |
property ReceiveGlobalLights: boolean
read FReceiveGlobalLights write SetReceiveGlobalLights default true; |
![]() |
property Textures: boolean
read FTextures write SetTextures default true; |
![]() |
property MinificationFilter: TAutoMinificationFilter
read FMinificationFilter write SetMinificationFilter default minDefault; |
![]() |
property MagnificationFilter: TAutoMagnificationFilter
read FMagnificationFilter write SetMagnificationFilter default magDefault; |
![]() |
property PointSize: Single
read FPointSize write SetPointSize stored IsStoredPointSize; |
![]() |
property LineWidth: Single
read FLineWidth write SetLineWidth stored IsStoredLineWidth; |
![]() |
property BumpMapping: TBumpMapping
read FBumpMapping write SetBumpMapping default DefaultBumpMapping; |
![]() |
property BumpMappingParallaxHeight: Single
read FBumpMappingParallaxHeight write SetBumpMappingParallaxHeight
stored IsStoredBumpMappingParallaxHeight; |
![]() |
property PhongShading: boolean read FPhongShading write SetPhongShading
default DefaultPhongShading; |
![]() |
property ShadowSampling: TShadowSampling
read FShadowSampling write SetShadowSampling
default DefaultShadowSampling; |
![]() |
property MaxLightsPerShape: Cardinal
read FMaxLightsPerShape write SetMaxLightsPerShape default DefaultMaxLightsPerShape; |
![]() |
property Blending: boolean
read FBlending write SetBlending default true; |
![]() |
property BlendingSourceFactor: TBlendingSourceFactor
read FBlendingSourceFactor write SetBlendingSourceFactor
default DefaultBlendingSourceFactor; |
![]() |
property BlendingDestinationFactor: TBlendingDestinationFactor
read FBlendingDestinationFactor write SetBlendingDestinationFactor
default DefaultBlendingDestinationFactor; |
![]() |
property WireframeEffect: TWireframeEffect
read FWireframeEffect write SetWireframeEffect default weNormal; |
![]() |
property SolidWireframeScale: Single
read FSolidWireframeScale write SetSolidWireframeScale stored IsStoredSolidWireframeScale; |
![]() |
property SolidWireframeBias: Single
read FSolidWireframeBias write SetSolidWireframeBias stored IsStoredSolidWireframeBias; |
![]() |
property SilhouetteScale: Single
read FSilhouetteScale write SetSilhouetteScale stored IsStoredSilhouetteScale; |
![]() |
property SilhouetteBias: Single
read FSilhouetteBias write SetSilhouetteBias stored IsStoredSilhouetteBias; |
![]() |
property RobustNegativeScale: Boolean
read FRobustNegativeScale write SetRobustNegativeScale default false; |
![]() |
property WholeSceneManifold: Boolean
read FWholeSceneManifold write SetWholeSceneManifold default false; |
![]() |
property WireframeColorPersistent: TCastleColorRGBPersistent read FWireframeColorPersistent ; |
Description
Fields
![]() |
nested const DefaultPointSize = 3.0; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 120). | |
![]() |
nested const DefaultLineWidth = 2.0; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 121). | |
![]() |
nested const DefaultBumpMapping = bmBasic; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 122). | |
![]() |
nested const DefaultBumpMappingParallaxHeight = 0.01; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 123). | |
![]() |
nested const DefaultPhongShading = true; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 124). | |
![]() |
nested const DefaultMaxLightsPerShape = 64; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 125). | |
![]() |
nested const DefaultBlendingSourceFactor = bsSrcAlpha; |
|
Default value of TCastleRenderOptions.BlendingSourceFactor. This is the typical blending operation. Source: src/base/castlerenderoptions_renderoptions.inc (line 129). | |
![]() |
nested const DefaultBlendingDestinationFactor = bdOneMinusSrcAlpha; |
|
Default value of TCastleRenderOptions.BlendingDestinationFactor. This is the typical blending operation. Source: src/base/castlerenderoptions_renderoptions.inc (line 133). | |
![]() |
nested const DefaultWireframeColor: TCastleColorRGB = (X: 0; Y: 0; Z: 0); |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 135). | |
![]() |
nested const DefaultSolidWireframeScale = 1; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 137). | |
![]() |
nested const DefaultSolidWireframeBias = 1; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 138). | |
![]() |
nested const DefaultSilhouetteScale = 5; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 139). | |
![]() |
nested const DefaultSilhouetteBias = 5; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 140). | |
![]() |
nested const DefaultShadowSampling = ssPCF16; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 142). | |
![]() |
class var DefaultMinificationFilter: TMinificationFilter; |
|
Value used when MinificationFilter is minDefault. By default, this is minLinearMipmapLinear. Source: src/base/castlerenderoptions_renderoptions.inc (line 147). | |
![]() |
DefaultMagnificationFilter: TMagnificationFilter; |
|
Value used when MagnificationFilter is magDefault. By default, this is magLinear. Source: src/base/castlerenderoptions_renderoptions.inc (line 150). | |
![]() |
OnCreate: TCastleRenderOptionsEvent; |
|
Adjust attributes of all loaded resources. Source: src/base/castlerenderoptions_renderoptions.inc (line 152). | |
Methods
![]() |
procedure ReleaseCachedResources; virtual; |
|
Called before changing an attribute that requires the release of things cached in a renderer. This includes attributes that affect:
Source: src/base/castlerenderoptions_renderoptions.inc (line 117). | |
![]() |
constructor Create(AOwner: TComponent); override; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 154). | |
![]() |
destructor Destroy; override; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 155). | |
![]() |
procedure CustomSerialization(const SerializationProcess: TSerializationProcess); override; |
|
This item has no description. Showing description inherited from TCastleComponent.CustomSerialization. Override this method to call various methods of SerializationProcess, which in turn allows to serialize/deserialize things that are not published. This allows to serialize/deserialize with more freedom, e.g. to serialize/deserialize some private field. Source: src/base/castlerenderoptions_renderoptions.inc (line 156). | |
![]() |
function PropertySections(const PropertyName: String): TPropertySections; override; |
|
This item has no description. Showing description inherited from TCastleComponent.PropertySections. Section where to show property in the editor. Source: src/base/castlerenderoptions_renderoptions.inc (line 157). | |
![]() |
procedure Assign(Source: TPersistent); override; |
|
Copies all propeties from Source, the same properties that affect Equals. Source: src/base/castlerenderoptions_renderoptions.inc (line 161). | |
![]() |
function Equals(Obj: TObject): Boolean; override; |
|
Equal TCastleRenderOptions produce the same effect when rendering and can be treated as exactly equivalent by the TCastleViewport.DynamicBatching algorithm. Source: src/base/castlerenderoptions_renderoptions.inc (line 166). | |
Properties
![]() |
property Mode: TRenderingMode read FMode write SetMode default rmFull; |
|
Rendering mode, can be used to disable many rendering features at once. Source: src/base/castlerenderoptions_renderoptions.inc (line 176). | |
![]() |
property DepthTest: boolean read FDepthTest write SetDepthTest default true; |
|
By default, we use depth testing to determine which objects are in front of the others. This allows to display all 3D content (all TCastleScene instances, and all shapes inside them) in any order. For very special purposes, you can disable depth testing. This means that 3D objects will always be drawn in front of the previous ones, in the order in which they are rendered, ignoring the contents of the depth buffer. Use only if you know what you're doing, if you're sure that the order of rendering will always be good. Source: src/base/castlerenderoptions_renderoptions.inc (line 188). | |
![]() |
property SolidColor: TCastleColorRGB read FSolidColor write SetSolidColor; |
|
Color used when Mode is rmSolidColor. By default BlackRGB. Source: src/base/castlerenderoptions_renderoptions.inc (line 192). | |
![]() |
property WireframeColor: TCastleColorRGB
read FWireframeColor write SetWireframeColor; |
|
Wireframe color, used with some WireframeEffect values. Default value is DefaultWireframeColor. Source: src/base/castlerenderoptions_renderoptions.inc (line 196). | |
![]() |
property InternalColorChannels: TColorChannels
read FColorChannels write SetColorChannels default AllColorChannels; |
|
Which color buffer channels (RGBA) to write when rendering this model. This makes a cool effect, avoiding writing to some color channels, but writing others, and writing depth buffer. This property may change to be non-internal some day, please report on Castle Game Engine forum / Discord / GitHub ( https://castle-engine.io/talk.php ) if you find it useful. Source: src/base/castlerenderoptions_renderoptions.inc (line 206). | |
![]() |
property Lighting: boolean read FLighting write SetLighting default true; |
|
Enable real-time lighting when rendering. Source: src/base/castlerenderoptions_renderoptions.inc (line 210). | |
![]() |
property ReceiveSceneLights: boolean
read FReceiveSceneLights write SetReceiveSceneLights default true; |
|
Use lights defined in this scene (in the model loaded to this TCastleScene) to light the shapes in this scene. Note: This property controls whether lights defined within a model (TCastleScene) affect the shapes in the same model. In case of such lights, the value of TCastleScene.CastGlobalLights and ReceiveGlobalLights doesn't matter. Only this property, The other lights are controlled by ReceiveGlobalLights. This doesn't matter if Lighting is Source: src/base/castlerenderoptions_renderoptions.inc (line 226). | |
![]() |
property ReceiveGlobalLights: boolean
read FReceiveGlobalLights write SetReceiveGlobalLights default true; |
|
Use lights defined in other scenes to light the shapes in this scene. This property controls whether other scenes with TCastleScene.CastGlobalLights, as well as headlight, shine on this scene. This doesn't matter if Lighting is Source: src/base/castlerenderoptions_renderoptions.inc (line 238). | |
![]() |
property Textures: boolean
read FTextures write SetTextures default true; |
|
Use Source: src/base/castlerenderoptions_renderoptions.inc (line 242). | |
![]() |
property MinificationFilter: TAutoMinificationFilter
read FMinificationFilter write SetMinificationFilter default minDefault; |
|
Default minification and magnification filters for textures. These can be overridden on a per-texture basis in VRML / X3D files by X3D TextureProperties node (see X3D specification). They can be equal to minDefault, magDefault in which case they actually use the values from DefaultMinificationFilter, DefaultMagnificationFilter (by default minLinearMipmapLinear, magLinear). Source: src/base/castlerenderoptions_renderoptions.inc (line 255). | |
![]() |
property MagnificationFilter: TAutoMagnificationFilter
read FMagnificationFilter write SetMagnificationFilter default magDefault; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 257). | |
![]() |
property PointSize: Single
read FPointSize write SetPointSize stored IsStoredPointSize; |
|
Size of points. This has an effect on TPointSetNode rendering. Must be > 0. Source: src/base/castlerenderoptions_renderoptions.inc (line 263). | |
![]() |
property LineWidth: Single
read FLineWidth write SetLineWidth stored IsStoredLineWidth; |
|
Line width. This has an effect on TLineSetNode rendering, and on wireframe rendering when TCastleRenderOptions.WireframeEffect indicates it. Must be > 0. Source: src/base/castlerenderoptions_renderoptions.inc (line 269). | |
![]() |
property BumpMapping: TBumpMapping
read FBumpMapping write SetBumpMapping default DefaultBumpMapping; |
|
Use bump mapping. The bump mapping is only done when particular shape defines a normal map (and a height map, if you want parallax bump mapping). See https://castle-engine.io/bump_mapping . The normal map is usually provided in the TAbstractOneSidedMaterialNode.NormalTexture field. TAbstractOneSidedMaterialNode is an ancestor of all useful material nodes, like TMaterialNode (Phong lighting), TPhysicalMaterialNode (PBR lighting), and even TUnlitMaterialNode (unlit – doesn't use normals for lighting, but may still use them e.g. for tex coord generation). So all material nodes allow to specify normal map. See TBumpMapping for various possible values. Source: src/base/castlerenderoptions_renderoptions.inc (line 286). | |
![]() |
property BumpMappingParallaxHeight: Single
read FBumpMappingParallaxHeight write SetBumpMappingParallaxHeight
stored IsStoredBumpMappingParallaxHeight; |
|
Maximum height expressed in the normal map alpha channel, used only when BumpMapping indicates one of the "parallax" options. By default this is ignored because BumpMapping by default is just bmBasic, which ignores the height map in the normal map alpha channel. If your normal map includes an alpha channel, and you set BumpMapping to a value bmParallax, bmSteepParallax, bmSteepParallaxShadowing then this property is used to interpret the height information. Source: src/base/castlerenderoptions_renderoptions.inc (line 297). | |
![]() |
property PhongShading: boolean read FPhongShading write SetPhongShading
default DefaultPhongShading; |
|
Whether to use Phong shading by default. Note that each shape may override it by TAbstractShapeNode.Shading field. Note that Phong shading is forced anyway by various situations:
Source: src/base/castlerenderoptions_renderoptions.inc (line 313). | |
![]() |
property ShadowSampling: TShadowSampling
read FShadowSampling write SetShadowSampling
default DefaultShadowSampling; |
|
Shadow maps sampling. Various approaches result in various quality and speed. Source: src/base/castlerenderoptions_renderoptions.inc (line 317). | |
![]() |
property MaxLightsPerShape: Cardinal
read FMaxLightsPerShape write SetMaxLightsPerShape default DefaultMaxLightsPerShape; |
|
For efficiency reasons, we only allow a finite number of lights that can affect the given shape. You can increase this number if necessary, although note that it is alreday quite large by default. Instead of increasing this limit, it is always more efficient to design your scenes to fit within this limit. Use the light source radius and/or scope (e.g. you can use "radius" in Blender, it is exported OK to glTF), and make smaller shapes. Note that on ancient dekstops, with fixed-function OpenGL pipeline, there is an additional hard limit (dependent on GPU, but usually 8, for this). But on modern desktops, as well as mobile and other platforms, you can increase this limit freely. Source: src/base/castlerenderoptions_renderoptions.inc (line 335). | |
![]() |
property Blending: boolean
read FBlending write SetBlending default true; |
|
Render partially transparent objects. More precisely: if this is If this is Source: src/base/castlerenderoptions_renderoptions.inc (line 347). | |
![]() |
property BlendingSourceFactor: TBlendingSourceFactor
read FBlendingSourceFactor write SetBlendingSourceFactor
default DefaultBlendingSourceFactor; |
|
Blending function parameters, used when Blending. See https://castle-engine.io/blending for more information about blending. For the exact meaning of The typical blending setup (default) is to use
This is the standard that follows most intuitive transparency equation. The major drawback of this default (and why you may want to consider alternatives) is that it depends on a correct order of rendering partially-transparent shapes. CGE allows to cope with it:
Note that these properties can be overridden on each shape using TBlendModeNode. See https://castle-engine.io/x3d_extensions.php#section_ext_blending for details of TBlendModeNode. Source: src/base/castlerenderoptions_renderoptions.inc (line 415). | |
![]() |
property BlendingDestinationFactor: TBlendingDestinationFactor
read FBlendingDestinationFactor write SetBlendingDestinationFactor
default DefaultBlendingDestinationFactor; |
|
This item has no description. Source: src/base/castlerenderoptions_renderoptions.inc (line 418). | |
![]() |
property WireframeEffect: TWireframeEffect
read FWireframeEffect write SetWireframeEffect default weNormal; |
|
Activate various effects related to wireframe rendering. When this is weNormal (default), we simply render polygons as polygons. See description of TWireframeEffect for what other modes do. Note: How the wireframe effects work when Mode = rmDepth is undefined now. Don't use Mode = rmDepth with Source: src/base/castlerenderoptions_renderoptions.inc (line 429). | |
![]() |
property SolidWireframeScale: Single
read FSolidWireframeScale write SetSolidWireframeScale stored IsStoredSolidWireframeScale; |
|
Depth scale in SolidWireframeScale and depth bias in SolidWireframeBias are used to render the mesh when WireframeEffect = weSolidWireframe. Larger values will "push forward" the rendered mesh a bit, meaning that the wireframe will be more clearly visible in front of it. To explain it best, understand how rendering with WireframeEffect = weSolidWireframe is done:
Source: src/base/castlerenderoptions_renderoptions.inc (line 458). | |
![]() |
property SolidWireframeBias: Single
read FSolidWireframeBias write SetSolidWireframeBias stored IsStoredSolidWireframeBias; |
|
See SolidWireframeScale for explanation. Source: src/base/castlerenderoptions_renderoptions.inc (line 462). | |
![]() |
property SilhouetteScale: Single
read FSilhouetteScale write SetSilhouetteScale stored IsStoredSilhouetteScale; |
|
Depth scale in SilhouetteScale and depth bias in SilhouetteBias are used to render the silhouette when WireframeEffect = weSilhouette. Larger values will "push back" the rendered lines a bit, meaning that the effect will more clearly outline the object, and not look like a wireframe over the object. To explain it best, understand how rendering with WireframeEffect = weSilhouette is done:
When both SilhouetteScale and SilhouetteBias are zero, the wireframe is rendered with the same depth as a regular object, and it's undefined which one will be visible . Most likely it will look similar to WireframeEffect = weSolidWireframe actually. When both SilhouetteScale and SilhouetteBias are > zero, then only the lines that are "silhouettes" will be visible – other lines will be hidden by the object rendered in the 1st pass. You can make the effect more or less "subtle" by changing these parameters. Source: src/base/castlerenderoptions_renderoptions.inc (line 503). | |
![]() |
property SilhouetteBias: Single
read FSilhouetteBias write SetSilhouetteBias stored IsStoredSilhouetteBias; |
|
See SilhouetteScale for explanation. Source: src/base/castlerenderoptions_renderoptions.inc (line 507). | |
![]() |
property RobustNegativeScale: Boolean
read FRobustNegativeScale write SetRobustNegativeScale default false; |
|
Support lighting and backface culling for models using negative scale. This has a small performance cost, and so is disabled by default. Source: src/base/castlerenderoptions_renderoptions.inc (line 512). | |
![]() |
property WholeSceneManifold: Boolean
read FWholeSceneManifold write SetWholeSceneManifold default false; |
|
Use this scene as a shadow caster for shadow volumes, regardless of whether it is detected as 2-manifold. Note: The engine automatically detects if a scene is 2-manifold, which can mean that:
If the engine detected that scene is 2-manifold (regardless of whether each shape was 2-manifold or only whole scene is 2-manifold) then using this property is not necessary. Setting this property to
Source: src/base/castlerenderoptions_renderoptions.inc (line 569). | |
![]() |
property WireframeColorPersistent: TCastleColorRGBPersistent read FWireframeColorPersistent ; |
|
WireframeColor that can be visually edited in Castle Game Engine Editor, Lazarus and Delphi. Normal user code does not need to deal with this, instead read or write WireframeColor directly. See also
| |
Generated by PasDoc 0.17.0.snapshot.


