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

RenderTextureDescriptor

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

Description

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.

Properties

autoGenerateMipsMipmap levels are generated automatically when this flag is set.
bindMSIf true and 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.
colorFormatThe 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.
depthBufferBitsThe precision of the render texture's depth buffer in bits (0, 16, 24 and 32 are supported).
depthStencilFormatThe desired format of the depth/stencil buffer.
dimensionDimensionality (type) of the render texture.Additional resources: RenderTexture.dimension.
enableRandomWriteEnable random access write into this render texture on Shader Model 5.0 level shaders.Additional resources: RenderTexture.enableRandomWrite.
flagsA set of RenderTextureCreationFlags that control how the texture is created.
graphicsFormatThe color format for the RenderTexture. You can set this format to None to achieve depth-only rendering.
heightThe height of the render texture in pixels.
memorylessThe render texture memoryless mode property.
mipCountUser-defined mipmap count.
msaaSamplesThe multisample antialiasing level for the RenderTexture.Additional resources: RenderTexture.antiAliasing.
shadowSamplingModeDetermines how the RenderTexture is sampled if it is used as a shadow map.Additional resources: ShadowSamplingMode for more details.
sRGBThis flag causes the render texture uses sRGB read/write conversions.
stencilFormatThe format of the stencil data that you can encapsulate within a RenderTexture.Specifying this property creates a stencil element for the RenderTexture and sets its format. This allows for stencil data to be bound as a Texture to all shader types for the platforms that support it. This property does not specify the format of the stencil buffer, which is constrained by the depth buffer format specified in RenderTexture.depth.Currently, most platforms only support R8_UInt (DirectX11, DirectX12), while PS4 also supports R8_UNorm.
useDynamicScaleSet to true to enable dynamic resolution scaling on this render texture. Mutually exclusive with RenderTextureDescriptor.useDynamicScaleExplicitAdditional resources: RenderTexture.useDynamicScale.
useDynamicScaleExplicitSet to true to enable dynamic resolution scaling on this render texture and control when this scaling happens. Mutually exclusive with RenderTextureDescriptor.useDynamicScaleAdditional resources: RenderTexture.useDynamicScaleExplicit.
useMipMapRender texture has mipmaps when this flag is set.Additional resources: RenderTexture.useMipMap.
volumeDepthVolume extent of a 3D render texture.
vrUsageIf 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.
widthThe width of the render texture in pixels.

Constructors

RenderTextureDescriptorCreate a RenderTextureDescriptor with default values, or a certain width, height, and format.