Compositor
An ordered collection of effects at 3D rendering stages.
Assign Compositor to WorldEnvironment for the world or Camera3D for a camera. A camera compositor replaces the entire world compositor even with an empty list; lists are not merged. Removing the camera override restores the world compositor. It does not automatically disable every Environment setting.
CompositorEffects retains shared effect references. Its getter and setter copy the container: assign the array back after adding or removing an entry. Changing an assigned effect’s Enabled works without rebuilding the list. Empty entries do not execute. Effects within a stage follow array order; different stages follow rendering order.
Used through RenderingDevice in Forward+ and Mobile. Mobile stage availability is limited; Compatibility does not support this path. Setup and an executed C# example: compositor guide.
Container copying, Enabled changes and camera precedence were checked on current Windows/Vulkan. Pixel modification, MSAA, XR and performance were not established by these checks.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
CompositorConstructor
public Compositor();Creates an empty compositor container. Assign it to WorldEnvironment or Camera3D and populate CompositorEffects to attach effects.
Properties1
CompositorEffectsProperty
public Reckfell.Collections.Array<CompositorEffect> CompositorEffects { get; set; }Ordered shared CompositorEffect references; initially empty. The getter returns a new container: editing its contents does not change this resource until reassigned. The setter copies the container while retaining effect references. Empty entries remain in the array but are not executed. Array order applies within a stage; different stages follow rendering order.
Methods2
GetCompositorEffectsReckfell.Collections.Array<CompositorEffect>
public Reckfell.Collections.Array<CompositorEffect> GetCompositorEffects();Returns the value of Compositor.CompositorEffects.
Reckfell.Collections.Array<CompositorEffect>A new container holding shared references to assigned effects. Assign it back after changing its contents.
SetCompositorEffectsvoid
public void SetCompositorEffects(Reckfell.Collections.Array<CompositorEffect> compositorEffects);Assigns the value of Compositor.CompositorEffects.
| Name | Type | Default |
|---|---|---|
compositorEffects | Reckfell.Collections.Array<CompositorEffect> | — |
compositorEffectsOrdered shared CompositorEffect references; initially empty. The getter returns a new container: editing its contents does not change this resource until reassigned. The setter copies the container while retaining effect references. Empty entries remain in the array but are not executed. Array order applies within a stage; different stages follow rendering order.