nuitrack.Frame< T > Class Template Reference

Represents a generalized frame. More...

Inherits nuitrack.NativeResources.PooledUnmanagedResource, and ICloneable.

Inherited by nuitrack.ColorFrame, nuitrack.DepthFrame, and nuitrack.UserFrame.

Public Member Functions
override void	Initialize ()
	Initialize the frame data with UnmanagedResource Handle.
T	GetAt (int row, int col)
	Get the number of rows and columns. More...
T	GetAt (int i)
	Get the value of i-th element. More...
abstract object	Clone ()
	Get a clone of the frame (a reference to the frame data is added for native resource). More...
Public Member Functions inherited from nuitrack.NativeResources.UnmanagedResource
void	Dispose ()

Protected Member Functions
	Frame (IntPtr ptr, nuitrack.NativeResources.Deleter deleter)
abstract T	GetValue (int i)
abstract T	GetValue (int row, int col)
Protected Member Functions inherited from nuitrack.NativeResources.PooledUnmanagedResource
	PooledUnmanagedResource (IntPtr ptr, Deleter deleter)
override void	Dispose (bool disposing)
Protected Member Functions inherited from nuitrack.NativeResources.UnmanagedResource
	UnmanagedResource (IntPtr ptr, Deleter deleter)

Protected Attributes
int	rows
int	cols
ulong	id
ulong	timestamp
IntPtr	data

Properties
int	Rows [get, set]
	Get the number of rows in a frame. More...
int	Cols [get, set]
	Get the number of columns in a frame. More...
ulong	ID [get]
	Get the frame ID. More...
ulong	Timestamp [get, set]
	Get the frame timestamp. More...
T	this[int row, int col] [get]
	Get the value of nuitrack.Frame element with the specified row and column. More...
T	this[int i] [get]
	Get the value of nuitrack.Frame i-th element. More...
IntPtr	Data [get, set]
	Get a pointer to the frame data. More...
int	DataSize [get]
	Get the size of the frame data. More...
Properties inherited from nuitrack.NativeResources.UnmanagedResource
IntPtr	Handle [get]

Detailed Description

Represents a generalized frame.

Type Constraints

T

:

struct

Member Function Documentation

abstract object nuitrack.Frame< T >.Clone ( )

pure virtual

Get a clone of the frame (a reference to the frame data is added for native resource).

Returns

A clone of the frame.

Implemented in nuitrack.UserFrame, nuitrack.ColorFrame, and nuitrack.DepthFrame.

T nuitrack.Frame< T >.GetAt ( int  row, int  col  )

inline

Get the number of rows and columns.

Returns

The number of rows and columns.

Parameters

[in]	row	Number of rows.
[in]	col	Number of columns.

T nuitrack.Frame< T >.GetAt ( int  i )

inline

Get the value of i-th element.

Returns

The value of i-th element.

Parameters

[in]

i

The number of element.

abstract T nuitrack.Frame< T >.GetValue ( int  i )

protectedpure virtual

Warning

For internal use only.

Implemented in nuitrack.UserFrame, nuitrack.ColorFrame, and nuitrack.DepthFrame.

Member Data Documentation

int nuitrack.Frame< T >.rows

protected

Warning

For internal use only.

Property Documentation

int nuitrack.Frame< T >.Cols

getset

Get the number of columns in a frame.

Returns

The number of columns in a frame.

IntPtr nuitrack.Frame< T >.Data

getset

Get a pointer to the frame data.

Returns

A pointer to the first byte of the frame data.

int nuitrack.Frame< T >.DataSize

get

Get the size of the frame data.

Returns

The size (in bytes) of the frame data.

ulong nuitrack.Frame< T >.ID

get

Get the frame ID.

Returns

The frame ID.

int nuitrack.Frame< T >.Rows

getset

Get the number of rows in a frame.

Returns

The number of rows in a frame.

T nuitrack.Frame< T >.this[int i]

get

Get the value of nuitrack.Frame i-th element.

Parameters

[in]

i

The number of element.

T nuitrack.Frame< T >.this[int row, int col]

get

Get the value of nuitrack.Frame element with the specified row and column.

Parameters

[in]	row	Rows.
[in]	col	Columns.

ulong nuitrack.Frame< T >.Timestamp

getset

Get the frame timestamp.

Returns

The frame timestamp.