Class LineBatch

The 3D line batch.

Inheritance

object

DisposableObject

RenderObjectInfo

LineBatch

LineBatch3D

Inherited Members

RenderObjectInfo.boundingBox

RenderObjectInfo.CullingType

RenderObjectInfo.Drawable

RenderObjectInfo.isBoundingBoxDirty

RenderObjectInfo.isSortKeyDirty

RenderObjectInfo.IsEnabled

RenderObjectInfo.Tag

RenderObjectInfo.RenderFlags

RenderObjectInfo.IsCullingEnabled

RenderObjectInfo.FlipWinding

RenderObjectInfo.IsSortKeyDirty

RenderObjectInfo.IsActive

RenderObjectInfo.SortKey

RenderObjectInfo.Transform

RenderObjectInfo.PreTransform

RenderObjectInfo.BoundingBox

RenderObjectInfo.MakeDirty()

DisposableObject.Disposed

DisposableObject.Dispose()

DisposableObject.Dispose(bool)

Namespace: Evergine.Framework.Graphics

Assembly: Evergine.Framework.dll

Syntax

public abstract class LineBatch : RenderObjectInfo

Constructors

LineBatch(GraphicsContext, RenderLayerDescription)

Initializes a new instance of the LineBatch class.

Declaration

public LineBatch(GraphicsContext graphicsContext, RenderLayerDescription renderLayerDescription)

Parameters

Type	Name	Description
GraphicsContext	graphicsContext	The graphics context.
RenderLayerDescription	renderLayerDescription	The render layer description.

Fields

LineBatchOrderBias

The line batch order bias.

Declaration

public int LineBatchOrderBias

Field Value

Type	Description
int

ResetAfterRender

Indicates whether the linebatch will reset after the lines are rendered.

Declaration

public bool ResetAfterRender

Field Value

Type	Description
bool

beginDataBtr

Beginning data pointer.

Declaration

protected VertexPositionColor* beginDataBtr

Field Value

Type	Description
VertexPositionColor*

capacity

The vertex capacity.

Declaration

protected uint capacity

Field Value

Type	Description
uint

currentDataPtr

Pointer to the current data.

Declaration

protected VertexPositionColor* currentDataPtr

Field Value

Type	Description
VertexPositionColor*

vertexCount

The number of vertices.

Declaration

protected uint vertexCount

Field Value

Type	Description
uint

Properties

InputLayoutID

Gets the Input Layout ID.

Declaration

public override uint InputLayoutID { get; }

Property Value

Type	Description
uint

Overrides

RenderObjectInfo.InputLayoutID

InputLayouts

Gets the input layout.

Declaration

public override InputLayouts InputLayouts { get; }

Property Value

Type	Description
InputLayouts

Overrides

RenderObjectInfo.InputLayouts

IsReady

Gets a value indicating whether this instance is ready to render.

Declaration

public override bool IsReady { get; }

Property Value

Type	Description
bool

Overrides

RenderObjectInfo.IsReady

Material

Gets the material.

Declaration

public override Material Material { get; }

Property Value

Type	Description
Material

Overrides

RenderObjectInfo.Material

MaterialID

Gets the material ID.

Declaration

public override uint MaterialID { get; }

Property Value

Type	Description
uint

Overrides

RenderObjectInfo.MaterialID

Mesh

Gets the LineBatch mesh.

Declaration

public Mesh Mesh { get; }

Property Value

Type	Description
Mesh

OrderBias

Gets the order bias.

Declaration

public override int OrderBias { get; }

Property Value

Type	Description
int

Overrides

RenderObjectInfo.OrderBias

PrimitiveTopology

Gets the primitive topology.

Declaration

public override PrimitiveTopology PrimitiveTopology { get; }

Property Value

Type	Description
PrimitiveTopology

Overrides

RenderObjectInfo.PrimitiveTopology

RenderLayerDescription

Gets or sets the render layer description.

Declaration

public RenderLayerDescription RenderLayerDescription { get; set; }

Property Value

Type	Description
RenderLayerDescription

RenderStateOrder

Gets the order of the render state.

Declaration

public override int RenderStateOrder { get; }

Property Value

Type	Description
int

Overrides

RenderObjectInfo.RenderStateOrder

SortMode

Gets the sorting mode.

Declaration

public override SortMode SortMode { get; }

Property Value

Type	Description
SortMode

Overrides

RenderObjectInfo.SortMode

Methods

Collect(DrawContext)

Prepares this object with the specified draw context.

Declaration

public override void Collect(DrawContext drawContext)

Parameters

Type	Name	Description
DrawContext	drawContext	The draw context.

Overrides

RenderObjectInfo.Collect(DrawContext)

Destroy()

Destroys all resources of this instance.

Declaration

protected override void Destroy()

Overrides

DisposableObject.Destroy()

DrawLine(ref Line)

Draws the line.

Declaration

public void DrawLine(ref Line line)

Parameters

Type	Name	Description
Line	line	The line.

DrawLine(Vector3, Vector3, Color)

Draws a line.

Declaration

public void DrawLine(Vector3 start, Vector3 end, Color color)

Parameters

Type	Name	Description
Vector3	start	The starting point.
Vector3	end	The ending point.
Color	color	The color.

DrawLine(ref Vector3, ref Vector3, ref Color)

Draws a line.

Declaration

public void DrawLine(ref Vector3 startPoint, ref Vector3 endPoint, ref Color color)

Parameters

Type	Name	Description
Vector3	startPoint	The starting point.
Vector3	endPoint	The ending point.
Color	color	The color.

RefreshBoundingBox()

Refreshes the bounding box.

Declaration

protected override void RefreshBoundingBox()

Overrides

RenderObjectInfo.RefreshBoundingBox()

RefreshBufferCapacity(uint)

Refreshes the buffer with the specified capacity.

Declaration

protected void RefreshBufferCapacity(uint newCapacity)

Parameters

Type	Name	Description
uint	newCapacity	The buffer capacity.

Reset()

Resets the LineBatch, allowing users to start adding lines.

Declaration

public void Reset()

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)