Version: 2018.2 (switch to 2018.1 or 2017.4)
  • C#


class in UnityEngine


Inherits from:Texture


Implemented in:UnityEngine.CoreModule

Suggest a change


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.


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.




Class for texture handling.

Use this to create textures on the fly or to modify existing texture assets.

Static Properties

blackTextureGet a small texture with all black pixels.
whiteTextureGet a small texture with all white pixels.


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.
desiredMipmapLevelThe mipmap level which would have been loaded by the streaming system before memory budgets are applied.
formatThe format of the pixel data in the texture (Read Only).
loadedMipmapLevelWhich mipmap level is currently loaded by the streaming system.
loadingMipmapLevelWhich mipmap level is in the process of being loaded by the mipmap streaming system.
mipmapCountHow many mipmap levels are in this texture (Read Only).
requestedMipmapLevelThe mipmap level to load.
streamingMipmapsHas mipmap streaming been enabled for this texture.
streamingMipmapsPriorityRelative priority for this texture when reducing memory size in order to hit the memory budget.


Texture2DCreate a new empty texture.

Public Methods

ApplyActually apply all previous SetPixel and SetPixels changes.
ClearRequestedMipmapLevelResets the requestedMipmapLevel field.
CompressCompress texture into DXT format.
GetPixelReturns pixel color at coordinates (x, y).
GetPixelBilinearReturns filtered pixel color at normalized coordinates (u, v).
GetPixelsGet the pixel colors from the texture.
GetPixels32Get a block of pixel colors in Color32 format.
GetRawTextureDataGet raw data from a texture for reading or writing.
IsRequestedMipmapLevelLoadedHas the mipmap level requested by setting requestedMipmapLevel finished loading?
LoadRawTextureDataFills texture pixels with raw preformatted data.
PackTexturesPacks multiple Textures into a texture atlas.
ReadPixelsRead pixels from screen into the saved texture data.
ResizeResizes the texture.
SetPixelSets pixel color at coordinates (x,y).
SetPixelsSet a block of pixel colors.
SetPixels32Set a block of pixel colors.
UpdateExternalTextureUpdates Unity texture to use different native texture object.

Static Methods

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

Inherited Members

Static Properties

currentTextureMemoryThe amount of memory currently being used by textures.
desiredTextureMemoryThis amount of texture memory would be used before the texture streaming budget is applied.
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?
nameThe name of the object.
anisoLevelAnisotropic filtering level of the texture.
dimensionDimensionality (type) of the texture (Read Only).
filterModeFiltering mode of the texture.
heightHeight of the texture in pixels. (Read Only)
imageContentsHashThe hash value of the Texture.
mipMapBiasMip map bias of the texture.
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 GameObject.
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.
DontDestroyOnLoadMakes the object target not be destroyed automatically 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.


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.

Did you find this page useful? Please give it a rating: