Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetTexture

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
Read time 8 minutesLast updated 6 days ago

Definition

GetTexture(string)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(string uri)

Parameters

uri

string
The URI of the image to download.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Use 
UnityWebRequestTexture.GetTexture
to retrieve a Texture file from a remote server. This function is very similar to 
UnityWebRequest.Get
, but is optimized for downloading and storing textures efficiently. It creates a UnityWebRequest and sets the target URL to the one specified as a string or uri object in the 
uri
argument. No other flags or custom headers are set.
This method attaches a DownloadHandlerTexture object to the UnityWebRequest. DownloadHandlerTexture is a specialized DownloadHandler optimized for storing images that are to be used as textures in the Unity Engine. Using this class significantly reduces memory reallocation compared to downloading raw bytes and creating a texture manually in script. In addition, texture conversion is performed on a worker thread.
This method attaches no UploadHandler to the UnityWebRequest.
The texture is created as if it stores color data. Only JPG and PNG formats are supported.
Additional Resources: TextureImporter.sRGBTexture.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{    void Start()    {        StartCoroutine(GetText());    }    IEnumerator GetText()    {        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png"))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    }}

GetTexture(Uri)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(Uri uri)

Parameters

uri

Uri
The URI of the image to download.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Use 
UnityWebRequestTexture.GetTexture
to retrieve a Texture file from a remote server. This function is very similar to 
UnityWebRequest.Get
, but is optimized for downloading and storing textures efficiently. It creates a UnityWebRequest and sets the target URL to the one specified as a string or uri object in the 
uri
argument. No other flags or custom headers are set.
This method attaches a DownloadHandlerTexture object to the UnityWebRequest. DownloadHandlerTexture is a specialized DownloadHandler optimized for storing images that are to be used as textures in the Unity Engine. Using this class significantly reduces memory reallocation compared to downloading raw bytes and creating a texture manually in script. In addition, texture conversion is performed on a worker thread.
This method attaches no UploadHandler to the UnityWebRequest.
The texture is created as if it stores color data. Only JPG and PNG formats are supported.
Additional Resources: TextureImporter.sRGBTexture.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{    void Start()    {        StartCoroutine(GetText());    }    IEnumerator GetText()    {        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png"))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    }}

GetTexture(string, bool)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(string uri, bool nonReadable)

Parameters

uri

string
The URI of the image to download.

nonReadable

bool
If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: 
false
.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Use 
UnityWebRequestTexture.GetTexture
to retrieve a Texture file from a remote server. This function is very similar to 
UnityWebRequest.Get
, but is optimized for downloading and storing textures efficiently. It creates a UnityWebRequest and sets the target URL to the one specified as a string or uri object in the 
uri
argument. No other flags or custom headers are set.
This method attaches a DownloadHandlerTexture object to the UnityWebRequest. DownloadHandlerTexture is a specialized DownloadHandler optimized for storing images that are to be used as textures in the Unity Engine. Using this class significantly reduces memory reallocation compared to downloading raw bytes and creating a texture manually in script. In addition, texture conversion is performed on a worker thread.
This method attaches no UploadHandler to the UnityWebRequest.
The texture is created as if it stores color data. Only JPG and PNG formats are supported.
Additional Resources: TextureImporter.sRGBTexture.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{    void Start()    {        StartCoroutine(GetText());    }    IEnumerator GetText()    {        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png"))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    }}

GetTexture(Uri, bool)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(Uri uri, bool nonReadable)

Parameters

uri

Uri
The URI of the image to download.

nonReadable

bool
If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: 
false
.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Use 
UnityWebRequestTexture.GetTexture
to retrieve a Texture file from a remote server. This function is very similar to 
UnityWebRequest.Get
, but is optimized for downloading and storing textures efficiently. It creates a UnityWebRequest and sets the target URL to the one specified as a string or uri object in the 
uri
argument. No other flags or custom headers are set.
This method attaches a DownloadHandlerTexture object to the UnityWebRequest. DownloadHandlerTexture is a specialized DownloadHandler optimized for storing images that are to be used as textures in the Unity Engine. Using this class significantly reduces memory reallocation compared to downloading raw bytes and creating a texture manually in script. In addition, texture conversion is performed on a worker thread.
This method attaches no UploadHandler to the UnityWebRequest.
The texture is created as if it stores color data. Only JPG and PNG formats are supported.
Additional Resources: TextureImporter.sRGBTexture.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{    void Start()    {        StartCoroutine(GetText());    }    IEnumerator GetText()    {        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png"))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    }}

GetTexture(string, DownloadedTextureParams)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(string uri, DownloadedTextureParams parameters)

Parameters

uri

string
The URI of the image to download.

parameters

DownloadedTextureParams
Parameters specifying various properties of texture that will be created.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Same as an overload with only 
uri
parameter, except that it allows more control over the properties of texture that will be created. For example, using this overload you can disable creation of mipmaps or use linear color space.

Examples

using System.Collections;using UnityEngine;using UnityEngine.Networking;public class NewMonoBehaviourScript : MonoBehaviour{   void Start()   {       StartCoroutine(GetText());   }    IEnumerator GetText()    {        // Use linear color space and reduce memory usage by disabling mipmaps and ability to read pixels        var parameters = DownloadedTextureParams.Default;        parameters.readable = false;        parameters.mipmapChain = false;        parameters.linearColorSpace = true;        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png", parameters))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    } }

GetTexture(Uri, DownloadedTextureParams)

Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.
public static UnityWebRequest GetTexture(Uri uri, DownloadedTextureParams parameters)

Parameters

uri

Uri
The URI of the image to download.

parameters

DownloadedTextureParams
Parameters specifying various properties of texture that will be created.

Returns

Type

Description

UnityWebRequestA UnityWebRequest properly configured to download an image and convert it to a Texture.

Remarks

Same as an overload with only 
uri
parameter, except that it allows more control over the properties of texture that will be created. For example, using this overload you can disable creation of mipmaps or use linear color space.

Examples

using System.Collections;using UnityEngine;using UnityEngine.Networking;public class NewMonoBehaviourScript : MonoBehaviour{   void Start()   {       StartCoroutine(GetText());   }    IEnumerator GetText()    {        // Use linear color space and reduce memory usage by disabling mipmaps and ability to read pixels        var parameters = DownloadedTextureParams.Default;        parameters.readable = false;        parameters.mipmapChain = false;        parameters.linearColorSpace = true;        using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture("https://www.my-server.com/myimage.png", parameters))        {            yield return uwr.SendWebRequest();            if (uwr.result != UnityWebRequest.Result.Success)            {                Debug.Log(uwr.error);            }            else            {                // Get downloaded asset bundle                var texture = DownloadHandlerTexture.GetContent(uwr);            }        }    } }