Click or drag to resize
AB4D logo

RenderingQueue Class

RenderingQueue is a queue that is used to store renderable objects that have similar properties and are rendered one after another. Objects inside the queue can be reordered or sorted to improve performance or make sure that the rendered results are correct (for example for transparency sorting).
Inheritance Hierarchy
SystemObject
  Ab3d.DirectXRenderingQueue
    Ab3d.DirectXRenderablePrimitiveRenderingQueue

Namespace: Ab3d.DirectX
Assembly: Ab3d.DXEngine (in Ab3d.DXEngine.dll) Version: 7.0.8865.1045
Syntax
C#
Copy
public class RenderingQueue : IDisposable, 
	IEnumerable<RenderablePrimitiveBase>, IEnumerable

The RenderingQueue type exposes the following members.

Constructors
 NameDescription
Public methodRenderingQueue Constructor
Top
Properties
 NameDescription
Public propertyClearDepthStencilBufferAfterRendering 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 BackgroundRenderingQueue so that object in that rendering queue will be always rendered on behind any other objects.
Public propertyClearDepthStencilBufferBeforeRendering 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 OverlayRenderingQueue so that object in that rendering queue will be always rendered on top of all other objects.
Public propertyCount Count of renderable objects used by this RenderingQueue
Public propertyIsDisposed True if this RenderingQueue was disposed
Public propertyIsRenderedWithCustomRenderingStep When set to true, then this RenderingQueue can be rendered only with a RenderObjectsRenderingStep that has the FilterRenderingQueuesFunction set and is not rendered with standard RenderObjectsRenderingStep (DefaultRenderObjectsRenderingStep).
Public propertyIsRenderingEnabled Gets or sets a Boolean that specifies if the objects in this rendering queue are rendered (true by default).
Public propertyItem Gets a RenderablePrimitiveBase with the specified index
Top
Methods
 NameDescription
Public methodAdd Adds renderable object to this queue
Public methodClear Removes all renderable objects from this queue
Public methodDispose Dispose
Public methodGetEnumerator Returns an enumerator that iterates through the collection.
Public methodRemove Removes renderable object from this queue
Public methodReplace Replaces oldRenderablePrimitive object with newRenderablePrimitive (the newRenderablePrimitive preserves the positions of the oldRenderablePrimitive).
Public methodResetCachedMaterialFlags Resets MaterialFlags in all renderableGeometries and then sets the ResetCachedMaterialFlagsOnNextRender to false.
Public methodToString ToString
(Overrides ObjectToString)
Top
Fields
 NameDescription
Public fieldContainsTransparentObjects Gets a Boolean that specifies if this RenderingQueue can contains transparent objects.
Public fieldName Name of this RenderingQueue.
Public fieldUseMultiThreading Gets a Boolean that specifies if this rendering queue can be rendered in multiple threads.
Top
See Also