Xrvrs — C# API · Reckfell

Xrvrs

Helper class for XR interfaces that generates VRS images.

1.0.0

class XrvrsReckfellSharpInherits ReckfellObject

Helper class for XR interfaces that generates VRS images.

This class is used by various XR interfaces to generate VRS textures that can be used to speed up rendering.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

XrvrsConstructor

# Xrvrs

C#
public Xrvrs();

Properties3

VrsMinRadiusProperty

# VrsMinRadius

C#
public float VrsMinRadius { get; set; }

The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.

VrsRenderRegionProperty

# VrsRenderRegion

C#
public Rect2I VrsRenderRegion { get; set; }

The render region that the VRS texture will be scaled to when generated.

VrsStrengthProperty

# VrsStrength

C#
public float VrsStrength { get; set; }

The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is.

Methods8

GetVrsMinRadiusfloat

# GetVrsMinRadius

C#
public float GetVrsMinRadius();

Returns float

GetVrsRenderRegionRect2I

# GetVrsRenderRegion

C#
public Rect2I GetVrsRenderRegion();

Returns Rect2I

GetVrsStrengthfloat

# GetVrsStrength

C#
public float GetVrsStrength();

Returns float

MakeVrsTexture2 overloads

# MakeVrsTexture · 1/2

C#
public Rid MakeVrsTexture(Vector2 targetSize, Vector2[] eyeFoci);

Generates the VRS texture based on a render target_size adjusted by our VRS tile size. For each eyes focal point passed in eye_foci a layer is created. Focal point should be in NDC. The result will be cached, requesting a VRS texture with unchanged parameters and settings will return the cached RID.

Parameters
Name	Type	Default
`targetSize`	`Vector2`	—
`eyeFoci`	`Vector2[]`	—

Returns Rid

# MakeVrsTexture · 2/2

C#
public Rid MakeVrsTexture(Vector2 targetSize, ReadOnlySpan<Vector2> eyeFoci);

Parameters
Name	Type	Default
`targetSize`	`Vector2`	—
`eyeFoci`	`ReadOnlySpan<Vector2>`	—

Returns Rid

SetVrsMinRadiusvoid

# SetVrsMinRadius

C#
public void SetVrsMinRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—

SetVrsRenderRegionvoid

# SetVrsRenderRegion

C#
public void SetVrsRenderRegion(Rect2I renderRegion);

Parameters
Name	Type	Default
`renderRegion`	`Rect2I`	—

SetVrsStrengthvoid

# SetVrsStrength

C#
public void SetVrsStrength(float strength);

Parameters
Name	Type	Default
`strength`	`float`	—

Reckfell Engine documentationBack to top ↑