docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SharedArrayTensorData

    Internal Tensor data backed by managed array that is shared between multiple tensors

    Inheritance
    object
    SharedArrayTensorData
    UnsafeArrayTensorData
    Implements
    ITensorData
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Barracuda
    Assembly: Unity.Barracuda.dll
    Syntax
    public class SharedArrayTensorData : ITensorData, IDisposable

    Constructors

    SharedArrayTensorData(float[], int, int)

    Create SharedArrayTensorData with supplied shared data

    Declaration
    public SharedArrayTensorData(float[] data, int offset = 0, int count = -1)
    Parameters
    Type Name Description
    float[] data

    shared array

    int offset

    offset in shared array

    int count

    element count

    Properties

    array

    Data storage array

    Declaration
    public float[] array { get; }
    Property Value
    Type Description
    float[]

    count

    Data element count

    Declaration
    public int count { get; }
    Property Value
    Type Description
    int

    maxCapacity

    Returns the maximum number of element this tensorData can contain.

    Declaration
    public virtual int maxCapacity { get; }
    Property Value
    Type Description
    int

    offset

    Offset in storage array

    Declaration
    public int offset { get; }
    Property Value
    Type Description
    int

    Methods

    Dispose()

    Dispose storage

    Declaration
    public virtual void Dispose()

    Download(TensorShape)

    Returns an array filled with the values of a tensor. Depending on the implementation and underlying device this array might be a copy or direct reference to the tensor values. This is a blocking call, unless data from device was requested via ScheduleAsyncDownload beforehand and has already arrived.

    Declaration
    public virtual float[] Download(TensorShape shape)
    Parameters
    Type Name Description
    TensorShape shape

    the TensorShape (and thus length) of the data to copy

    Returns
    Type Description
    float[]

    Tensor data as float arrary

    ~SharedArrayTensorData()

    Finalize

    Declaration
    protected ~SharedArrayTensorData()

    Reserve(int)

    Reserve uninitialized memory.

    Declaration
    public virtual void Reserve(int count)
    Parameters
    Type Name Description
    int count

    element count to reserve

    ScheduleAsyncDownload(int)

    Schedule an asynchronous download from device memory. count is the number of element to readback.

    Declaration
    public virtual bool ScheduleAsyncDownload(int count)
    Parameters
    Type Name Description
    int count

    count of elements to download

    Returns
    Type Description
    bool

    false until data from device arrives to CPU and is ready for access

    SharedAccess(out int)

    Returns an array filled with the values of multiple tensors that share the same tensorData on device. Depending on the implementation and underlying device this array might be a copy or direct reference to tensor values, no conversion from on device memory layout will occur. This is a blocking call, unless data from device was requested via ScheduleAsyncDownload beforehand and has already arrived.

    Declaration
    public virtual float[] SharedAccess(out int offset)
    Parameters
    Type Name Description
    int offset

    This function outputs offset from the beginning of the array to location of values for specific tensor. offset parameters is specified in float elements

    Returns
    Type Description
    float[]

    array filled with the values of multiple tensors that share the same tensorData on device

    ToString()

    Storage summary as string

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    storage summary as string

    Overrides
    object.ToString()

    Upload(float[], TensorShape, int)

    Initialize with data. shape is the TensorShape (and thus length) of the data to copy. managedBufferStartIndex is the offset where to start the copy in the data

    Declaration
    public virtual void Upload(float[] data, TensorShape shape, int managedBufferStartIndex = 0)
    Parameters
    Type Name Description
    float[] data

    data as float array

    TensorShape shape

    Tensor shape

    int managedBufferStartIndex

    managed buffer start index

    Implements

    ITensorData
    IDisposable

    Extension Methods

    DeprecatedTensorDataExtensions.GetMaxCount(ITensorData)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)