This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Unity 1.26 Reference Guide

OVROverlay Class Reference

Add OVROverlay script to an object with an optional mesh primitive rendered as a TimeWarp overlay instead by drawing it into the eye buffer.

MonoBehaviour inherited by OVROverlay.

Public Types

enum	OverlayShape { OverlayShape.Quad = OVRPlugin.OverlayShape.Quad, OverlayShape.Cylinder = OVRPlugin.OverlayShape.Cylinder, OverlayShape.Cubemap = OVRPlugin.OverlayShape.Cubemap, OverlayShape.OffcenterCubemap = OVRPlugin.OverlayShape.OffcenterCubemap, OverlayShape.Equirect = OVRPlugin.OverlayShape.Equirect } Determines the on-screen appearance of a layer.
enum	OverlayType { OverlayType.None , OverlayType.Underlay , OverlayType.Overlay } Whether the layer appears behind or infront of other content in the scene.

Data Fields

OverlayType	currentOverlayType ( ) Specify overlay's type
bool	isDynamic ( ) If true, the texture's content is copied to the compositor each frame.
bool	isProtectedContent ( ) If true, the layer would be used to present protected content (e.g.
OverlayShape	currentOverlayShape ( ) Specify overlay's shape
Texture []	textures ( ) The left- and right-eye Textures to show in the layer.

Private Data Fields

OverlayShape	prevOverlayShape ( )
LayerTexture []	layerTextures ( )
OVRPlugin.LayerDesc	layerDesc ( )
int	stageCount ( )
int	layerIndex ( )
int	layerId ( )
GCHandle	layerIdHandle ( )
IntPtr	layerIdPtr ( )
int	frameIndex ( )
int	prevFrameIndex ( )
Renderer	rend ( )

Object Data

IntPtr []	texturePtrs ( )
bool	isOverridePending ( )

Object Data

const int

maxInstances ( )

Object Data

static OVROverlay []

instances ( )

Private Static Fields

static Material	tex2DMaterial ( )
static Material	cubeMaterial ( )

Properties

OVRPlugin.LayerLayout	layout ( ) `[Get]`
int	texturesPerStage ( ) `[Get]`

Public Member Functions

void	OverrideOverlayTextureInfo ( Texture srcTexture, IntPtr nativePtr, UnityEngine.VR.VRNode node ) Use this function to set texture and texNativePtr when app is running GetNativeTexturePtr is a slow behavior, the value should be pre-cached

Private Member Functions

bool	CreateLayer ( int mipLevels, int sampleCount, OVRPlugin.EyeTextureFormat etFormat, int flags, OVRPlugin.Sizei size, OVRPlugin.OverlayShape shape )
bool	CreateLayerTextures ( bool useMipmaps, OVRPlugin.Sizei size, bool isHdr )
void	DestroyLayerTextures ( )
void	DestroyLayer ( )
bool	LatchLayerTextures ( )
OVRPlugin.LayerDesc	GetCurrentLayerDesc ( )
bool	PopulateLayer ( int mipLevels, bool isHdr, OVRPlugin.Sizei size, int sampleCount )
bool	SubmitLayer ( bool overlay, bool headLocked, OVRPose pose, Vector3 scale )
void	Awake ( )
void	OnEnable ( )
void	OnDisable ( )
void	OnDestroy ( )
bool	ComputeSubmit ( ref OVRPose pose, ref Vector3 scale, ref bool overlay, ref bool headLocked )
void	LateUpdate ( )

Detailed Description

This will take full advantage of the display resolution and avoid double resampling of the texture.

We support 3 types of Overlay shapes right now

Quad : This is most common overlay type , you render a quad in Timewarp space.
Cylinder: [Mobile Only][Experimental], Display overlay as partial surface of a cylinder
- The cylinder's center will be your game object's center
- We encoded the cylinder's parameters in transform.scale, **[scale.z] is the radius of the cylinder **[scale.y] is the height of the cylinder **[scale.x] is the length of the arc of cylinder

Limitations **Only the half of the cylinder can be displayed, which means the arc angle has to be smaller than 180 degree, [scale.x] / [scale.z] <= PI **Your camera has to be inside of the inscribed sphere of the cylinder, the overlay will be faded out automatically when the camera is close to the inscribed sphere's surface. **Translation only works correctly with vrDriver 1.04 or above

Cubemap: Display overlay as a cube map
OffcenterCubemap: [Mobile Only] Display overlay as a cube map with a texture coordinate offset
- The actually sampling will looks like [color = texture(cubeLayerSampler, normalize(direction) + offset)] instead of [color = texture( cubeLayerSampler, direction )]
- The extra center offset can be feed from transform.position
- Note: if transform.position's magnitude is greater than 1, which will cause some cube map pixel always invisible Which is usually not what people wanted, we don't kill the ability for developer to do so here, but will warn out.
Equirect: Display overlay as a 360-degree equirectangular skybox.

Member Enumeration Documentation

enum OVROverlay.OverlayShape

Determines the on-screen appearance of a layer.

Enumerator

Quad	= OVRPlugin.OverlayShape.Quad
Cylinder	= OVRPlugin.OverlayShape.Cylinder
Cubemap	= OVRPlugin.OverlayShape.Cubemap
OffcenterCubemap	= OVRPlugin.OverlayShape.OffcenterCubemap
Equirect	= OVRPlugin.OverlayShape.Equirect

enum OVROverlay.OverlayType

Whether the layer appears behind or infront of other content in the scene.

Enumerator

None
Underlay
Overlay

Field Documentation

OverlayType OVROverlay.currentOverlayType ( )

Specify overlay's type

bool OVROverlay.isDynamic ( )

If true, the texture's content is copied to the compositor each frame.

bool OVROverlay.isProtectedContent ( )

If true, the layer would be used to present protected content (e.g.

HDCP). The flag is effective only on PC.

OverlayShape OVROverlay.currentOverlayShape ( )

Specify overlay's shape

Texture [] OVROverlay.textures ( )

The left- and right-eye Textures to show in the layer.

Note:

If you need to change the texture on a per-frame basis, please use OverrideOverlayTextureInfo(..) to avoid caching issues.

Object Data Documentation

OverlayShape OVROverlay.prevOverlayShape ( )

LayerTexture [] OVROverlay.layerTextures ( )

OVRPlugin.LayerDesc OVROverlay.layerDesc ( )

int OVROverlay.stageCount ( )

int OVROverlay.layerIndex ( )

int OVROverlay.layerId ( )

GCHandle OVROverlay.layerIdHandle ( )

IntPtr OVROverlay.layerIdPtr ( )

int OVROverlay.frameIndex ( )

int OVROverlay.prevFrameIndex ( )

Renderer OVROverlay.rend ( )

Object Data Documentation

IntPtr [] OVROverlay.texturePtrs ( )

bool OVROverlay.isOverridePending ( )

Object Data Documentation

const int OVROverlay.maxInstances ( )

Object Data Documentation

OVROverlay [] OVROverlay.instances ( )

Private Static Field Documentation

Material OVROverlay.tex2DMaterial ( )

Material OVROverlay.cubeMaterial ( )

Property Documentation

OVRPlugin.LayerLayout OVROverlay.layout ( )

int OVROverlay.texturesPerStage ( )

Member Function Documentation

void OVROverlay.OverrideOverlayTextureInfo ( Texture srcTexture, IntPtr nativePtr, UnityEngine.VR.VRNode node )

Use this function to set texture and texNativePtr when app is running GetNativeTexturePtr is a slow behavior, the value should be pre-cached

Object Data Documentation

bool OVROverlay.CreateLayer ( int mipLevels, int sampleCount, OVRPlugin.EyeTextureFormat etFormat, int flags, OVRPlugin.Sizei size, OVRPlugin.OverlayShape shape )

bool OVROverlay.CreateLayerTextures ( bool useMipmaps, OVRPlugin.Sizei size, bool isHdr )

void OVROverlay.DestroyLayerTextures ( )

void OVROverlay.DestroyLayer ( )

bool OVROverlay.LatchLayerTextures ( )

OVRPlugin.LayerDesc OVROverlay.GetCurrentLayerDesc ( )

bool OVROverlay.PopulateLayer ( int mipLevels, bool isHdr, OVRPlugin.Sizei size, int sampleCount )

bool OVROverlay.SubmitLayer ( bool overlay, bool headLocked, OVRPose pose, Vector3 scale )

void OVROverlay.Awake ( )

void OVROverlay.OnEnable ( )

void OVROverlay.OnDisable ( )

void OVROverlay.OnDestroy ( )

bool OVROverlay.ComputeSubmit ( ref OVRPose pose, ref Vector3 scale, ref bool overlay, ref bool headLocked )

void OVROverlay.LateUpdate ( )

The documentation for this class was generated from the following file: Oculus/VR/Scripts/OVROverlay.cs