Version: 2020.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).
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.
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 into DXT format.
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.
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.
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.
ReadPixelsRead pixels from screen into the saved texture data.
ResizeResizes the texture.
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 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

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.

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.
FindObjectsOfTypeGets a list of all 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.

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