Class RenderObjectInfo
This class represents the information of an object to be rendered.
Inheritance
Inherited Members
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public abstract class RenderObjectInfo : BaseROIConstructors
RenderObjectInfo()
Initializes a new instance of the RenderObjectInfo class.
Declaration
public RenderObjectInfo()Fields
CullingType
A value indicating how the culling system should manage this object.
Declaration
public RenderObjectInfo.CullingTypes CullingTypeField Value
| Type | Description |
|---|---|
| RenderObjectInfo.CullingTypes |
Drawable
The drawable part of the render object information.
Declaration
public Drawable DrawableField Value
| Type | Description |
|---|---|
| Drawable |
IsCullingEnabled
Indicates whether this render object can be culled.
Declaration
public bool IsCullingEnabledField Value
| Type | Description |
|---|---|
| bool |
IsEnabled
Indicates whether this render object is active.
Declaration
public bool IsEnabledField Value
| Type | Description |
|---|---|
| bool |
RenderFlags
The object's render flags.
Declaration
public RenderFlags RenderFlagsField Value
| Type | Description |
|---|---|
| RenderFlags |
Tag
A tag for this object.
Declaration
public string TagField Value
| Type | Description |
|---|---|
| string |
boundingBox
Represents the bounding box.
Declaration
protected BoundingBox? boundingBoxField Value
| Type | Description |
|---|---|
| BoundingBox? |
isBoundingBoxDirty
Indicates whether the bounding box is dirty.
Declaration
protected bool isBoundingBoxDirtyField Value
| Type | Description |
|---|---|
| bool |
isSortKeyDirty
The sort key is invalid.
Declaration
protected bool isSortKeyDirtyField Value
| Type | Description |
|---|---|
| bool |
Properties
BoundingBox
Gets the bounding box.
Declaration
public BoundingBox? BoundingBox { get; }Property Value
| Type | Description |
|---|---|
| BoundingBox? |
FlipWinding
Gets or sets a value indicating whether the winding needs to be flipped.
Declaration
public bool FlipWinding { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
InputLayoutID
Gets the Input Layout ID.
Declaration
public abstract uint InputLayoutID { get; }Property Value
| Type | Description |
|---|---|
| uint |
InputLayouts
Gets the input layout.
Declaration
public abstract InputLayouts InputLayouts { get; }Property Value
| Type | Description |
|---|---|
| InputLayouts |
IsActive
Gets a value indicating whether this object is active.
Declaration
public virtual bool IsActive { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsReady
Gets a value indicating whether this instance is ready to render.
Declaration
public abstract bool IsReady { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsSortKeyDirty
Gets a value indicating whether the sort key is dirty.
Declaration
public bool IsSortKeyDirty { get; }Property Value
| Type | Description |
|---|---|
| bool |
Material
Gets the material.
Declaration
public abstract Material Material { get; }Property Value
| Type | Description |
|---|---|
| Material |
MaterialID
Gets the material ID.
Declaration
public abstract uint MaterialID { get; }Property Value
| Type | Description |
|---|---|
| uint |
OrderBias
Gets the order bias.
Declaration
public abstract int OrderBias { get; }Property Value
| Type | Description |
|---|---|
| int |
PreTransform
Gets or sets the pre-object transform.
Declaration
public Matrix4x4 PreTransform { get; set; }Property Value
| Type | Description |
|---|---|
| Matrix4x4 |
PrimitiveTopology
Gets the primitive topology.
Declaration
public abstract PrimitiveTopology PrimitiveTopology { get; }Property Value
| Type | Description |
|---|---|
| PrimitiveTopology |
RenderStateOrder
Gets the order of the render state.
Declaration
public abstract int RenderStateOrder { get; }Property Value
| Type | Description |
|---|---|
| int |
SortKey
Gets or sets the sort key.
Declaration
public ulong SortKey { get; set; }Property Value
| Type | Description |
|---|---|
| ulong |
SortMode
Gets the sorting mode.
Declaration
public abstract SortMode SortMode { get; }Property Value
| Type | Description |
|---|---|
| SortMode |
Transform
Gets or sets the object's transform.
Declaration
public Matrix4x4 Transform { get; set; }Property Value
| Type | Description |
|---|---|
| Matrix4x4 |
Methods
Collect(DrawContext)
Prepares this object with the specified draw context.
Declaration
public abstract void Collect(DrawContext drawContext)Parameters
| Type | Name | Description |
|---|---|---|
| DrawContext | drawContext | The draw context. |
MakeDirty()
Indicates that this object info is dirty.
Declaration
public virtual void MakeDirty()RefreshBoundingBox()
Refreshes the bounding box.
Declaration
protected abstract void RefreshBoundingBox()SetTransform(ref Matrix4x4, float)
Sets the transform of the render object.
Declaration
public void SetTransform(ref Matrix4x4 transform, float maxRelativeError = 5.9604645E-06)Parameters
| Type | Name | Description |
|---|---|---|
| Matrix4x4 | transform | The new transform matrix. |
| float | maxRelativeError | The maximum relative error allowed for the comparison. |