Table of Contents

Class RenderResult.Depth

Namespace
Gym.Envs
Assembly
Gym.dll

A depth_array frame: a (height, width) float array of depths (MuJoCo).

public sealed class RenderResult.Depth : RenderResult, IEquatable<RenderResult>, IDisposable
Inheritance
RenderResult.Depth
Implements
Inherited Members
Extension Methods

Constructors

Depth(NDArray)

Wraps a depth frame.

public Depth(NDArray frame)

Parameters

frame NDArray

The frame; the caller of render() owns it.

Exceptions

ArgumentNullException

Thrown when frame is null.

Properties

Frame

The depth frame.

public NDArray Frame { get; }

Property Value

NDArray

Methods

Dispose()

Releases the frame.

public override void Dispose()

Equals(RenderResult?)

Structural equality (see the class remarks).

public override bool Equals(RenderResult? other)

Parameters

other RenderResult

The other result; may be null.

Returns

bool

true when both are the same case with equal contents.

GetHashCode()

A hash consistent with Equals(RenderResult?): the case and the shapes, never the pixels.

public override int GetHashCode()

Returns

int

The hash.

ToString()

Describes the frame by shape and dtype.

public override string ToString()

Returns

string

For example Depth((480, 480), float32).