Class XRPass
XRPass holds the render target information and a list of XRView.
XRView contains the parameters required to render (projection and view matrices, viewport, etc)
When a pass has 2 views or more, single-pass will be active if the platform supports it.
To avoid allocating every frame, XRView is a struct and XRPass is pooled.
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
Constructors
XRPass()
Parameterless constructor.
Note: in order to avoid GC, the render pipeline should use XRPass.Create instead of this method.
Declaration
Properties
copyDepth
If true, the render pipeline is expected to output a valid depth buffer to the renderTarget.
Declaration
public bool copyDepth { get; }
Property Value
cullingParams
Parameters used for culling.
Declaration
public ScriptableCullingParameters cullingParams { get; }
Property Value
cullingPassId
Index used for culling. It can be shared between multiple passes.
Declaration
public int cullingPassId { get; }
Property Value
enabled
Returns true if the pass contains at least one view.
Declaration
public bool enabled { get; }
Property Value
foveatedRenderingInfo
Native pointer from the XR plugin to be consumed by ConfigureFoveatedRendering.
Declaration
public IntPtr foveatedRenderingInfo { get; }
Property Value
hasValidOcclusionMesh
Returns true if the pass was setup with expected mesh and material.
Declaration
public bool hasValidOcclusionMesh { get; }
Property Value
hdrDisplayOutputColorGamut
Declaration
public ColorGamut hdrDisplayOutputColorGamut { get; }
Property Value
Declaration
public HDROutputUtils.HDRDisplayInformation hdrDisplayOutputInformation { get; }
Property Value
isHDRDisplayOutputActive
Declaration
public bool isHDRDisplayOutputActive { get; }
Property Value
multipassId
Index of the pass inside the frame.
Declaration
public int multipassId { get; }
Property Value
occlusionMeshScale
Scaling factor used when drawing the occlusion mesh.
Declaration
public float occlusionMeshScale { get; }
Property Value
renderTarget
Destination render target.
Declaration
public RenderTargetIdentifier renderTarget { get; }
Property Value
renderTargetDesc
Destination render target descriptor.
Declaration
public RenderTextureDescriptor renderTargetDesc { get; }
Property Value
singlePassEnabled
If true, the render pipeline is expected to use single-pass techniques to save CPU time.
Declaration
public bool singlePassEnabled { get; }
Property Value
supportsFoveatedRendering
Returns true if the pass can use foveated rendering commands.
Declaration
public bool supportsFoveatedRendering { get; }
Property Value
viewCount
Returns the number of views inside this pass.
Declaration
public int viewCount { get; }
Property Value
Methods
ApplyXRViewCenterOffset(Vector2)
Take a point that is center-relative (0.5, 0.5) and modify it to be placed relative to the view's center instead, respecting the asymmetric FOV (if it is used)
Declaration
public Vector4 ApplyXRViewCenterOffset(Vector2 center)
Parameters
| Type |
Name |
Description |
| Vector2 |
center |
|
Returns
CreateDefault(XRPassCreateInfo)
Default allocator method for XRPass.
Declaration
public static XRPass CreateDefault(XRPassCreateInfo createInfo)
Parameters
Returns
GetOcclusionMesh(int)
Returns the occlusion mesh for a given view.
Declaration
public Mesh GetOcclusionMesh(int viewIndex = 0)
Parameters
| Type |
Name |
Description |
| int |
viewIndex |
|
Returns
GetProjMatrix(int)
Returns the projection matrix for a given view.
Declaration
public Matrix4x4 GetProjMatrix(int viewIndex = 0)
Parameters
| Type |
Name |
Description |
| int |
viewIndex |
|
Returns
GetTextureArraySlice(int)
Returns the destination slice index (for texture array) for a given view.
Declaration
public int GetTextureArraySlice(int viewIndex = 0)
Parameters
| Type |
Name |
Description |
| int |
viewIndex |
|
Returns
GetViewMatrix(int)
Returns the view matrix for a given view.
Declaration
public Matrix4x4 GetViewMatrix(int viewIndex = 0)
Parameters
| Type |
Name |
Description |
| int |
viewIndex |
|
Returns
GetViewport(int)
Returns the viewport for a given view.
Declaration
public Rect GetViewport(int viewIndex = 0)
Parameters
| Type |
Name |
Description |
| int |
viewIndex |
|
Returns
InitBase(XRPassCreateInfo)
Initialize the base class fields.
Declaration
public void InitBase(XRPassCreateInfo createInfo)
Parameters
Release()
Default release method. Can be overridden by render pipelines.
Declaration
public virtual void Release()
RenderOcclusionMesh(CommandBuffer, bool)
Generate commands to render the occlusion mesh for this pass.
In single-pass mode : the meshes for all views are combined into one mesh,
where the corresponding view index is encoded into each vertex. The keyword
"XR_OCCLUSION_MESH_COMBINED" is also enabled when rendering the combined mesh.
Declaration
public void RenderOcclusionMesh(CommandBuffer cmd, bool renderIntoTexture = false)
Parameters
| Type |
Name |
Description |
| CommandBuffer |
cmd |
CommandBuffer to modify
|
| bool |
renderIntoTexture |
Set to true when rendering into a render texture. Used for handling Unity yflip.
|
StartSinglePass(CommandBuffer)
Queue up render commands to enable single-pass techniques.
Note: depending on the platform and settings, either single-pass instancing or the multiview extension will be used.
Declaration
public void StartSinglePass(CommandBuffer cmd)
Parameters
StopSinglePass(CommandBuffer)
Queue up render commands to disable single-pass techniques.
Declaration
public void StopSinglePass(CommandBuffer cmd)
Parameters
Extension Methods