Table of Contents

Class CameraFrame

Namespace
RustPlusApi.Data.Cameras
Assembly
RustPlusApi.dll

A single camera frame streamed from the server (mapped from the AppCameraRays broadcast). Carries the run-length-encoded depth/entity RayData plus the entities in view; turning it into an image is the job of the separate RustPlusApi.Camera rendering package.

public record CameraFrame : IEquatable<CameraFrame>
Inheritance
CameraFrame
Implements
Derived
Inherited Members

Properties

CameraPosition

World-space position of the camera, if reported.

public Vector3? CameraPosition { get; init; }

Property Value

Vector3

CameraRotation

World-space rotation of the camera, if reported.

public Vector3? CameraRotation { get; init; }

Property Value

Vector3

Distance

Maximum ray cast distance used when encoding this frame.

public float Distance { get; init; }

Property Value

float

Entities

Entities visible in this frame.

public IEnumerable<CameraEntity> Entities { get; init; }

Property Value

IEnumerable<CameraEntity>

RayData

Run-length-encoded ray data for the frame.

public byte[] RayData { get; init; }

Property Value

byte[]

SampleOffset

Index into the shuffled sample-position buffer where this frame's rays begin.

public int SampleOffset { get; init; }

Property Value

int

TimeOfDay

In-game time of day when the frame was captured, if reported.

public float? TimeOfDay { get; init; }

Property Value

float?

VerticalFov

Vertical field-of-view of the camera, in degrees.

public float VerticalFov { get; init; }

Property Value

float