ImageExt.TryOverrideSpriteFromUriAsync Method

Tries to load a sprite asynchronously from an URI and assign it to the overrideSprite property of an Image.

Namespace: UltimateXR.Extensions.Unity.Render
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public static Task<bool> TryOverrideSpriteFromUriAsync(
	this Image self,
	string uri,
	CancellationToken ct = default
)


Parameters

 

self
Type: Image
Target image
uri
Type: System.String
File location. See Read(String, CancellationToken)
ct (Optional)
Type: System.Threading.CancellationToken
Optional cancellation token, to cancel the operation

Return Value

Type: Task(Boolean)
Whether the sprite was correctly load and the Image had its overrideSprite assigned

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Image. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

ImageExt Class
UltimateXR.Extensions.Unity.Render Namespace