Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

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

Properties

formatThe format of the pixel data in the texture (Read Only).
mipmapCountHow many mipmap levels are in this texture (Read Only).

Constructors

Texture2DCreate a new empty texture.

Public Methods

ApplyActually apply all previous SetPixel and SetPixels changes.
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.
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

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

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: