Documentation
¶
Overview ¶
This class is used by various XR interfaces to generate VRS textures that can be used to speed up rendering.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsXRVRS() Instance
- func (self Instance) ID() ID
- func (self Instance) MakeVrsTexture(target_size Vector2.XY, eye_foci []Vector2.XY) RID.Texture
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetVrsMinRadius(value Float.X)
- func (self Instance) SetVrsRenderRegion(value Rect2i.PositionSize)
- func (self Instance) SetVrsStrength(value Float.X)
- func (self Instance) Virtual(name string) reflect.Value
- func (self Instance) VrsMinRadius() Float.X
- func (self Instance) VrsRenderRegion() Rect2i.PositionSize
- func (self Instance) VrsStrength() Float.X
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) MakeVrsTexture ¶
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.
func (Instance) SetVrsMinRadius ¶
SetVrsMinRadius sets the property returned by [GetVrsMinRadius].
func (Instance) SetVrsRenderRegion ¶
func (self Instance) SetVrsRenderRegion(value Rect2i.PositionSize)
SetVrsRenderRegion sets the property returned by [GetVrsRenderRegion].
func (Instance) SetVrsStrength ¶
SetVrsStrength sets the property returned by [GetVrsStrength].
func (Instance) VrsMinRadius ¶
The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.
func (Instance) VrsRenderRegion ¶
func (self Instance) VrsRenderRegion() Rect2i.PositionSize
The render region that the VRS texture will be scaled to when generated.
func (Instance) VrsStrength ¶
The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is.
Source Files