 | |
Rendering | |
RenderingItem defines properties that are required for one draw call.
One or more RenderingItem objects are created in CollectRenderingItems(RenderingContext) method that is called for each SceneNode in the scene.
The created RenderingItems are added to the RenderingLayers.
Inheritance HierarchyNamespace: Ab4d.SharpEngine.Core
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 1.0.8740+deb2991acfe86a95cca780cd4f82bcae2805c1a5
SyntaxC#
public class RenderingItem
The RenderingItem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RenderingItem | Constructor |
Properties| Name | Description | |
|---|---|---|
 | IsBackFaceMaterial | IsBackFaceMaterial specifies if the material is used to render front (IsBackFaceMaterial == false) or back (IsBackFaceMaterial == true) faces. This property gets or set the flag from the Flags field. |
| IsVisible | When IsVisible property is false this prevents rendering this RenderingItem. This property gets or set the flag from the Flags field. Note that Flags have IsHidden flag so this property inverts the presence of IsHidden flag. The reason for this is that this way the majority of objects can have have no Flags set (they are not processes in any special way). |
Methods| Name | Description | |
|---|---|---|
 | CreateFromPool | Create method get the RenderingItem from the ObjectPool in Scene and returns the created object. The method also initialize all the fields to default values and sets the ParentSceneNode, WorldBoundingBox and Flags (IsHidden flag is set if ). |
| ReturnObject | ReturnObject returns object to the object pool in Scene. |
| ToString | (Overrides ObjectToString) |
Fields| Name | Description | |
|---|---|---|
 | AdditionalVertexBuffers | When AdditionalVertexBuffers is not null, then the array items that are not null are bind to vertex buffer starting with binding 1. This array does not include the VertexBuffer so that the primary vertex buffer address is included into the same memory block that defines this RenderingItem (the item in the array are defined elsewhere in memory). |
| CustomRenderAction | When CustomRenderAction is set, then this action is called when rendering instead of calling vkCmdDrawIndexed. |
| EffectTechnique | EffectTechnique |
| FirstIndex | FirstIndex |
| FirstInstance | FirstInstance |
| Flags | Flags |
| IndexBuffer | IndexBuffer |
| IndexBufferType | IndexBufferType |
| IndexCount | Number of triangle indices (or vertexes when there is no IndexBuffer) |
| InstanceCount | InstanceCount (should be at least 1) |
| MaterialDescriptorSets | MaterialDescriptorSets |
| MaterialIndex | MaterialIndex (when bigger or equal to 0, then PushConstant is set to FragmentShader) |
| MatricesDescriptorSets | MatricesDescriptorSets |
| MatrixIndex | MatrixIndex |
| ParentSceneNode | ParentSceneNode |
| PrimitiveTopology | PrimitiveTopology |
| StateSortValue | The state sort value represent an unsigned Int32 number that is a short hash value calculated from the properties of this RenderingItem (usually the value is defined from Effect's Id and effect's technique index) and can be used to sort and group similar RenderingItem. This optimizes optimize Pipeline changes and can improve performance. |
| Tag | Tag |
| VertexBuffer | VertexBuffer |
| VertexBufferDescription | VertexBufferDescription |
| VertexCount | Number of vertices in the VertexBuffer |
| VertexOffset | VertexOffset |
| WorldBoundingBox | WorldBoundingBox |
See Also