DataCollectionItemPlacerGOBase.PurgeRemovableGameObjectRange Method

Definition

Namespace:: MixedReality.Toolkit.Data

Assembly:: MixedReality.Toolkit.Data.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Purge a range of game objects that have been queued for removal.

public void PurgeRemovableGameObjectRange(int firstItemIdx, int itemCount);

member this.PurgeRemovableGameObjectRange : int * int -> unit

Public Sub PurgeRemovableGameObjectRange (firstItemIdx As Integer, itemCount As Integer)

Parameters

firstItemIdx: Int32

Index into collection of first item to purge.

itemCount: Int32

Number of items to purge.

Remarks

Normally items are removed as soon as they have been scrolled out of visibility, but to allow for transition effects, that default behavior for all scroll related methods can be delayed and the items can be manually purged with this method.

NOTE: if objects are not purged, they will indefinitely be referenced by this item placer, creating an effective memory leak.

This is useful for purging a series of previously visible items, such as after a transition effect, such as fade out, is done.

Applies to