Class TextureAsTensorData

Texture based Tensor storage

Inheritance

object

TextureAsTensorData

Implements

ITensorData

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Barracuda

Assembly: Unity.Barracuda.dll

Syntax

public class TextureAsTensorData : ITensorData, IDisposable

Constructors

TextureAsTensorData(Texture, int, Flip, InterpretDepthAs, InterpretColorAs)

Create TextureAsTensorData from supplied texture

Declaration

public TextureAsTensorData(Texture texture, int interpretPixelAsChannels = -1, TextureAsTensorData.Flip flip = Flip.Y, TextureAsTensorData.InterpretDepthAs depthAs = InterpretDepthAs.Batch, TextureAsTensorData.InterpretColorAs colorAs = InterpretColorAs.AverageMultipleChannels)

Parameters

Type	Name	Description
Texture	texture	texture
int	interpretPixelAsChannels	interpret pixel as channels
TextureAsTensorData.Flip	flip	flip
TextureAsTensorData.InterpretDepthAs	depthAs	depth as
TextureAsTensorData.InterpretColorAs	colorAs	color as

TextureAsTensorData(Texture[], int, Flip, InterpretDepthAs, InterpretColorAs)

Create TextureAsTensorData from supplied textures

Declaration

public TextureAsTensorData(Texture[] textures, int interpretPixelAsChannels = -1, TextureAsTensorData.Flip flip = Flip.Y, TextureAsTensorData.InterpretDepthAs depthAs = InterpretDepthAs.Batch, TextureAsTensorData.InterpretColorAs colorAs = InterpretColorAs.AverageMultipleChannels)

Parameters

Type	Name	Description
Texture[]	textures	backing textures
int	interpretPixelAsChannels	interpret pixel as channels
TextureAsTensorData.Flip	flip	flip
TextureAsTensorData.InterpretDepthAs	depthAs	depth as
TextureAsTensorData.InterpretColorAs	colorAs	color as

Exceptions

Type	Condition
ArgumentException	thrown if textures array is empty or texture types are different
InvalidOperationException	thrown if unsupported texture type is supplied

Properties

flip

Flip flag

Declaration

public TextureAsTensorData.Flip flip { get; }

Property Value

Type	Description
TextureAsTensorData.Flip

interpretColorAs

Interpret color as

Declaration

public TextureAsTensorData.InterpretColorAs interpretColorAs { get; }

Property Value

Type	Description
TextureAsTensorData.InterpretColorAs

interpretDepthAs

Interpret depth as

Declaration

public TextureAsTensorData.InterpretDepthAs interpretDepthAs { get; }

Property Value

Type	Description
TextureAsTensorData.InterpretDepthAs

interpretPixelAsChannels

Interpret pixel as channels

Declaration

public int interpretPixelAsChannels { 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

shape

Shape

Declaration

public TensorShape shape { get; }

Property Value

Type	Description
TensorShape

textures

Backing textures

Declaration

public Texture[] textures { get; }

Property Value

Type	Description
Texture[]

Methods

Dispose()

Dispose

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

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

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)