Table of Contents

Class XRVRS

Helper class for XR interfaces that generates VRS images.

Inheritance
XRVRS

Remarks

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

Properties

vrs_min_radius

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

var vrs_min_radius : float = 20.0

Property Value

float

Remarks

  • void set_vrs_min_radius(float value)
  • float get_vrs_min_radius

vrs_render_region

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

var vrs_render_region : Rect2i = Rect2i(0, 0, 0, 0)

Property Value

Rect2i

Remarks

  • void set_vrs_render_region(Rect2i value)
  • Rect2i get_vrs_render_region

vrs_strength

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

var vrs_strength : float = 1.0

Property Value

float

Remarks

  • void set_vrs_strength(float value)
  • float get_vrs_strength

Methods

make_vrs_texture(Vector2, PackedVector2Array)

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.

RID make_vrs_texture(Vector2 target_size, PackedVector2Array eye_foci)

Parameters

target_size Vector2
eye_foci PackedVector2Array