API reference

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 _started

Fields

OnUpdateRenderTexture : Action< Texture >

Signature

Action<Texture> OnUpdateRenderTexture

Static Fields

DEFAULT_UI_LAYERMASK : const int

Signature

const int DEFAULT_UI_LAYERMASK

Properties

OverlayCamera : Camera [Get]	Signature Camera OverlayCamera
RenderingLayers : LayerMask [Get]	Signature LayerMask RenderingLayers
RenderScale : int [Get][Set]	Signature int RenderScale
Texture : Texture [Get]	Signature Texture Texture

Protected Methods

CreateChildObject ( name )	Signature GameObject CreateChildObject(string name) Parameters `name: string` Returns `GameObject`
OnDisable ()	Signature void OnDisable() Returns `void`
OnEnable ()	Signature void OnEnable() Returns `void`
Start ()	Signature void Start() Returns `void`
UpdateCamera ()	Signature void UpdateCamera() Returns `void`
UpdateRenderTexture ()	Signature void UpdateRenderTexture() Returns `void`

Methods

CalcAutoResolution ()	Signature Vector2Int CalcAutoResolution() Returns `Vector2Int`
GetBaseResolutionToUse ()	Signature Vector2Int GetBaseResolutionToUse() Returns `Vector2Int`
GetScaledResolutionToUse ()	Signature Vector2Int GetScaledResolutionToUse() Returns `Vector2Int`
InjectAllCanvasRenderTexture ( canvas , pixelsPerUnit , renderScale , renderingLayers , generateMipMaps )	Signature void 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 InjectCanvas(Canvas canvas) Parameters `canvas: Canvas` Returns `void`
InjectGenerateMipMaps ( generateMipMaps )	Signature void InjectGenerateMipMaps(bool generateMipMaps) Parameters `generateMipMaps: bool` Returns `void`
InjectPixelsPerUnit ( pixelsPerUnit )	Signature void InjectPixelsPerUnit(int pixelsPerUnit) Parameters `pixelsPerUnit: int` Returns `void`
InjectRenderingLayers ( renderingLayers )	Signature void InjectRenderingLayers(LayerMask renderingLayers) Parameters `renderingLayers: LayerMask` Returns `void`
InjectRenderScale ( renderScale )	Signature void InjectRenderScale(int renderScale) Parameters `renderScale: int` Returns `void`
PixelsToUnits ( pixels )	Signature float PixelsToUnits(float pixels) Parameters `pixels: float` Returns `float`
UnitsToPixels ( units )	Signature float UnitsToPixels(float units) Parameters `units: float` Returns `float`

Inner Class

Properties Class

Static Fields

Canvas : readonly string	Signature readonly string Canvas
DimensionDriveMode : readonly string	Signature readonly string DimensionDriveMode
GenerateMipMaps : readonly string	Signature readonly string GenerateMipMaps
PixelsPerUnit : readonly string	Signature readonly string PixelsPerUnit
RenderLayers : readonly string	Signature readonly string RenderLayers
RenderScale : readonly string	Signature readonly string RenderScale
Resolution : readonly string	Signature readonly string Resolution