RenderTextureDescriptor
This struct contains all the information required to create a RenderTexture. It can be copied, cached, and reused to easily create RenderTextures that all share the same properties. Avoid using the default constructor as it does not initialize some flags with the recommended values.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
public struct RenderTextureDescriptor
Constructors
Constructor | Description |
|---|---|
| RenderTextureDescriptor(System.Int32,System.Int32,UnityEngine.RenderTextureFormat,System.Int32,System.Int32,UnityEngine.RenderTextureReadWrite) | Create a RenderTextureDescriptor with default values, or a certain width, height, and format. |
Properties
Property | Description |
|---|---|
| autoGenerateMips | Mipmap levels are generated automatically when this flag is set. |
| bindMS | If true and RenderTextureDescriptor.msaaSamples is greater than 1, the render texture will not be resolved by default. Use this if the render texture needs to be bound as a multisampled texture in a shader. |
| colorFormat | The format of the RenderTarget is expressed as a RenderTextureFormat. Internally, this format is stored as a GraphicsFormat compatible with the current system (see SystemInfo.GetCompatibleFormat). Therefore, if you set a format and immediately get it again, it may return a different result from the one just set. |
| depthBufferBits | The precision of the render texture's depth buffer in bits (0, 16, 24 and 32 are supported). |
| depthStencilFormat | The desired format of the depth/stencil buffer. |
| dimension | Dimensionality (type) of the render texture. |
| enableRandomWrite | Enable random access write into this render texture on Shader Model 5.0 level shaders. |
| enableShadingRate | Make this render texture usable as a shading rate image. |
| flags | A set of RenderTextureCreationFlags that control how the texture is created. |
| graphicsFormat | The color format for the RenderTexture. You can set this format to None to achieve depth-only rendering. |
| height | The height of the render texture in pixels. |
| memoryless | The render texture memoryless mode property. |
| mipCount | User-defined mipmap count. |
| msaaSamples | The multisample antialiasing level for the RenderTexture. |
| shadowSamplingMode | Determines how the RenderTexture is sampled if it is used as a shadow map. |
| sRGB | This flag causes the render texture uses sRGB read/write conversions. |
| stencilFormat | The format of the stencil data that you can encapsulate within a RenderTexture. |
| useDynamicScale | Set to true to enable dynamic resolution scaling on this render texture. Mutually exclusive with |
| useDynamicScaleExplicit | Set to true to enable dynamic resolution scaling on this render texture and control when this scaling happens. Mutually exclusive with |
| useMipMap | Render texture has mipmaps when this flag is set. |
| volumeDepth | Volume extent of a 3D render texture. |
| vrUsage | If this RenderTexture is a VR eye texture used in stereoscopic rendering, this property decides what special rendering occurs, if any. Instead of setting this manually, use the value returned by eyeTextureDesc or other VR functions returning a RenderTextureDescriptor. |
| width | The width of the render texture in pixels. |