 | |
Rendering | |
RenderingLayer is a rendering layer with a queue that is used to store RenderingItem that have similar properties and are rendered one after another.
Objects inside the rendering layer can be reordered or sorted to improve performance or make sure that the rendered results are correct (for example for transparency sorting).
Inheritance HierarchySystemObject
Ab4d.SharpEngine.RenderingLayersRenderingLayer
Ab4d.SharpEngine.RenderingLayersSortedRenderingLayer
Ab4d.SharpEngine.RenderingLayersRenderingLayer
Ab4d.SharpEngine.RenderingLayersSortedRenderingLayer
Namespace: Ab4d.SharpEngine.RenderingLayers
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035
SyntaxC#
public class RenderingLayer : IDisposable, IEnumerable<RenderingItem>, IEnumerable
The RenderingLayer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RenderingLayer | Constructor |
Properties| Name | Description | |
|---|---|---|
 | AllowedEffectType | When not null it prevents adding RenderingItems with other effect type to this RenderingLayer. |
| ClearDepthStencilBufferAfterRendering | When set to true, then DepthStencil buffer is cleared after rendering object in this rendering queue. When this rendering queue does not have any object, then DepthStencil buffer is not cleared. This may be used for BackgroundRenderingLayer so that object in that rendering queue will always be rendered behind any other objects. |
| ClearDepthStencilBufferBeforeRendering | When set to true, then DepthStencil buffer is cleared before rendering object in this rendering queue. When this rendering queue does not have any object, then DepthStencil buffer is not cleared. This may be used for OverlayRenderingLayer so that object in that rendering queue will always be rendered on top of all other objects. |
| Count | Count of RenderingItem objects used by this RenderingLayer |
| CustomAmbientLightColor | When not null, then the RenderingItems in this RenderingLayout are rendered by using the specified ambient light color. |
| CustomCamera | When not null, then the RenderingItems in this RenderingLayout are rendered by using the specified camera. |
| CustomViewport | When not null, then the specified Viewport is used to render RenderingItems in this RenderingLayout. By default, the X, Y, Width and Height values are specified in absolute units (without super-sampling). This can be changed by setting IsCustomViewportInRelativeValues to true. The MinDepth and MaxDepth are always in relative units (from 0 to 1). |
| IsCustomViewportInRelativeValues | When true, then the X, Y, Width and Height values in CustomViewport are in relative units (from 0 to 1). |
| IsDisposed | True if this RenderingLayer was disposed |
| IsRenderingEnabled | Gets or sets a Boolean that specifies if the objects in this rendering layer are rendered (true by default). |
| Item | Gets a RenderingItem with the specified index |
| ParentScene | Gets the Scene where this RenderingLayer is used. This value is set when the RenderingLayer is added to the Scene. When null, then this RenderingLayer was not yet added to the Scene or was removed from the Scene. |
| SceneViewSpecific | When not null, then the RenderingItems in this RenderingLayout are rendered only when the specified SceneView is rendered (and not for other SceneViews). |
Methods| Name | Description | |
|---|---|---|
| Add | Adds RenderingItem object to this layer |
| Clear | Removes all RenderingItem objects from this layer |
| Dispose | Dispose |
 | Dispose(Boolean) | Dispose |
| GetCustomSceneDescriptorSet | |
| GetEnumerator | Returns an enumerator that iterates through the collection. |
| Remove | Removes RenderingItem object from this layer |
| Replace | Replaces oldRenderingItem object with newRenderingItem (the newRenderingItem preserves the positions of the oldRenderingItem). |
| ToString |
ToString
(Overrides ObjectToString) |
| UpdateCustomSceneDescriptorSet |
Fields| Name | Description | |
|---|---|---|
 | ContainsTransparentObjects | Gets a Boolean that specifies if this RenderingLayer can contains transparent objects. |
 | isSortOrderDirty | Specifies if Add, Remove, Replace or Clear method were called. This is used in SortedRenderingLayer to mark when new sort is needed. |
| Name | Name of this RenderingLayer. |
| renderingItems | List of RenderingItem objects used by this RenderingLayer |
See Also