Version: 2020.2

CustomRenderTexture

class in UnityEngine

/

继承自:RenderTexture

切换到手册

描述

Custom Render Textures are an extension to Render Textures that allow you to render directly to the Texture using a Shader.

Custom Render Textures are an extension to Render Textures that allow you to update a 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.

变量

cubemapFaceMaskThe bit field that you can use to enable or disable update on each of the cubemap faces. The bit order from least to most significant bit is as follows: +X, -X, +Y, -Y, +Z, -Z.
doubleBufferedWhen this parameter is set to true, Unity double-buffers the Custom Render Texture so that you can access it during its own update.
initializationColorThe color that Unity uses to initialize a Custom Render Texture. Unity ignores this parameter if an initializationMaterial is set.
initializationMaterialThe Material that Unity uses to initialize a Custom Render Texture. Initialization texture and color are ignored if you have set this parameter.
initializationModeDetermine how Unity initializes a texture.
initializationSourceDetermine if Unity initializes the Custom Render Texture with a Texture and a Color or a Material.
initializationTextureThe Texture that Unity uses to initialize a Custom Render Texture, multiplied by the initialization color. Unity ignores this parameter if an initializationMaterial is set.
materialThe Material that Unity uses to initialize the content of a Custom Render Texture.
shaderPassThe Shader Pass Unity uses to update the Custom Render Texture.
updateModeDetermine how Unity updates the Custom Render Texture.
updatePeriodThe period in seconds that Unity updates real-time Custom Render Textures. A value of 0.0 means Unity updates real-time Custom Render Textures every frame.
updateZoneSpaceThe space in which Unity expresses update zones. You can set this to Normalized or Pixel space.
wrapUpdateZonesWhen this parameter is set to true, Unity wraps Update zones around the border of the Custom Render Texture. Otherwise, Unity clamps Update zones at the border of the Custom Render Texture.

构造函数

CustomRenderTexture创建一个新的自定义渲染纹理。

公共函数

ClearUpdateZones清除所有更新区域。
EnsureDoubleBufferConsistencyUpdates the internal Render Texture that a Custom Render Texture uses for double buffering, so that it matches the size and format of the Custom Render Texture.
GetDoubleBufferRenderTextureGets the Render Texture that this Custom Render Texture uses for double buffering.
GetUpdateZones返回更新区域列表。
InitializeInitializes the Custom Render Texture at the start of the next frame. Unity calls /Initialise()/ before /CustomRenderTexture.Update/.
SetUpdateZones为自定义渲染纹理设置更新区域列表。
UpdateTriggers an update of the Custom Render Texture.

继承的成员

静态变量

active当前处于活动状态的渲染纹理。
allowThreadedTextureCreationAllow Unity internals to perform texture creation on any thread (rather than the dedicated render thread).
currentTextureMemoryThe amount of memory currently being used by the non-streaming and mipmap streaming textures combined.
desiredTextureMemory在应用纹理串流预算之前会先使用上述的纹理内存量。
GenerateAllMips可与采用 Mip 数量的纹理构造函数结合使用,以指示应生成所有 Mip。此字段的值为 -1。
nonStreamingTextureCount非串流纹理的数量。
nonStreamingTextureMemory非串流纹理正在使用的内存总量。
streamingMipmapUploadCount由于纹理 Mipmap 串流而导致上传纹理的次数。
streamingRendererCount在纹理串流系统中注册的渲染器数量。
streamingTextureCount串流纹理的数量。
streamingTextureDiscardUnusedMips强制串流纹理系统立即丢弃所有未使用的 Mipmap,而不是缓存这些 Mipmap 直到超出纹理内存预算。
streamingTextureForceLoadAll强制串流纹理加载所有 Mipmap 级别。
streamingTextureLoadingCount当前正在加载 Mipmap 的串流纹理的数量。
streamingTexturePendingLoadCount要加载的未完成 Mipmap 的串流纹理数量。
targetTextureMemory应用 Mipmap 串流和预算并且在加载完成后由纹理使用的内存量。
totalTextureMemoryMipmap 级别 0 的所有纹理将使用的内存总量。

变量

hideFlags该对象应该隐藏、随场景一起保存还是由用户修改?
name对象的名称。
antiAliasingRenderTexture 的抗锯齿级别。
autoGenerateMips如果设置了该标志,则自动生成多级渐进纹理级别。
bindTextureMS如果为 true 且 antiAliasing 大于 1,则默认不解析渲染纹理。如果需要在着色器中将渲染纹理绑定为多重采样纹理,请使用该属性。
colorBuffer渲染纹理的颜色缓冲区(只读)。
depth渲染纹理深度缓冲区的精度(以位为单位,支持 0、16、24/32 位)。
depthBuffer渲染纹理的深度/模板缓冲区(只读)。
descriptor此结构包含创建 RenderTexture 需要的所有信息。可以复制、缓存和重用来轻松创建全部共享相同属性的 RenderTexture。
dimension渲染纹理的维度(类型)。
enableRandomWrite在 Shader Model 5.0 级别着色器上启用随机访问写入该渲染纹理。
graphicsFormat渲染纹理的颜色格式。
height渲染纹理的高度(以像素为单位)。
memorylessMode渲染纹理无记忆模式属性。
sRGB该渲染纹理是否使用 sRGB 读/写转换?(只读)
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.
useDynamicScale渲染纹理是否标记为由动态分辨率系统进行缩放。
useMipMap如果设置该标志,则渲染纹理具有多级渐进纹理。
volumeDepth3D 渲染纹理的体积范围或数组纹理的切片数。
vrUsage如果该 RenderTexture 是在立体渲染中使用的 VR 眼睛纹理,则该属性决定将进行哪些特殊渲染(如果有)。
width渲染纹理的宽度(以像素为单位)。
anisoLevel纹理的各向异性过滤级别。
dimension纹理的维度(类型)(只读)。
filterMode纹理的过滤模式。
graphicsFormat返回纹理对象的 GraphicsFormat 格式或颜色格式。
height纹理的高度(以像素为单位)。(只读)
imageContentsHash纹理的哈希值。
isReadable如果在导入纹理时选中了“Read/Write Enabled”复选框,则返回 true;否则返回 false。对于通过脚本创建的动态纹理,始终返回 true。有关更多信息,请参阅 TextureImporter.isReadable。
mipMapBiasThe mipmap bias of the texture.
mipmapCount该纹理中有多少个多级渐进纹理级别(只读)。
updateCount更新纹理时,此计数器会递增。
width纹理的宽度(以像素为单位)。(只读)
wrapMode纹理坐标换行模式。
wrapModeU纹理 U 坐标换行模式。
wrapModeV纹理 V 坐标换行模式。
wrapModeW Texture3D 的纹理 W 坐标换行模式。

公共函数

GetInstanceID返回对象的实例 ID。
ToString返回对象的名称。
ConvertToEquirect将渲染纹理转换为等距圆柱投影格式(都为立体或单视场等距圆柱投影)。 左眼占据上半部分,右眼占据底部。单视场版本将占据整个纹理。 纹理尺寸必须为 TextureDimension.Cube 类型。
Create实际创建 RenderTexture。
DiscardContents提示 GPU 驱动程序将不使用 RenderTexture 的内容。
GenerateMips生成渲染纹理的多级渐进纹理级别。
GetNativeDepthBufferPtr获取指向该深度缓冲区资源的原生(底层图形 API)指针。
IsCreated是否实际创建了该渲染纹理?
MarkRestoreExpected表示预期将进行 RenderTexture 恢复操作。
Release释放 RenderTexture。
ResolveAntiAliasedSurface强制解析抗锯齿渲染纹理。
SetGlobalShaderProperty将该 RenderTexture 指定为名为 propertyName 的全局着色器属性。
GetNativeTexturePtr获取指向纹理资源的原生(底层图形 API)指针。
IncrementUpdateCount递增更新计数器。

静态函数

Destroy移除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad在加载新的 Scene 时,请勿销毁 Object。
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfTypeGets a list of all loaded objects of Type type.
Instantiate克隆 original 对象并返回克隆对象。
GetTemporary分配临时渲染纹理。
ReleaseTemporary释放使用 GetTemporary 分配的临时纹理。
SupportsStencilRenderTexture 是否具有模板缓冲区?
SetGlobalAnisotropicFilteringLimits设置各向异性限制。
SetStreamingTextureMaterialDebugPropertiesUploads additional debug information to materials using textures set to stream mipmaps.

运算符

bool该对象是否存在?
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用,判断它们是否引用同一个对象。