Version: 2022.1
LanguageEnglish
  • C#

Texture2D

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

Description

Class that represents textures in C# code.

Use this class to create textures, or to modify existing texture assets.

The ImageConversion class provides extension methods to this class that handle image encoding functionality. For details on those methods, see the ImageConversion documentation.

Static Properties

blackTextureGets a small Texture with all black pixels.
grayTextureGets a small Texture with all gray pixels.
linearGrayTextureGets a small Texture with all gray pixels.
normalTextureGets a small Texture with pixels that represent surface normal vectors at a neutral position.
redTextureGets a small Texture with all red pixels.
whiteTextureGets a small Texture with all white pixels.

Properties

alphaIsTransparencyIndicates whether this texture was imported with TextureImporter.alphaIsTransparency enabled. This setting is available only in the Editor scripts. Note that changing this setting will have no effect; it must be enabled in TextureImporter instead.
calculatedMipmapLevelThe mipmap level calculated by the streaming system, which takes into account the streaming Cameras and the location of the objects containing this Texture. This is unaffected by requestedMipmapLevel or minimumMipmapLevel.
desiredMipmapLevelThe mipmap level that the streaming system would load before memory budgets are applied.
formatThe format of the pixel data in the texture (Read Only).
loadedMipmapLevelThe mipmap level that is currently loaded by the streaming system.
loadingMipmapLevelThe mipmap level that the mipmap streaming system is in the process of loading.
minimumMipmapLevelRestricts the mipmap streaming system to a minimum mip level for this Texture.
requestedMipmapLevelThe mipmap level to load.
streamingMipmapsDetermines whether mipmap streaming is enabled for this Texture.
streamingMipmapsPrioritySets the relative priority for this Texture when reducing memory size to fit within the memory budget.
vtOnlyReturns true if the VTOnly checkbox was checked when the texture was imported; otherwise returns false. For additional information, see TextureImporter.vtOnly.

Constructors

Texture2DCreate a new empty texture.

Public Methods

ApplyActually apply all previous SetPixel and SetPixels changes.
ClearMinimumMipmapLevelResets the minimumMipmapLevel field.
ClearRequestedMipmapLevelResets the requestedMipmapLevel field.
CompressCompress texture at runtime to DXT/BCn or ETC formats.
GetPixelReturns pixel color at coordinates (x, y).
GetPixelBilinearReturns filtered pixel color at normalized coordinates (u, v).
GetPixelDataGets raw data from a Texture for reading or writing.
GetPixelsRetrieves a copy of the the pixel color data for a given mip level. The colors are represented by Color structs.
GetPixels32Retrieves a copy of the pixel color data at a given mip level. The colors are represented by lower-precision Color32 structs.
GetRawTextureDataGet raw data from a texture for reading or writing.
IsRequestedMipmapLevelLoadedChecks to see whether the mipmap level set by requestedMipmapLevel has finished loading.
LoadRawTextureDataFills texture pixels with raw preformatted data.
PackTexturesPacks multiple Textures into a texture atlas.
ReadPixelsReads the pixels from the current render target (the screen, or a RenderTexture), and writes them to the texture.
ReinitializeReinitializes a Texture2D, making it possible for you to replace width, height, textureformat, and graphicsformat data for that texture. This action also clears the pixel data associated with the texture from the CPU and GPU. This function is very similar to the Texture constructor, except it works on a Texture object that already exists rather than creating a new one. It is not possible to reinitialize Crunched textures, so if you pass a Crunched texture to this method, it returns false. See texture formats for more information about compressed and crunched textures. Call Apply to upload the changed pixels to the graphics card. Texture.isReadable must be true.
SetPixelSets pixel color at coordinates (x,y).
SetPixelDataSet pixel values from raw preformatted data.
SetPixelsSet a block of pixel colors.
SetPixels32Set a block of pixel colors.
UpdateExternalTextureUpdates Unity texture to use different native texture object.

Static Methods

CreateExternalTextureCreates a Unity Texture out of an externally created native texture object.
GenerateAtlasPacks a set of rectangles into a square atlas, with optional padding between rectangles.

Inherited Members

Static Properties

allowThreadedTextureCreationAllow Unity internals to perform Texture creation on any thread (rather than the dedicated render thread).
currentTextureMemoryThe amount of memory that all Textures in the scene use.
desiredTextureMemoryThe 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.
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.
nonStreamingTextureCountThe 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.
nonStreamingTextureMemoryThe 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.
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.
streamingTextureDiscardUnusedMipsThis 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.
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 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. This value does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.
totalTextureMemoryThe 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. This value does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.
anisoLevelDefines the anisotropic 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.
isReadableWhether Unity stores an additional copy of this texture's pixel data in CPU-addressable memory.
mipMapBiasThe mipmap 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

GetInstanceIDGets 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.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
SetGlobalAnisotropicFilteringLimitsSets Anisotropic limits.
SetStreamingTextureMaterialDebugPropertiesThis function sets mipmap streaming debug properties on any materials that use this Texture through the mipmap streaming system.

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.