Version: 2020.1
言語: 日本語

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.
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.

コンストラクタ

CustomRenderTextureCreate a new Custom Render Texture.

Public 関数

ClearUpdateZonesClear all Update Zones.
GetUpdateZonesReturns the list of Update Zones.
InitializeInitializes the Custom Render Texture at the start of the next frame. Unity calls /Initialise()/ before /CustomRenderTexture.Update/.
SetUpdateZonesSetup the list of Update Zones for the Custom Render Texture.
UpdateTriggers an update of the Custom Render Texture.

継承メンバー

Static 変数

active現在アクティブなレンダーテクスチャ
allowThreadedTextureCreationAllow texture creation to occur 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.
desiredTextureMemoryThis amount of texture memory would be used before the texture streaming budget is applied.
GenerateAllMipsCan 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.
nonStreamingTextureCountNumber of non-streaming textures.
nonStreamingTextureMemoryTotal amount of memory being used by non-streaming textures.
streamingMipmapUploadCountHow many times has a texture been uploaded due to texture mipmap streaming.
streamingRendererCountNumber of renderers registered with the texture streaming system.
streamingTextureCountNumber of streaming textures.
streamingTextureDiscardUnusedMipsForce the streaming texture system to discard all unused mipmaps immediately, rather than caching them until the texture memory budget is exceeded.
streamingTextureForceLoadAllForce streaming textures to load all mipmap levels.
streamingTextureLoadingCountNumber of streaming textures with mipmaps currently loading.
streamingTexturePendingLoadCountNumber of streaming textures with outstanding mipmaps to be loaded.
targetTextureMemoryThe amount of memory used by textures after the mipmap streaming and budget are applied and loading is complete.
totalTextureMemoryThe total amount of memory that would be used by all textures at mipmap level 0.

変数

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameオブジェクト名
antiAliasingレンダーテクスチャのアンチエイリアスレベル
autoGenerateMipsMipmap levels are generated automatically when this flag is set.
bindTextureMSIf 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.
colorBufferRenderTexture のカラーバッファ(読み取り専用)
depthThe precision of the render texture's depth buffer in bits (0, 16, 24/32 are supported).
depthBufferRenderTexture の深度/ステンシルバッファ(読み取り専用)
descriptorThis 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レンダーテクスチャの次元 (形式)
enableRandomWriteShader Model 5.0 レベルのシェーダーでこのレンダーテクスチャにランダムアクセス書き込みを有効にします。
graphicsFormatレンダーテクスチャのカラー形式
heightピクセル単位のテクスチャの高さ
memorylessModeThe render texture memoryless mode property.
sRGBDoes this render texture use sRGB read/write conversions? (Read Only).
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.
useDynamicScaleIs the render texture marked to be scaled by the Dynamic Resolution system.
useMipMapRender texture has mipmaps when this flag is set.
volumeDepthVolume extent of a 3D render texture or number of slices of array texture.
vrUsageIf this RenderTexture is a VR eye texture used in stereoscopic rendering, this property decides what special rendering occurs, if any.
widthピクセル単位のテクスチャの幅
anisoLevelテクスチャの異方性フィルタリングのレベル
dimensionテクスチャの次元 (タイプ)。読み取り専用。
filterModeテクスチャのフィルタリングモード
graphicsFormatReturns the GraphicsFormat format or color format of a texture object.
heightピクセル単位でのテクスチャの高さ(読み取り専用)
imageContentsHashThe hash value of the Texture.
isReadableReturns 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.
mipMapBiasThe mipmap bias of the texture.
mipmapCountテクスチャのミップマップレベル(読み取り専用)
updateCountThis counter is incremented when the texture is updated.
widthピクセル単位でのテクスチャの幅(読み取り専用)
wrapModeTexture coordinate wrapping mode.
wrapModeUTexture U coordinate wrapping mode.
wrapModeVTexture V coordinate wrapping mode.
wrapModeWTexture W coordinate wrapping mode for Texture3D.

Public 関数

GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringReturns the name of the object.
ConvertToEquirectConverts 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実際に RenderTexture オブジェクトを作成します
DiscardContentsHint the GPU driver that the contents of the RenderTexture will not be used.
GenerateMipsGenerate mipmap levels of a render texture.
GetNativeDepthBufferPtr深度バッファリソースを指すネイティブ (グラフィックス API に内在する) のポインターを取得します。
IsCreated実際に RenderTexture オブジェクトを生成しているか確認します
MarkRestoreExpectedRenderTexture のリストア処理が期待されることを示します
ReleaseRenderTexture オブジェクトを解放します
ResolveAntiAliasedSurfaceForce an antialiased render texture to be resolved.
SetGlobalShaderPropertyプロパティーネームで RenderTexture オブジェクトにシェーダーを割りあてます
GetNativeTexturePtrテクスチャリソースへのネイティブ (グラフィックス API に内在する) ポインターを取得します。
IncrementUpdateCountIncrement the update counter.

Static 関数

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeGets a list of all loaded objects of Type type.
Instantiateoriginal のオブジェクトをクローンします
GetTemporary一時的なレンダリングテクスチャを割り当てます
ReleaseTemporary GetTemporary 関数で割り当てられた一時的なテクスチャを解放します
SupportsStencilRenderTexture にステンシルバッファがあるかどうか
SetGlobalAnisotropicFilteringLimits異方性のリミットを設定します
SetStreamingTextureMaterialDebugPropertiesUploads additional debug information to materials using textures set to stream mipmaps.

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。