class in UnityEngine
/
Inherits from:RenderTexture
/
Implemented in:UnityEngine.CoreModule
Custom Render Textures are an extension to Render Textures, enabling you to render directly to the Texture using a Shader.
Custom Render Textures are an extension to Render Textures allowing you easily to update the texture with a Shader and then use it in a regular Material. This is useful for implementing all kinds of complex simulations, for instance: water caustics, ripple simulations for rain effects, or splatting liquids against a wall. Also provided is a scripting and Shader framework to help with more complicated configurations like partial or multi-pass updates, and varying update frequency.
| cubemapFaceMask | Bitfield that allows to enable or disable update on each of the cubemap faces. Order from least significant bit is +X, -X, +Y, -Y, +Z, -Z. |
| doubleBuffered | If true, the Custom Render Texture is double buffered so that you can access it during its own update. otherwise the Custom Render Texture will be not be double buffered. |
| initializationColor | Color with which the Custom Render Texture is initialized. This parameter will be ignored if an initializationMaterial is set. |
| initializationMaterial | Material with which the Custom Render Texture is initialized. Initialization texture and color are ignored if this parameter is set. |
| initializationMode | Specify how the texture should be initialized. |
| initializationSource | Specify if the texture should be initialized with a Texture and a Color or a Material. |
| initializationTexture | Texture with which the Custom Render Texture is initialized (multiplied by the initialization color). This parameter will be ignored if an initializationMaterial is set. |
| material | Material with which the content of the Custom Render Texture is updated. |
| shaderPass | Shader Pass used to update the Custom Render Texture. |
| updateMode | Specify how the texture should be updated. |
| updatePeriod | Period in seconds at which real-time textures are updated (0.0 will update every frame). |
| updateZoneSpace | Space in which the update zones are expressed (Normalized or Pixel space). |
| wrapUpdateZones | If true, Update zones will wrap around the border of the Custom Render Texture. Otherwise, Update zones will be clamped at the border of the Custom Render Texture. |
| CustomRenderTexture | Create a new Custom Render Texture. |
| ClearUpdateZones | Clear all Update Zones. |
| EnsureDoubleBufferConsistency | Updates the internal RenderTexture that a CustomRenderTexture uses for double buffering, so that it matches the size and format of the CustomRenderRexture. |
| GetDoubleBufferRenderTexture | Gets the RenderTexture that this CustomRenderTexture uses for double buffering. |
| GetUpdateZones | Returns the list of Update Zones. |
| Initialize | Triggers an initialization of the Custom Render Texture. |
| SetUpdateZones | Setup the list of Update Zones for the Custom Render Texture. |
| Update | Triggers the update of the Custom Render Texture. |
| active | Currently active render texture. |
| allowThreadedTextureCreation | Allow Unity internals to perform Texture creation on any thread (rather than the dedicated render thread). |
| currentTextureMemory | The amount of memory that all Textures in the scene use. |
| desiredTextureMemory | The total size of the Textures, in bytes, that Unity loads if there were no other constraints. Before Unity loads any Textures, it applies the memory budget which reduces the loaded Texture resolution if the Texture sizes exceed its value. The `desiredTextureMemory` value takes into account the mipmap levels that Unity has requested or that you have set manually. For example, if Unity does not load a Texture at full resolution because it is far away or its requested mipmap level is greater than 0, Unity reduces the `desiredTextureMemory` value to match the total memory needed.The `desiredTextureMemory` value can be greater than the `targetTextureMemory` value. |
| GenerateAllMips | Can be used with Texture constructors that take a mip count to indicate that all mips should be generated. The value of this field is -1. |
| nonStreamingTextureCount | The number of non-streaming Textures in the scene. This includes instances of Texture2D and CubeMap Textures. This does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally. |
| nonStreamingTextureMemory | The amount of memory Unity allocates for non-streaming Textures in the scene. This only includes instances of Texture2D and CubeMap Textures. This does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally. |
| streamingMipmapUploadCount | How many times has a Texture been uploaded due to Texture mipmap streaming. |
| streamingRendererCount | Number of renderers registered with the Texture streaming system. |
| streamingTextureCount | Number of streaming Textures. |
| streamingTextureDiscardUnusedMips | This property forces the streaming Texture system to discard all unused mipmaps instead of caching them until the Texture memory budget is exceeded. This is useful when you profile or write tests to keep a predictable set of Textures in memory. |
| streamingTextureForceLoadAll | Force streaming Textures to load all mipmap levels. |
| streamingTextureLoadingCount | Number of streaming Textures with mipmaps currently loading. |
| streamingTexturePendingLoadCount | Number of streaming Textures with outstanding mipmaps to be loaded. |
| targetTextureMemory | The total amount of Texture memory that Unity allocates to the Textures in the scene after it applies the memory budget and finishes loading Textures. `targetTextureMemory`also takes mipmap streaming settings into account. This value only includes instances of Texture2D and CubeMap Textures. It does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally. |
| totalTextureMemory | The total amount of Texture memory that Unity would use if it loads all Textures at mipmap level 0. This is a theoretical value that does not take into account any input from the streaming system or any other input, for example when you set the`Texture2D.requestedMipmapLevel` manually. To see a Texture memory value that takes inputs into account, use `desiredTextureMemory`. `totalTextureMemory` only includes instances of Texture2D and CubeMap Textures. It does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally. |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| antiAliasing | The antialiasing level for the RenderTexture. |
| autoGenerateMips | Mipmap levels are generated automatically when this flag is set. |
| bindTextureMS | If true and antiAliasing 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. |
| colorBuffer | Color buffer of the render texture (Read Only). |
| depth | The precision of the render texture's depth buffer in bits (0, 16, 24/32 are supported). |
| depthBuffer | Depth/stencil buffer of the render texture (Read Only). |
| descriptor | 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. |
| dimension | Dimensionality (type) of the render texture. |
| enableRandomWrite | Enable random access write into this render texture on Shader Model 5.0 level shaders. |
| graphicsFormat | The color format of the render texture. |
| height | The height of the render texture in pixels. |
| memorylessMode | The render texture memoryless mode property. |
| sRGB | Does this render texture use sRGB read/write conversions? (Read Only). |
| stencilFormat | The 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. |
| useDynamicScale | Is the render texture marked to be scaled by the Dynamic Resolution system. |
| useMipMap | Render texture has mipmaps when this flag is set. |
| volumeDepth | Volume extent of a 3D render texture or number of slices of array texture. |
| vrUsage | If this RenderTexture is a VR eye texture used in stereoscopic rendering, this property decides what special rendering occurs, if any. |
| width | The width of the render texture in pixels. |
| anisoLevel | Defines the anisotropic filtering level of the Texture. |
| dimension | Dimensionality (type) of the Texture (Read Only). |
| filterMode | Filtering mode of the Texture. |
| graphicsFormat | Returns the GraphicsFormat format or color format of a Texture object. |
| height | Height of the Texture in pixels. (Read Only) |
| imageContentsHash | The hash value of the Texture. |
| isReadable | Returns true if the Read/Write Enabled checkbox was checked when the Texture was imported; otherwise returns false. For a dynamic Texture created from script, always returns true. For additional information, see TextureImporter.isReadable. |
| mipMapBias | The mipmap bias of the Texture. |
| mipmapCount | How many mipmap levels are in this Texture (Read Only). |
| updateCount | This counter is incremented when the Texture is updated. |
| width | Width of the Texture in pixels. (Read Only) |
| wrapMode | Texture coordinate wrapping mode. |
| wrapModeU | Texture U coordinate wrapping mode. |
| wrapModeV | Texture V coordinate wrapping mode. |
| wrapModeW | Texture W coordinate wrapping mode for Texture3D. |
| GetInstanceID | Gets the instance ID of the object. |
| ToString | Returns the name of the object. |
| ConvertToEquirect | Converts the render texture to equirectangular format (both stereoscopic or monoscopic equirect). The left eye will occupy the top half and the right eye will occupy the bottom. The monoscopic version will occupy the whole texture. Texture dimension must be of type TextureDimension.Cube. |
| Create | Actually creates the RenderTexture. |
| DiscardContents | Hint the GPU driver that the contents of the RenderTexture will not be used. |
| GenerateMips | Generate mipmap levels of a render texture. |
| GetNativeDepthBufferPtr | Retrieve a native (underlying graphics API) pointer to the depth buffer resource. |
| IsCreated | Is the render texture actually created? |
| Release | Releases the RenderTexture. |
| ResolveAntiAliasedSurface | Force an antialiased render texture to be resolved. |
| SetGlobalShaderProperty | Assigns this RenderTexture as a global shader property named propertyName. |
| GetNativeTexturePtr | Retrieve a native (underlying graphics API) pointer to the Texture resource. |
| IncrementUpdateCount | Increment the update counter. |
| Destroy | Removes a GameObject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindObjectOfType | Returns the first active loaded object of Type type. |
| FindObjectsOfType | Gets a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| GetTemporary | Allocate a temporary render texture. |
| ReleaseTemporary | Release a temporary texture allocated with GetTemporary. |
| SupportsStencil | Does a RenderTexture have stencil buffer? |
| SetGlobalAnisotropicFilteringLimits | Sets Anisotropic limits. |
| SetStreamingTextureMaterialDebugProperties | This function sets mipmap streaming debug properties on any materials that use this Texture through the mipmap streaming system. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |