PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
I want to find out more Accept
Collapse Sidebar
  1. API REFERENCE
  2. RenderingTest

RenderingTest

Show deprecated
Hide content
CONTENT
  1. API REFERENCE
  2. RenderingTest

RenderingTest

Show deprecated

RenderingTest is an internal testing utility used by Roblox engineers to do performance/regression tests on the rendering pipeline. It is expected to be parented inside of the TestService, and will run LocalScripts parented inside of it when the TestService is ran via TestService/Run.

Selected RenderingTest

One of its more notable features is that, upon being selected in the Explorer, it draws an accurate wireframe of the Camera frustum, visualizing what a Camera would see in the RenderingTest’s configuration.

Recording Test Results

When a RenderingTest is executed by the TestService, the Workspace/CurrentCamera|CurrentCamera of the Workspace has its properties updated so it mirrors the Camera configuration of the RenderingTest.

The recorded data is then sent as JSON with an HTTP-POST request to: localhost:8001/api/v1/submit_test.

For the RenderingTest to pass in Roblox Studio, the request expects the response to be the string "passed". It will also acknowledge the strings "failed" or "golden" as a string response.

Properties

CFrame

CFrame

The CFrame that the Camera will use when this RenderingTest is executed.
int

ComparisonDiffThreshold

The maximum difference that this RenderingTest can have between the image it captures and the original image.
RenderingTestComparisonMethod

ComparisonMethod

The comparison method that is expected to be used when this RenderingTest’s image capture is compared to its original image.
float

ComparisonPsnrThreshold

The maximum peak signal-to-noise ratio that this RenderingTest can have between the image it captures and the original image.
string

Description

A description to describe this RenderingTest.
float

FieldOfView

The FieldOfView that will be used by the Camera when running this RenderingTest.
Vector3

Orientation

[NotReplicated]

The derived orientation of the RenderingTest’s CFrame.
Vector3

Position

[NotReplicated]

The derived position of the RenderingTest’s CFrame.
int

QualityLevel

The graphics quality that will be used by the rendering pipeline when running this RenderingTest.
bool

ShouldSkip

Indicates whether or not this RenderingTest should be skipped.
string

Ticket

A label of the internal JIRA ticket this RenderingTest is associated with.

Functions

void

RenderdocTriggerCapture ( )

Events

LogService ScriptDebugger