OpenXRCompositionLayer

Documentation

Overview

Package OpenXRCompositionLayer provides methods for working with OpenXRCompositionLayer object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AlphaBlend() bool
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsOpenXRCompositionLayer() Instance
  • func (self Instance) EnableHolePunch() bool
  • func (self Instance) IntersectsRay(origin Vector3.XYZ, direction Vector3.XYZ) Vector2.XY
  • func (self Instance) IsNativelySupported() bool
  • func (self Instance) LayerViewport() [1]gdclass.SubViewport
  • func (self Instance) SetAlphaBlend(value bool)
  • func (self Instance) SetEnableHolePunch(value bool)
  • func (self Instance) SetLayerViewport(value [1]gdclass.SubViewport)
  • func (self Instance) SetSortOrder(value int)
  • func (self Instance) SortOrder() int
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsOpenXRCompositionLayer() Instance
}

type Instance

type Instance [1]gdclass.OpenXRCompositionLayer

Composition layers allow 2D viewports to be displayed inside of the headset by the XR compositor through special projections that retain their quality. This allows for rendering clear text while keeping the layer at a native resolution. [b]Note:[/b] If the OpenXR runtime doesn't support the given composition layer type, a fallback mesh can be generated with a [ViewportTexture], in order to emulate the composition layer.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AlphaBlend

func (self Instance) AlphaBlend() bool

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsOpenXRCompositionLayer

func (self Instance) AsOpenXRCompositionLayer() Instance

func (Instance) EnableHolePunch

func (self Instance) EnableHolePunch() bool

func (Instance) IntersectsRay

func (self Instance) IntersectsRay(origin Vector3.XYZ, direction Vector3.XYZ) Vector2.XY

Returns UV coordinates where the given ray intersects with the composition layer. [param origin] and [param direction] must be in global space. Returns [code]Vector2(-1.0, -1.0)[/code] if the ray doesn't intersect.

func (Instance) IsNativelySupported

func (self Instance) IsNativelySupported() bool

Returns true if the OpenXR runtime natively supports this composition layer type. [b]Note:[/b] This will only return an accurate result after the OpenXR session has started.

func (Instance) LayerViewport

func (self Instance) LayerViewport() [1]gdclass.SubViewport

func (Instance) SetAlphaBlend

func (self Instance) SetAlphaBlend(value bool)

func (Instance) SetEnableHolePunch

func (self Instance) SetEnableHolePunch(value bool)

func (Instance) SetLayerViewport

func (self Instance) SetLayerViewport(value [1]gdclass.SubViewport)

func (Instance) SetSortOrder

func (self Instance) SetSortOrder(value int)

func (Instance) SortOrder

func (self Instance) SortOrder() int

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value