Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

RenderTexture Constructor

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

Switch to Manual
public RenderTexture(int width, int height, int depth, RenderTextureFormat format = RenderTextureFormat.Default, RenderTextureReadWrite readWrite = RenderTextureReadWrite.Default);
public RenderTexture(RenderTexture textureToCopy);
public RenderTexture(RenderTextureDescriptor desc);

Parameters

widthTexture width in pixels.
heightTexture height in pixels.
depthNumber of bits in depth buffer (0, 16 or 24). Note that only 24 bit depth has stencil buffer.
formatTexture color format.
readWriteHow or if color space conversions should be done on texture read/write.
descCreate the RenderTexture with the settings in the RenderTextureDescriptor.
textureToCopyCopy the settings from another RenderTexture.

Description

Creates a new RenderTexture object.

The render texture is created with width by height size, with a depth buffer of depth bits (depth can be 0, 16 or 24), and in format format and with sRGB read / write on or off.

Note that constructing a RenderTexture object does not create the hardware representation immediately. The actual render texture is created upon first use or when Create is called manually. So after constructing the render texture, it is possible to set additional variables, like format, dimension and so on.

See Also: format variable, GetTemporary.

using UnityEngine;

public class Example : MonoBehaviour { public RenderTexture rt;

void Start() { rt = new RenderTexture(256, 256, 16, RenderTextureFormat.ARGB32); } }

Did you find this page useful? Please give it a rating: