Class RootRenderFeature

Namespace

Stride.Rendering

Assembly

Stride.Rendering.dll

A top-level renderer that work on a specific kind of RenderObject, such as Mesh, Particle, Sprite, etc...

public abstract class RootRenderFeature : RenderFeature, IComponent, IReferencable, ICollectorHolder, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RenderFeature

RootRenderFeature

Implements

IComponent

IReferencable

ICollectorHolder

IGraphicsRendererCore

IDisposable

Derived

BackgroundRenderFeature

RootEffectRenderFeature

SpriteRenderFeature

UIRenderFeature

Inherited Members

RenderFeature.Context

RenderFeature.RenderSystem

RenderFeature.Initialized

RenderFeature.Enabled

RenderFeature.Initialize(RenderContext)

RenderFeature.Destroy()

RenderFeature.InitializeCore()

RenderFeature.Collect()

RenderFeature.Extract()

RenderFeature.PrepareEffectPermutations(RenderDrawContext)

RenderFeature.Prepare(RenderDrawContext)

RenderFeature.Draw(RenderDrawContext, RenderView, RenderViewStage)

RenderFeature.Draw(RenderDrawContext, RenderView, RenderViewStage, int, int)

RenderFeature.Flush(RenderDrawContext)

RenderFeature.OnRenderSystemChanged()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

RootRenderFeature()

protected RootRenderFeature()

Fields

RenderData

public RenderDataHolder RenderData

Field Value

RenderDataHolder

RenderObjects

List of RenderObject initialized with this root render feature.

public List<RenderObject> RenderObjects

Field Value

List<RenderObject>

Properties

Index

public int Index { get; }

Property Value

int

ObjectNodeReferences

Object nodes to process this frame.

public ConcurrentCollector<ObjectNodeReference> ObjectNodeReferences { get; }

Property Value

ConcurrentCollector<ObjectNodeReference>

RenderNodes

List of render nodes for this specific root render feature.

public ConcurrentCollector<RenderNode> RenderNodes { get; }

Property Value

ConcurrentCollector<RenderNode>

RenderStageSelectors

Overrides that allow defining which render stages are enabled for a specific RenderObject.

[DataMember]
public FastTrackingCollection<RenderStageSelector> RenderStageSelectors { get; }

Property Value

FastTrackingCollection<RenderStageSelector>

SortKey

Sort key used during rendering.

public byte SortKey { get; protected set; }

Property Value

byte

SupportedRenderObjectType

Gets the type of render object supported by this RootRenderFeature.

public abstract Type SupportedRenderObjectType { get; }

Property Value

Type

Methods

BindPerViewShaderResource(string, RenderView, GraphicsResource)

Allows the renderer to inject per view resources such as depth buffer and opaque pass output.

public virtual void BindPerViewShaderResource(string logicalGroupName, RenderView renderView, GraphicsResource resource)

Parameters

logicalGroupName string

Name of the logical group to bind to.

renderView RenderView

resource GraphicsResource

ComputeDataArrayExpectedSize(DataType)

protected virtual int ComputeDataArrayExpectedSize(DataType type)

Parameters

type DataType

Returns

int

CreateViewObjectNode(RenderView, RenderObject)

Creates a view object node during Extract phase.

public ViewObjectNodeReference CreateViewObjectNode(RenderView view, RenderObject renderObject)

Parameters

view RenderView

renderObject RenderObject

Returns

ViewObjectNodeReference

The view object node reference.

GetObjectNode(ObjectNodeReference)

Gets the object node from its reference.

public ObjectNode GetObjectNode(ObjectNodeReference reference)

Parameters

reference ObjectNodeReference

Returns

ObjectNode

The object node.

GetRenderNode(RenderNodeReference)

Gets the render node from its reference.

public RenderNode GetRenderNode(RenderNodeReference reference)

Parameters

reference RenderNodeReference

Returns

RenderNode

The render node.

GetViewObjectNode(ViewObjectNodeReference)

Gets the view object node from its reference.

public ViewObjectNode GetViewObjectNode(ViewObjectNodeReference reference)

Parameters

reference ViewObjectNodeReference

Returns

ViewObjectNode

The view object node.

OnAddRenderObject(RenderObject)

Called when a render object is added.

protected virtual void OnAddRenderObject(RenderObject renderObject)

Parameters

renderObject RenderObject

OnRemoveRenderObject(RenderObject)

Called when a render object is removed.

protected virtual void OnRemoveRenderObject(RenderObject renderObject)

Parameters

renderObject RenderObject

The render object.

PrepareDataArrays()

public void PrepareDataArrays()

Reset()

public virtual void Reset()

Unload()

public override void Unload()