Version: 2019.3
LanguageEnglish
  • C#

Texture3D

class in UnityEngine

/

Inherits from:Texture

/

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

Switch to Manual

Description

Class for handling 3D Textures, Use this to create 3D texture assets.

3D textures are commonly used as lookup tables by shaders, or to represent volumetric data.

Typically you'd create a 3D texture, fill it up with data (SetPixels or SetPixels32) and call Apply to upload the data to the GPU.

Properties

depthThe depth of the texture (Read Only).
formatThe format of the pixel data in the texture (Read Only).
isReadableReturns true if this 3D texture is Read/Write Enabled; otherwise returns false. For dynamic textures created from script, always returns true.

Constructors

Texture3DCreate a new empty 3D Texture.

Public Methods

ApplyActually apply all previous SetPixels changes.
GetPixelReturns the pixel color that represents one mip level of the 3D texture at coordinates (x,y,z).
GetPixelBilinearReturns the filtered pixel color that represents one mip level of the 3D texture at normalized coordinates (u,v,w).
GetPixelsReturns an array of pixel colors representing one mip level of the 3D texture.
GetPixels32Returns an array of pixel colors representing one mip level of the 3D texture.
SetPixelSets the pixel color that represents one mip level of the 3D texture at coordinates (x,y,z).
SetPixelDataSet pixel values from raw preformatted data.
SetPixelsSets pixel colors of a 3D texture.
SetPixels32Sets pixel colors of a 3D texture.

Inherited Members

Static Properties

allowThreadedTextureCreationAllow texture creation to occur on any thread (rather than the dedicated render thread).
currentTextureMemoryThe amount of memory currently being used by textures.
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.

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.
anisoLevelAnisotropic filtering level of the texture.
dimensionDimensionality (type) of the texture (Read Only).
filterModeFiltering mode of the texture.
graphicsFormatReturns the GraphicsFormat format or color format of a texture object.
heightHeight of the texture in pixels. (Read Only)
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.
mipMapBiasMip map bias of the texture.
mipmapCountHow many mipmap levels are in this texture (Read Only).
updateCountThis counter is incremented when the texture is updated.
widthWidth of the texture in pixels. (Read Only)
wrapModeTexture coordinate wrapping mode.
wrapModeUTexture U coordinate wrapping mode.
wrapModeVTexture V coordinate wrapping mode.
wrapModeWTexture W coordinate wrapping mode for Texture3D.

Public Methods

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the object.
GetNativeTexturePtrRetrieve a native (underlying graphics API) pointer to the texture resource.
IncrementUpdateCountIncrement the update counter.

Static Methods

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.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.
SetGlobalAnisotropicFilteringLimitsSets Anisotropic limits.
SetStreamingTextureMaterialDebugPropertiesUploads additional debug information to materials using textures set to stream mip maps.

Operators

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