Pico Unity XR SDK
PXR_FoveationRendering Class Reference

Static Public Member Functions

static void SetFoveationLevel (FoveationLevel level)
 Sets foveated rendering level. More...
 
static FoveationLevel GetFoveationLevel ()
 Gets the current foveated rendering level. More...
 
static void SetFoveationParameters (float foveationGainX, float foveationGainY, float foveationArea, float foveationMinimum)
 Sets foveated rendering parameters. More...
 

Member Function Documentation

◆ SetFoveationLevel()

static void SetFoveationLevel ( FoveationLevel  level)
static

Sets foveated rendering level.

Parameters
levelTarget foveated rendering level:
  • None: disable foveated rendering
  • Low: low level
  • Med: medium level
  • High: high level
  • TopHigh: top high level

◆ GetFoveationLevel()

static FoveationLevel GetFoveationLevel ( )
static

Gets the current foveated rendering level.

Returns
The current foveated rendering level:
  • None (-1): foveated rendering disabled
  • Low: low level
  • Med: medium level
  • High: high level
  • TopHigh: top high level

◆ SetFoveationParameters()

static void SetFoveationParameters ( float  foveationGainX,
float  foveationGainY,
float  foveationArea,
float  foveationMinimum 
)
static

Sets foveated rendering parameters.

Parameters
foveationGainXThe reduction rate of peripheral pixels in the X-axis direction. The valid value ranges from 1.0 to 10.0. The greater the value, the higher the reduction rate.
foveationGainYThe reduction rate of peripheral pixels in the Y-axis direction. The valid value ranges from 1.0 to 10.0. The greater the value, the higher the reduction rate.
foveationAreaThe range of foveated area whose resolution is not to be reduced. The valid value ranges from 0.0 to 4.0. The higher the value, the bigger the high-quality central area.
foveationMinimumThe minimum pixel density. Recommended values:
  • 1/32
  • 1/16
  • 1/8
  • 1/4
  • 1/2

Note: The actual pixel density will be greater than or equal to the value set here.

The documentation for this class was generated from the following file: