Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

DownloadHandlerTexture

class in UnityEngine.Networking

/

Inherits from:Networking.DownloadHandler

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

A DownloadHandler subclass specialized for downloading images for use as Texture objects.

DownloadHandlerTexture stores received data in a pre-allocated Unity Texture object. It is optimized for downloading images from Web servers, and performs image decompression and decoding on a worker thread.

For use cases where you wish to download an image via HTTP and use it as a Texture within Unity, usage of this class is strongly recommended.

Variables

textureReturns the downloaded Texture, or null. (Read Only)

Constructors

DownloadHandlerTextureDefault constructor.

Protected Functions

GetDataCalled by DownloadHandler.data. Returns a copy of the downloaded image data as raw bytes.

Static Functions

GetContentReturns the downloaded Texture, or null.

Inherited members

Variables

dataReturns the raw bytes downloaded from the remote server, or null. (Read Only)
isDoneReturns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only)
textConvenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only)

Public Functions

DisposeSignals that this [DownloadHandler] is no longer being used, and should clean up any resources it is using.

Protected Functions

CompleteContentCallback, invoked when all data has been received from the remote server.
GetProgressCallback, invoked when UnityWebRequest.downloadProgress is accessed.
GetTextCallback, invoked when the text property is accessed.
ReceiveContentLengthCallback, invoked with a Content-Length header is received.
ReceiveDataCallback, invoked as data is received from the remote server.