Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

XRDisplaySubsystem.ScaledTextureHeight

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public int ScaledTextureHeight(RenderTexture renderTexture);

Parameters

renderTexture A scalable XR eye texture.

Returns

int The height after dynamic scaling. If the texture was not created with both the DynamicallyScalable and EyeTexture flags, or dynamic resolution is not enabled, the original height is returned.

Description

Provides the current, scaled height of a render texture.

Render textures created with both the DynamicallyScalable and EyeTexture flags are subject to scaling when dynamic resolution is active. This function returns the effective, scaled height for the current frame.

If you pass in a texture that is not affected by dynamic resolution, this method returns the original height.

The scaled height can be useful when you need to know the exact size of an eye texture when XR dynamic resolution is enabled. For example, you might need the size for post-processing effects in custom shaders that use screen-space texture coordinates, to program custom XR render passes, or to create custom render pipelines.