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 failedFor 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 Your name Your email Suggestion* DescriptionClass 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.
Do not assume that the texture will be created and available in Awake. All texture uploads are synchronized on the Main thread at Start. Perform texture operations in Start.
Static Properties Property Description blackTexture Gets a small Texture with all black pixels. grayTexture Gets a small Texture with all gray pixels. linearGrayTexture Gets a small Texture with all gray pixels. normalTexture Gets a small Texture with pixels that represent surface normal vectors at a neutral position. redTexture Gets a small Texture with all red pixels. whiteTexture Gets a small Texture with all white pixels. Properties Property Description activeMipmapLimit The number of high resolution mipmap levels from the texture that Unity doesn't upload to the GPU. (Read Only) alphaIsTransparency Indicates 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. calculatedMipmapLevel The 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. desiredMipmapLevel The mipmap level that the streaming system would load before memory budgets are applied. format The format of the pixel data in the texture (Read Only). ignoreMipmapLimit This property causes a texture to ignore all texture mipmap limit settings. loadedMipmapLevel The mipmap level that is currently loaded by the streaming system. loadingMipmapLevel The mipmap level that the mipmap streaming system is in the process of loading. minimumMipmapLevel Restricts the mipmap streaming system to a minimum mip level for this Texture. mipmapLimitGroup The name of the texture mipmap limit group that this texture is associated with. (Read Only) requestedMipmapLevel The mipmap level to load. streamingMipmaps Determines whether mipmap streaming is enabled for this Texture. streamingMipmapsPriority Sets the relative priority for this Texture when reducing memory size to fit within the memory budget. vtOnly Returns true if the VTOnly checkbox was checked when the texture was imported; otherwise returns false. For additional information, see TextureImporter.vtOnly. Constructors Constructor Description Texture2D Create a new empty texture. Public Methods Method Description Apply Copies changes you've made in a CPU texture to the GPU. ClearMinimumMipmapLevel Resets the minimumMipmapLevel field. ClearRequestedMipmapLevel Resets the requestedMipmapLevel field. Compress Compress texture at runtime to DXT/BCn or ETC formats. CopyPixels Copies pixel data from another texture on the CPU. GetPixel Gets the pixel color at coordinates (x, y). GetPixelBilinear Gets the filtered pixel color at the normalized coordinates (u, v). GetPixelData Gets the raw data from a texture. GetPixels Gets the pixel color data for a mipmap level as Color structs. GetPixels32 Gets the pixel color data for a mipmap level as Color32 structs. GetRawTextureData Gets the raw data from a texture, as an array that points to memory. IsRequestedMipmapLevelLoaded Checks to see whether the mipmap level set by requestedMipmapLevel has finished loading. LoadRawTextureData Sets the raw data of an entire texture in CPU memory. PackTextures Packs multiple Textures into a texture atlas. ReadPixels Reads pixels from the current render target and writes them to a texture. Reinitialize Reinitializes a Texture2D, making it possible for you to replace width, height, textureformat, and graphicsformat data for that texture. SetPixel Sets the pixel color at coordinates (x,y). SetPixelData Sets the raw data of an entire mipmap level directly in CPU memory. SetPixels Sets the pixel colors of an entire mipmap level. SetPixels32 Sets the pixel colors of an entire mipmap level. UpdateExternalTexture Updates Unity texture to use different native texture object. Static Methods Method Description CreateExternalTexture Creates a Unity Texture out of an externally created native texture object. GenerateAtlas Packs a set of rectangles into a square atlas, with optional padding between rectangles. Inherited Members Static Properties Property Description allowThreadedTextureCreation Allow Unity internals to perform Texture creation on any thread (rather than the dedicated render thread). currentTextureMemory The amount of memory that all Textures in the scene use. desiredTextureMemory The 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 Texture.targetTextureMemory value. GenerateAllMips Can 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. nonStreamingTextureCount The 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. nonStreamingTextureMemory The 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. streamingMipmapUploadCount How many times has a Texture been uploaded due to Texture mipmap streaming. streamingRendererCount Number of renderers registered with the Texture streaming system. streamingTextureCount Number of streaming Textures. streamingTextureDiscardUnusedMips This 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. streamingTextureForceLoadAll Force streaming Textures to load all mipmap levels. streamingTextureLoadingCount Number of streaming Textures with mipmaps currently loading. streamingTexturePendingLoadCount Number of streaming Textures with outstanding mipmaps to be loaded. targetTextureMemory The 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. totalTextureMemory The 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 Property Description hideFlags Should the object be hidden, saved with the Scene or modifiable by the user? name The name of the object. anisoLevel Defines the anisotropic filtering level of the Texture. dimension Dimensionality (type) of the Texture (Read Only). filterMode Filtering mode of the Texture. graphicsFormat Returns the GraphicsFormat format or color format of a Texture object. graphicsTexture GraphicsTexture that represents the texture resource uploaded to the graphics device (Read Only). height Height of the Texture in pixels (Read Only). imageContentsHash The hash value of the Texture. isDataSRGB Returns true if the texture pixel data is in sRGB color space (Read Only). isReadable Whether Unity stores an additional copy of this texture's pixel data in CPU-addressable memory. mipMapBias The mipmap bias of the Texture. mipmapCount How many mipmap levels are in this Texture (Read Only). updateCount This counter is incremented when the Texture is updated. width Width of the Texture in pixels (Read Only). wrapMode Texture coordinate wrapping mode. wrapModeU Texture U coordinate wrapping mode. wrapModeV Texture V coordinate wrapping mode. wrapModeW Texture W coordinate wrapping mode for Texture3D. Operators Operator Description bool Does 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.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4