API reference
API reference
Select your platform
No SDKs available
No versions available

CanvasRenderTexture Class

Extends MonoBehaviour
A component that, given a Canvas, renders the canvas to a RenderTexture.
Used in Interaction SDK's curved canvas. Each render mode has a unique use case.

Protected Fields

_started : bool
Signature 
bool Oculus.Interaction.UnityCanvas.CanvasRenderTexture._started

Fields

OnUpdateRenderTexture : Action< Texture >
Signature 
Action<Texture> Oculus.Interaction.UnityCanvas.CanvasRenderTexture.OnUpdateRenderTexture

Static Fields

DEFAULT_UI_LAYERMASK : const int
Signature 
const int Oculus.Interaction.UnityCanvas.CanvasRenderTexture.DEFAULT_UI_LAYERMASK

Properties

OverlayCamera : Camera
[Get]
Signature 
Camera Oculus.Interaction.UnityCanvas.CanvasRenderTexture.OverlayCamera
RenderingLayers : LayerMask
[Get]
Signature 
LayerMask Oculus.Interaction.UnityCanvas.CanvasRenderTexture.RenderingLayers
RenderScale : int
[Get][Set]
Signature 
int Oculus.Interaction.UnityCanvas.CanvasRenderTexture.RenderScale
Texture : Texture
[Get]
Signature 
Texture Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Texture

Protected Methods

CreateChildObject ( name )
Signature 
GameObject Oculus.Interaction.UnityCanvas.CanvasRenderTexture.CreateChildObject(string name)
Parameters
name: string
Returns
GameObject
OnDisable ()
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.OnDisable()
Returns
void
OnEnable ()
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.OnEnable()
Returns
void
Start ()
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Start()
Returns
void
UpdateCamera ()
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.UpdateCamera()
Returns
void
UpdateRenderTexture ()
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.UpdateRenderTexture()
Returns
void

Methods

CalcAutoResolution ()
Signature 
Vector2Int Oculus.Interaction.UnityCanvas.CanvasRenderTexture.CalcAutoResolution()
Returns
Vector2Int
GetBaseResolutionToUse ()
Signature 
Vector2Int Oculus.Interaction.UnityCanvas.CanvasRenderTexture.GetBaseResolutionToUse()
Returns
Vector2Int
GetScaledResolutionToUse ()
Signature 
Vector2Int Oculus.Interaction.UnityCanvas.CanvasRenderTexture.GetScaledResolutionToUse()
Returns
Vector2Int
InjectAllCanvasRenderTexture ( canvas , pixelsPerUnit , renderScale , renderingLayers , generateMipMaps )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectAllCanvasRenderTexture(Canvas canvas, int pixelsPerUnit, int renderScale, LayerMask renderingLayers, bool generateMipMaps)
Parameters
canvas: Canvas
pixelsPerUnit: int
renderScale: int
renderingLayers: LayerMask
generateMipMaps: bool
Returns
void
InjectCanvas ( canvas )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectCanvas(Canvas canvas)
Parameters
canvas: Canvas
Returns
void
InjectGenerateMipMaps ( generateMipMaps )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectGenerateMipMaps(bool generateMipMaps)
Parameters
generateMipMaps: bool
Returns
void
InjectPixelsPerUnit ( pixelsPerUnit )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectPixelsPerUnit(int pixelsPerUnit)
Parameters
pixelsPerUnit: int
Returns
void
InjectRenderingLayers ( renderingLayers )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectRenderingLayers(LayerMask renderingLayers)
Parameters
renderingLayers: LayerMask
Returns
void
InjectRenderScale ( renderScale )
Signature 
void Oculus.Interaction.UnityCanvas.CanvasRenderTexture.InjectRenderScale(int renderScale)
Parameters
renderScale: int
Returns
void
PixelsToUnits ( pixels )
Signature 
float Oculus.Interaction.UnityCanvas.CanvasRenderTexture.PixelsToUnits(float pixels)
Parameters
pixels: float
Returns
float
UnitsToPixels ( units )
Signature 
float Oculus.Interaction.UnityCanvas.CanvasRenderTexture.UnitsToPixels(float units)
Parameters
units: float
Returns
float

Inner Class

Properties Class

Static Fields

Canvas : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.Canvas
DimensionDriveMode : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.DimensionDriveMode
GenerateMipMaps : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.GenerateMipMaps
PixelsPerUnit : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.PixelsPerUnit
RenderLayers : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.RenderLayers
RenderScale : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.RenderScale
Resolution : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.CanvasRenderTexture.Properties.Resolution

Inner Enum

DriveMode Enum

Enumeration Constants

Member
Auto
Manual
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta