Table of Contents

Class RenderResult.Frames

Namespace
Gym.Envs
Assembly
Gym.dll

The frames collected since the previous call, what the *_list render modes return (Gymnasium's RenderCollection): a Python list of frames, each itself a RenderResult case.

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

Constructors

Frames(IEnumerable<RenderResult>)

Wraps the collected frames.

public Frames(IEnumerable<RenderResult> items)

Parameters

items IEnumerable<RenderResult>

The frames, oldest first; copied, so the caller's list can be reused.

Exceptions

ArgumentNullException

Thrown when items or one of them is null.

Properties

Items

The frames, oldest first.

public IReadOnlyList<RenderResult> Items { get; }

Property Value

IReadOnlyList<RenderResult>

Methods

Dispose()

Releases every collected 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 list by its length.

public override string ToString()

Returns

string

For example Frames(3).