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.
CloseFor 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.
Closemat | The Material that contains the Virtual Texture Stack. The Virtual Texture Stacks contained in a Material are declared in the Material's Shader. |
stackNameId | The unique identifier for the name of the Virtual Texture Stack, as declared in the Shader. To find the identifier for a given Shader property name, use Shader.PropertyToID. |
r | The rectangle in 0-1 UV space to make resident. Anything outside the [ 0...1 [ x [ 0...1 [ rectangle will be silently ignored. |
mipMap | The mip level to make resident. Mips are numbered from 0 (= full resolution) to n (= lowest resolution) where n is the mipmap level what is a single tile in size. Requesting invalid mips is silently ignored. |
numMips | The number of mip levels starting from 'mipMap' to make resident. Requesting invalid mips is silently ignored. |
Make a rectangle in UV space resident for a given Virtual Texture Stack.
The system will do it’s best to make this rectangle resident at the requested resolution as fast as possible but due to time and memory constraints this data may take a while to become resident or even never become resident.
This function should be called regularly (preferably every frame) to indicate the continued interest in this data. When this function is no longer called the requested area may be evicted from memory or only be available at a lower resolution. See Streaming.RequestRegion for an example using this function.
The following example requests the 1024 x 1024 pixel mipmap level of a given Virtual Texture Stack.
using UnityEngine;
public class GetStackSizeSample : MonoBehaviour { public Material targetMaterial; public string stackName; private bool m_ShouldRequestRegionForVT = false; const float desiredMipmapLevelPixelSize = 1024f;
private void OnBecameVisible() { m_ShouldRequestRegionForVT = true; }
private void OnBecameInvisible() { m_ShouldRequestRegionForVT = false; }
void Update() { if (m_ShouldRequestRegionForVT) { int stackPropertyId = Shader.PropertyToID(stackName);
// Get size in pixels of the stack. int width, height; UnityEngine.Rendering.VirtualTexturing.Streaming.GetTextureStackSize(targetMaterial, stackPropertyId, out width, out height);
// Calculate the index of the 1024 x 1024 mipmap level. int powerOfTwoExponent_RealSize = (int)Mathf.Max(Mathf.Log(width, 2f), Mathf.Log(height, 2f)); int powerOfTwoExponent_DesiredSize = (int)Mathf.Log(desiredMipmapLevelPixelSize, 2f);
// The difference between the real size and the desired size is the same as the mipmap level we want. // For example, to get a 1024 x 1024 mipmap level from a 4096 x 4096 texture, use mipmap level 2. // If the mipmap level is larger than the texture, fall back to the original texture size at mipmap level 0. int mipmapLevel = Mathf.Max(powerOfTwoExponent_RealSize - powerOfTwoExponent_DesiredSize, 0);
// Request this mipmap level to be made resident. UnityEngine.Rendering.VirtualTexturing.Streaming.RequestRegion(targetMaterial, stackPropertyId, new Rect(0.0f, 0.0f, 1.0f, 1.0f), mipmapLevel, UnityEngine.Rendering.VirtualTexturing.System.AllMips); } } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.