RenderPriorityList

Description

sealed class Tinman.Engine.Rendering.RenderPriorityList

The RenderPriorityList class manages render priorities by setting the IRenderPriority.RenderPriority property on the IRenderPriority objects it contains.

Public / Constructors

Render​Priority​List

public constructor RenderPriorityList → ()

Creates a new instance of RenderPriorityList.

Public / Methods

Add

public method Add → (2)

thing in : IRenderPriority

[not-null]
The render priority object to add.

index opt : int32 = -1

[-1..RenderPriorityList.Count]
The target index. If -1, the target index will be set to Count.

Adds a render priority object.

When calling the Add method on a render priority object that is already present in the list will move it to the given target index opt.

Get

public method Get → (1)

index in : int32

[0..RenderPriorityList.Count-1]
The list index.

returns → IRenderPriority

The render priority object.

Returns the index in-th render priority object.

Index

public method Index → (1)

thing in : IRenderPriority

[not-null]
The render priority object.

returns → int32

Index of the given render priority object or 1 iff not contained in the list.

Returns the index of the given render priority object.

Remove

public method Remove → (1)

thing in : IRenderPriority

[not-null]
The render priority object to remove.

Removes the given render priority object.

Public / Attributes

Base​Priority

public attribute BasePriority → (get,set)

value : int32

The base priority.

The render priority of the first item in the list.

Defaults to 0.

Count

public attribute Count → (get)

value : int32

[>=0]
The number of render priority objects.

Returns the number of render priority objects.